From 56ced276ec6e7d23c7a13e99eac36c88614a2781 Mon Sep 17 00:00:00 2001 From: marocchino Date: Thu, 21 Jan 2021 07:02:35 +0900 Subject: [PATCH] Update node modules --- node_modules/.bin/which | 1 - .../@actions/{github => core}/LICENSE.md | 2 + node_modules/@actions/core/README.md | 9 +- node_modules/@actions/core/lib/command.d.ts | 10 +- node_modules/@actions/core/lib/command.js | 47 +- node_modules/@actions/core/lib/command.js.map | 2 +- node_modules/@actions/core/lib/core.d.ts | 32 +- node_modules/@actions/core/lib/core.js | 67 +- node_modules/@actions/core/lib/core.js.map | 2 +- .../@actions/core/lib/file-command.d.ts | 1 + .../@actions/core/lib/file-command.js | 29 + .../@actions/core/lib/file-command.js.map | 1 + node_modules/@actions/core/lib/utils.d.ts | 5 + node_modules/@actions/core/lib/utils.js | 19 + node_modules/@actions/core/lib/utils.js.map | 1 + node_modules/@actions/core/package.json | 29 +- node_modules/@actions/github/README.md | 77 +- node_modules/@actions/github/lib/context.d.ts | 7 +- node_modules/@actions/github/lib/context.js | 9 +- .../@actions/github/lib/context.js.map | 2 +- node_modules/@actions/github/lib/github.d.ts | 15 +- node_modules/@actions/github/lib/github.js | 43 +- .../@actions/github/lib/github.js.map | 2 +- .../@actions/github/lib/interfaces.d.ts | 4 + .../@actions/github/lib/internal/utils.d.ts | 6 + .../@actions/github/lib/internal/utils.js | 43 + .../@actions/github/lib/internal/utils.js.map | 1 + node_modules/@actions/github/lib/utils.d.ts | 21 + node_modules/@actions/github/lib/utils.js | 54 + node_modules/@actions/github/lib/utils.js.map | 1 + node_modules/@actions/github/package.json | 50 +- node_modules/@actions/http-client/LICENSE | 21 + node_modules/@actions/http-client/README.md | 79 + node_modules/@actions/http-client/RELEASES.md | 22 + node_modules/@actions/http-client/actions.png | Bin 0 -> 33889 bytes node_modules/@actions/http-client/auth.d.ts | 23 + node_modules/@actions/http-client/auth.js | 58 + node_modules/@actions/http-client/index.d.ts | 124 + node_modules/@actions/http-client/index.js | 535 + .../@actions/http-client/interfaces.d.ts | 49 + .../@actions/http-client/interfaces.js | 2 + .../@actions/http-client/package.json | 70 + node_modules/@actions/http-client/proxy.d.ts | 2 + node_modules/@actions/http-client/proxy.js | 57 + .../{pump => @octokit/auth-token}/LICENSE | 6 +- node_modules/@octokit/auth-token/README.md | 271 + .../@octokit/auth-token/dist-node/index.js | 49 + .../auth-token/dist-node/index.js.map | 1 + .../@octokit/auth-token/dist-src/auth.js | 12 + .../@octokit/auth-token/dist-src/hook.js | 6 + .../@octokit/auth-token/dist-src/index.js | 14 + .../@octokit/auth-token/dist-src/types.js | 0 .../dist-src/with-authorization-prefix.js | 11 + .../@octokit/auth-token/dist-types/auth.d.ts | 2 + .../@octokit/auth-token/dist-types/hook.d.ts | 2 + .../@octokit/auth-token/dist-types/index.d.ts | 7 + .../@octokit/auth-token/dist-types/types.d.ts | 25 + .../dist-types/with-authorization-prefix.d.ts | 6 + .../@octokit/auth-token/dist-web/index.js | 46 + .../@octokit/auth-token/dist-web/index.js.map | 1 + node_modules/@octokit/auth-token/package.json | 80 + .../{end-of-stream => @octokit/core}/LICENSE | 6 +- node_modules/@octokit/core/README.md | 438 + node_modules/@octokit/core/dist-node/index.js | 174 + .../@octokit/core/dist-node/index.js.map | 1 + node_modules/@octokit/core/dist-src/index.js | 124 + node_modules/@octokit/core/dist-src/types.js | 1 + .../@octokit/core/dist-src/version.js | 1 + .../@octokit/core/dist-types/index.d.ts | 40 + .../@octokit/core/dist-types/types.d.ts | 31 + .../@octokit/core/dist-types/version.d.ts | 1 + node_modules/@octokit/core/dist-web/index.js | 129 + .../@octokit/core/dist-web/index.js.map | 1 + node_modules/@octokit/core/package.json | 93 + node_modules/@octokit/endpoint/README.md | 52 +- .../@octokit/endpoint/dist-node/index.js | 29 +- .../@octokit/endpoint/dist-node/index.js.map | 2 +- .../@octokit/endpoint/dist-src/defaults.js | 6 +- .../@octokit/endpoint/dist-src/merge.js | 6 +- .../@octokit/endpoint/dist-src/parse.js | 14 +- .../dist-src/util/add-query-parameters.js | 8 +- .../endpoint/dist-src/util/merge-deep.js | 4 +- .../@octokit/endpoint/dist-src/util/omit.js | 2 +- .../util/remove-undefined-properties.js | 8 + .../endpoint/dist-src/util/url-template.js | 12 +- .../@octokit/endpoint/dist-src/version.js | 2 +- .../endpoint/dist-src/with-defaults.js | 2 +- .../@octokit/endpoint/dist-types/index.d.ts | 2 +- .../util/remove-undefined-properties.d.ts | 1 + .../@octokit/endpoint/dist-types/version.d.ts | 2 +- .../@octokit/endpoint/dist-web/index.js | 64 +- .../@octokit/endpoint/dist-web/index.js.map | 2 +- .../universal-user-agent/LICENSE.md | 7 - .../universal-user-agent/README.md | 25 - .../universal-user-agent/dist-node/index.js | 22 - .../dist-node/index.js.map | 1 - .../universal-user-agent/dist-src/browser.js | 3 - .../universal-user-agent/dist-src/index.js | 1 - .../universal-user-agent/dist-src/node.js | 12 - .../dist-types/index.d.ts | 1 - .../universal-user-agent/dist-types/node.d.ts | 1 - .../universal-user-agent/dist-web/index.js | 6 - .../dist-web/index.js.map | 1 - .../universal-user-agent/package.json | 65 - node_modules/@octokit/endpoint/package.json | 61 +- node_modules/@octokit/graphql/README.md | 390 +- .../@octokit/graphql/dist-node/index.js | 108 + .../@octokit/graphql/dist-node/index.js.map | 1 + .../@octokit/graphql/dist-src/error.js | 15 + .../@octokit/graphql/dist-src/graphql.js | 47 + .../@octokit/graphql/dist-src/index.js | 17 + .../@octokit/graphql/dist-src/types.js | 0 .../@octokit/graphql/dist-src/version.js | 1 + .../graphql/dist-src/with-defaults.js | 12 + .../@octokit/graphql/dist-types/error.d.ts | 9 + .../@octokit/graphql/dist-types/graphql.d.ts | 3 + .../@octokit/graphql/dist-types/index.d.ts | 3 + .../@octokit/graphql/dist-types/types.d.ts | 50 + .../@octokit/graphql/dist-types/version.d.ts | 1 + .../graphql/dist-types/with-defaults.d.ts | 3 + .../@octokit/graphql/dist-web/index.js | 95 + .../@octokit/graphql/dist-web/index.js.map | 1 + node_modules/@octokit/graphql/index.js | 15 - node_modules/@octokit/graphql/lib/error.js | 16 - node_modules/@octokit/graphql/lib/graphql.js | 36 - .../@octokit/graphql/lib/with-defaults.js | 13 - node_modules/@octokit/graphql/package.json | 122 +- .../workflows/release-notification.yml | 18 + .../.github/workflows/release.yml | 21 + .../.github/workflows/update.yml | 82 + .../CODE_OF_CONDUCT.md | 3 +- .../openapi-types/LICENSE} | 6 +- node_modules/@octokit/openapi-types/README.md | 9 + .../openapi-types/cache/openapi-schema.json | 67391 ++++++++++++++++ .../@octokit/openapi-types/generated/types.ts | 28039 +++++++ .../@octokit/openapi-types/package.json | 67 + .../openapi-types/scripts/download.js | 35 + .../openapi-types/scripts/update-package.js | 15 + .../plugin-paginate-rest/LICENSE} | 6 +- .../@octokit/plugin-paginate-rest/README.md | 192 + .../plugin-paginate-rest/dist-node/index.js | 132 + .../dist-node/index.js.map | 1 + .../dist-src/compose-paginate.js | 5 + .../generated/paginating-endpoints.js | 1 + .../plugin-paginate-rest/dist-src/index.js | 16 + .../plugin-paginate-rest/dist-src/iterator.js | 25 + .../normalize-paginated-list-response.js | 40 + .../plugin-paginate-rest/dist-src/paginate.js | 24 + .../plugin-paginate-rest/dist-src/types.js | 1 + .../plugin-paginate-rest/dist-src/version.js | 1 + .../dist-types/compose-paginate.d.ts | 2 + .../generated/paginating-endpoints.d.ts | 1387 + .../dist-types/index.d.ts | 14 + .../dist-types/iterator.d.ts | 13 + .../normalize-paginated-list-response.d.ts | 18 + .../dist-types/paginate.d.ts | 3 + .../dist-types/types.d.ts | 241 + .../dist-types/version.d.ts | 1 + .../plugin-paginate-rest/dist-web/index.js | 111 + .../dist-web/index.js.map | 1 + .../plugin-paginate-rest/package.json | 87 + .../plugin-rest-endpoint-methods/LICENSE} | 6 +- .../plugin-rest-endpoint-methods/README.md | 72 + .../dist-node/index.js | 1134 + .../dist-node/index.js.map | 1 + .../dist-src/endpoints-to-methods.js | 60 + .../dist-src/generated/endpoints.js | 1274 + .../dist-src/generated/method-types.js | 1 + .../parameters-and-response-types.js | 1 + .../dist-src/index.js | 17 + .../dist-src/types.js | 1 + .../dist-src/version.js | 1 + .../dist-types/endpoints-to-methods.d.ts | 4 + .../dist-types/generated/endpoints.d.ts | 3 + .../dist-types/generated/method-types.d.ts | 7093 ++ .../parameters-and-response-types.d.ts | 2459 + .../dist-types/index.d.ts | 17 + .../dist-types/types.d.ts | 16 + .../dist-types/version.d.ts | 1 + .../dist-web/index.js | 1354 + .../dist-web/index.js.map | 1 + .../plugin-rest-endpoint-methods/package.json | 96 + node_modules/@octokit/request-error/README.md | 17 +- .../request-error/dist-node/index.js.map | 2 +- .../@octokit/request-error/dist-src/index.js | 4 +- .../@octokit/request-error/dist-web/index.js | 4 +- .../request-error/dist-web/index.js.map | 2 +- .../@octokit/request-error/package.json | 58 +- node_modules/@octokit/request/README.md | 92 +- .../@octokit/request/dist-node/index.js | 10 +- .../@octokit/request/dist-node/index.js.map | 2 +- .../request/dist-src/fetch-wrapper.js | 26 +- .../@octokit/request/dist-src/index.js | 4 +- .../@octokit/request/dist-src/version.js | 2 +- .../request/dist-src/with-defaults.js | 4 +- .../request/dist-types/fetch-wrapper.d.ts | 2 +- .../@octokit/request/dist-types/index.d.ts | 2 +- .../@octokit/request/dist-types/version.d.ts | 2 +- .../@octokit/request/dist-web/index.js | 36 +- .../@octokit/request/dist-web/index.js.map | 2 +- .../universal-user-agent/LICENSE.md | 7 - .../universal-user-agent/README.md | 25 - .../universal-user-agent/dist-node/index.js | 22 - .../dist-node/index.js.map | 1 - .../universal-user-agent/dist-src/browser.js | 3 - .../universal-user-agent/dist-src/index.js | 1 - .../universal-user-agent/dist-src/node.js | 12 - .../dist-types/browser.d.ts | 1 - .../dist-types/index.d.ts | 1 - .../universal-user-agent/dist-types/node.d.ts | 1 - .../universal-user-agent/dist-web/index.js | 6 - .../dist-web/index.js.map | 1 - .../universal-user-agent/package.json | 65 - node_modules/@octokit/request/package.json | 79 +- node_modules/@octokit/rest/LICENSE | 22 - node_modules/@octokit/rest/README.md | 46 - node_modules/@octokit/rest/index.d.ts | 36064 --------- node_modules/@octokit/rest/index.js | 15 - node_modules/@octokit/rest/lib/constructor.js | 29 - node_modules/@octokit/rest/lib/core.js | 3 - node_modules/@octokit/rest/lib/factory.js | 10 - .../@octokit/rest/lib/parse-client-options.js | 89 - .../@octokit/rest/lib/register-plugin.js | 9 - .../universal-user-agent/LICENSE.md | 7 - .../universal-user-agent/README.md | 25 - .../universal-user-agent/dist-node/index.js | 22 - .../dist-node/index.js.map | 1 - .../universal-user-agent/dist-src/browser.js | 3 - .../universal-user-agent/dist-src/index.js | 1 - .../universal-user-agent/dist-src/node.js | 12 - .../dist-types/browser.d.ts | 1 - .../dist-types/index.d.ts | 1 - .../universal-user-agent/dist-types/node.d.ts | 1 - .../universal-user-agent/dist-web/index.js | 6 - .../dist-web/index.js.map | 1 - .../universal-user-agent/package.json | 65 - node_modules/@octokit/rest/package.json | 173 - .../authentication-deprecated/authenticate.js | 52 - .../before-request.js | 43 - .../authentication-deprecated/index.js | 31 - .../request-error.js | 55 - .../plugins/authentication/before-request.js | 65 - .../rest/plugins/authentication/index.js | 21 - .../plugins/authentication/request-error.js | 61 - .../rest/plugins/authentication/validate.js | 21 - .../with-authorization-prefix.js | 23 - .../@octokit/rest/plugins/log/index.js | 28 - .../@octokit/rest/plugins/pagination/index.js | 9 - .../rest/plugins/pagination/iterator.js | 34 - .../normalize-paginated-list-response.js | 116 - .../rest/plugins/pagination/paginate.js | 40 - .../rest/plugins/register-endpoints/index.js | 7 - .../register-endpoints/register-endpoints.js | 98 - .../rest/plugins/rest-api-endpoints/index.js | 13 - .../plugins/rest-api-endpoints/routes.json | 5927 -- .../@octokit/rest/plugins/validate/index.js | 7 - .../rest/plugins/validate/validate.js | 151 - .../types/.github/ISSUE_TEMPLATE/01_help.md | 5 - .../types/.github/ISSUE_TEMPLATE/02_bug.md | 19 - .../ISSUE_TEMPLATE/03_feature_request.md | 19 - .../types/.github/ISSUE_TEMPLATE/04_thanks.md | 19 - .../types/.github/workflows/release.yml | 28 - .../types/.github/workflows/routes-update.yml | 39 - .../@octokit/types/.github/workflows/test.yml | 19 - node_modules/@octokit/types/CONTRIBUTING.md | 59 - node_modules/@octokit/types/README.md | 49 +- .../@octokit/types/dist-node/index.js | 8 + .../@octokit/types/dist-node/index.js.map | 1 + .../@octokit/types/dist-src/AuthInterface.js | 1 + .../types/dist-src/EndpointDefaults.js | 1 + .../types/dist-src/EndpointInterface.js | 1 + .../types/dist-src/EndpointOptions.js | 1 + node_modules/@octokit/types/dist-src/Fetch.js | 1 + .../GetResponseTypeFromEndpointMethod.js | 1 + .../types/dist-src/OctokitResponse.js | 1 + .../@octokit/types/dist-src/RequestError.js | 1 + .../@octokit/types/dist-src/RequestHeaders.js | 1 + .../types/dist-src/RequestInterface.js | 1 + .../@octokit/types/dist-src/RequestMethod.js | 1 + .../@octokit/types/dist-src/RequestOptions.js | 1 + .../types/dist-src/RequestParameters.js | 1 + .../types/dist-src/RequestRequestOptions.js | 1 + .../types/dist-src/ResponseHeaders.js | 1 + node_modules/@octokit/types/dist-src/Route.js | 1 + .../@octokit/types/dist-src/Signal.js | 1 + .../types/dist-src/StrategyInterface.js | 1 + node_modules/@octokit/types/dist-src/Url.js | 1 + .../@octokit/types/dist-src/VERSION.js | 1 + .../types/dist-src/generated/Endpoints.js | 1 + .../types/{src/index.ts => dist-src/index.js} | 3 + .../types/dist-types/AuthInterface.d.ts | 31 + .../EndpointDefaults.d.ts} | 25 +- .../types/dist-types/EndpointInterface.d.ts | 65 + .../EndpointOptions.d.ts} | 7 +- .../{src/Fetch.ts => dist-types/Fetch.d.ts} | 2 +- .../GetResponseTypeFromEndpointMethod.d.ts | 5 + .../types/dist-types/OctokitResponse.d.ts | 17 + .../types/dist-types/RequestError.d.ts | 11 + .../types/dist-types/RequestHeaders.d.ts | 15 + .../types/dist-types/RequestInterface.d.ts | 34 + .../types/dist-types/RequestMethod.d.ts | 4 + .../RequestOptions.d.ts} | 13 +- .../types/dist-types/RequestParameters.d.ts | 45 + .../dist-types/RequestRequestOptions.d.ts | 26 + .../types/dist-types/ResponseHeaders.d.ts | 20 + .../@octokit/types/dist-types/Route.d.ts | 4 + .../{src/Signal.ts => dist-types/Signal.d.ts} | 2 +- .../types/dist-types/StrategyInterface.d.ts | 4 + .../@octokit/types/dist-types/Url.d.ts | 4 + .../@octokit/types/dist-types/VERSION.d.ts | 1 + .../types/dist-types/generated/Endpoints.d.ts | 3006 + .../@octokit/types/dist-types/index.d.ts | 21 + node_modules/@octokit/types/dist-web/index.js | 4 + .../@octokit/types/dist-web/index.js.map | 1 + node_modules/@octokit/types/package.json | 100 +- .../scripts/update-endpoints/fetch-json.js | 46 - .../update-endpoints/generated/README.md | 3 - .../update-endpoints/generated/endpoints.json | 25258 ------ .../templates/endpoints.ts.template | 33 - .../scripts/update-endpoints/typescript.js | 179 - .../@octokit/types/src/AuthInterface.ts | 43 - .../@octokit/types/src/EndpointInterface.ts | 74 - .../@octokit/types/src/OctokitResponse.ts | 18 - .../@octokit/types/src/RequestHeaders.ts | 15 - .../@octokit/types/src/RequestInterface.ts | 34 - .../@octokit/types/src/RequestMethod.ts | 10 - .../@octokit/types/src/RequestParameters.ts | 46 - .../types/src/RequestRequestOptions.ts | 27 - .../@octokit/types/src/ResponseHeaders.ts | 21 - node_modules/@octokit/types/src/Route.ts | 4 - .../@octokit/types/src/StrategyInterface.ts | 9 - node_modules/@octokit/types/src/Url.ts | 4 - node_modules/@octokit/types/src/VERSION.ts | 1 - .../@octokit/types/src/generated/Endpoints.ts | 14190 ---- .../@octokit/types/src/generated/README.md | 3 - node_modules/@types/node/LICENSE | 42 +- node_modules/@types/node/README.md | 6 +- node_modules/@types/node/assert.d.ts | 114 +- node_modules/@types/node/async_hooks.d.ts | 96 +- node_modules/@types/node/base.d.ts | 58 +- node_modules/@types/node/buffer.d.ts | 2 +- node_modules/@types/node/child_process.d.ts | 177 +- node_modules/@types/node/cluster.d.ts | 20 +- node_modules/@types/node/console.d.ts | 130 + node_modules/@types/node/constants.d.ts | 450 +- node_modules/@types/node/crypto.d.ts | 810 +- node_modules/@types/node/dgram.d.ts | 29 +- node_modules/@types/node/dns.d.ts | 14 +- node_modules/@types/node/domain.d.ts | 26 +- node_modules/@types/node/events.d.ts | 89 +- node_modules/@types/node/fs.d.ts | 1359 +- node_modules/@types/node/fs/promises.d.ts | 555 + node_modules/@types/node/globals.d.ts | 801 +- node_modules/@types/node/globals.global.d.ts | 1 + node_modules/@types/node/http.d.ts | 111 +- node_modules/@types/node/http2.d.ts | 16 +- node_modules/@types/node/https.d.ts | 18 +- node_modules/@types/node/index.d.ts | 77 +- node_modules/@types/node/inspector.d.ts | 7 + node_modules/@types/node/module.d.ts | 51 +- node_modules/@types/node/net.d.ts | 13 +- node_modules/@types/node/os.d.ts | 358 +- node_modules/@types/node/package.json | 87 +- node_modules/@types/node/path.d.ts | 298 +- node_modules/@types/node/perf_hooks.d.ts | 135 +- node_modules/@types/node/process.d.ts | 393 + node_modules/@types/node/punycode.d.ts | 58 +- node_modules/@types/node/querystring.d.ts | 5 +- node_modules/@types/node/readline.d.ts | 21 + node_modules/@types/node/repl.d.ts | 23 +- node_modules/@types/node/stream.d.ts | 111 +- node_modules/@types/node/string_decoder.d.ts | 2 +- node_modules/@types/node/tls.d.ts | 387 +- node_modules/@types/node/ts3.2/fs.d.ts | 33 - node_modules/@types/node/ts3.2/globals.d.ts | 19 - node_modules/@types/node/ts3.2/util.d.ts | 15 - node_modules/@types/node/ts3.4/assert.d.ts | 98 + node_modules/@types/node/ts3.4/base.d.ts | 56 + .../@types/node/ts3.4/globals.global.d.ts | 1 + node_modules/@types/node/ts3.4/index.d.ts | 8 + .../{ts3.2/index.d.ts => ts3.6/base.d.ts} | 17 +- node_modules/@types/node/ts3.6/index.d.ts | 7 + node_modules/@types/node/tty.d.ts | 2 +- node_modules/@types/node/url.d.ts | 9 +- node_modules/@types/node/util.d.ts | 73 +- node_modules/@types/node/v8.d.ts | 10 - node_modules/@types/node/vm.d.ts | 44 +- node_modules/@types/node/wasi.d.ts | 86 + node_modules/@types/node/worker_threads.d.ts | 131 +- node_modules/@types/node/zlib.d.ts | 259 +- node_modules/atob-lite/.npmignore | 6 - node_modules/atob-lite/LICENSE.md | 18 - node_modules/atob-lite/README.md | 37 - node_modules/atob-lite/atob-browser.js | 3 - node_modules/atob-lite/atob-node.js | 3 - node_modules/atob-lite/package.json | 67 - node_modules/before-after-hook/package.json | 25 +- node_modules/btoa-lite/.npmignore | 6 - node_modules/btoa-lite/LICENSE.md | 18 - node_modules/btoa-lite/README.md | 37 - node_modules/btoa-lite/btoa-browser.js | 3 - node_modules/btoa-lite/btoa-node.js | 3 - node_modules/btoa-lite/package.json | 66 - node_modules/cross-spawn/CHANGELOG.md | 100 - node_modules/cross-spawn/LICENSE | 21 - node_modules/cross-spawn/README.md | 94 - node_modules/cross-spawn/index.js | 39 - node_modules/cross-spawn/lib/enoent.js | 59 - node_modules/cross-spawn/lib/parse.js | 125 - node_modules/cross-spawn/lib/util/escape.js | 45 - .../cross-spawn/lib/util/readShebang.js | 32 - .../cross-spawn/lib/util/resolveCommand.js | 47 - .../cross-spawn/node_modules/.bin/semver | 1 - .../node_modules/semver/CHANGELOG.md | 39 - .../cross-spawn/node_modules/semver/LICENSE | 15 - .../cross-spawn/node_modules/semver/README.md | 411 - .../node_modules/semver/bin/semver | 160 - .../node_modules/semver/package.json | 64 - .../cross-spawn/node_modules/semver/range.bnf | 16 - .../cross-spawn/node_modules/semver/semver.js | 1483 - node_modules/cross-spawn/package.json | 111 - node_modules/deprecation/package.json | 27 +- node_modules/end-of-stream/README.md | 52 - node_modules/end-of-stream/index.js | 87 - node_modules/end-of-stream/package.json | 66 - node_modules/execa/index.js | 361 - node_modules/execa/lib/errname.js | 39 - node_modules/execa/lib/stdio.js | 41 - node_modules/execa/package.json | 107 - node_modules/execa/readme.md | 327 - node_modules/get-stream/buffer-stream.js | 51 - node_modules/get-stream/index.js | 50 - node_modules/get-stream/package.json | 82 - node_modules/get-stream/readme.md | 123 - node_modules/is-plain-object/README.md | 18 +- .../is-plain-object/dist/is-plain-object.js | 38 + .../{index.js => dist/is-plain-object.mjs} | 19 +- node_modules/is-plain-object/index.cjs.js | 48 - node_modules/is-plain-object/index.d.ts | 3 - .../is-plain-object/is-plain-object.d.ts | 1 + node_modules/is-plain-object/package.json | 63 +- node_modules/is-stream/index.js | 21 - node_modules/is-stream/license | 21 - node_modules/is-stream/package.json | 74 - node_modules/is-stream/readme.md | 42 - node_modules/isexe/.npmignore | 2 - node_modules/isexe/LICENSE | 15 - node_modules/isexe/README.md | 51 - node_modules/isexe/index.js | 57 - node_modules/isexe/mode.js | 41 - node_modules/isexe/package.json | 64 - node_modules/isexe/test/basic.js | 221 - node_modules/isexe/windows.js | 42 - node_modules/isobject/LICENSE | 21 - node_modules/isobject/README.md | 127 - node_modules/isobject/index.cjs.js | 14 - node_modules/isobject/index.d.ts | 3 - node_modules/isobject/index.js | 10 - node_modules/isobject/package.json | 125 - node_modules/lodash.get/LICENSE | 47 - node_modules/lodash.get/README.md | 18 - node_modules/lodash.get/index.js | 931 - node_modules/lodash.get/package.json | 69 - node_modules/lodash.set/LICENSE | 47 - node_modules/lodash.set/README.md | 18 - node_modules/lodash.set/index.js | 990 - node_modules/lodash.set/package.json | 69 - node_modules/lodash.uniq/LICENSE | 47 - node_modules/lodash.uniq/README.md | 18 - node_modules/lodash.uniq/index.js | 896 - node_modules/lodash.uniq/package.json | 69 - node_modules/macos-release/index.d.ts | 36 - node_modules/macos-release/index.js | 32 - node_modules/macos-release/license | 9 - node_modules/macos-release/package.json | 71 - node_modules/macos-release/readme.md | 57 - node_modules/nice-try/CHANGELOG.md | 21 - node_modules/nice-try/README.md | 32 - node_modules/nice-try/package.json | 65 - node_modules/nice-try/src/index.js | 12 - node_modules/node-fetch/CHANGELOG.md | 6 + node_modules/node-fetch/README.md | 53 +- node_modules/node-fetch/browser.js | 4 +- node_modules/node-fetch/lib/index.es.js | 11 +- node_modules/node-fetch/lib/index.js | 11 +- node_modules/node-fetch/lib/index.mjs | 11 +- node_modules/node-fetch/package.json | 31 +- node_modules/npm-run-path/index.js | 39 - node_modules/npm-run-path/license | 21 - node_modules/npm-run-path/package.json | 81 - node_modules/npm-run-path/readme.md | 81 - .../octokit-pagination-methods/.travis.yml | 36 - .../CODE_OF_CONDUCT.md | 46 - .../octokit-pagination-methods/LICENSE | 22 - .../octokit-pagination-methods/README.md | 42 - .../octokit-pagination-methods/index.js | 12 - .../lib/deprecate.js | 12 - .../lib/get-first-page.js | 7 - .../lib/get-last-page.js | 7 - .../lib/get-next-page.js | 7 - .../lib/get-page-links.js | 15 - .../lib/get-page.js | 38 - .../lib/get-previous-page.js | 7 - .../lib/has-first-page.js | 9 - .../lib/has-last-page.js | 9 - .../lib/has-next-page.js | 9 - .../lib/has-previous-page.js | 9 - .../lib/http-error.js | 15 - .../octokit-pagination-methods/package.json | 76 - .../octokit-pagination-methods/test.js | 93 - node_modules/once/package.json | 11 +- node_modules/os-name/index.d.ts | 37 - node_modules/os-name/index.js | 46 - node_modules/os-name/package.json | 80 - node_modules/os-name/readme.md | 64 - node_modules/p-finally/index.js | 15 - node_modules/p-finally/license | 21 - node_modules/p-finally/package.json | 78 - node_modules/p-finally/readme.md | 47 - node_modules/path-key/index.js | 13 - node_modules/path-key/license | 21 - node_modules/path-key/package.json | 76 - node_modules/path-key/readme.md | 51 - node_modules/pump/.travis.yml | 5 - node_modules/pump/README.md | 65 - node_modules/pump/index.js | 82 - node_modules/pump/package.json | 63 - node_modules/pump/test-browser.js | 66 - node_modules/pump/test-node.js | 53 - node_modules/shebang-command/index.js | 19 - node_modules/shebang-command/license | 21 - node_modules/shebang-command/package.json | 75 - node_modules/shebang-command/readme.md | 39 - node_modules/shebang-regex/index.js | 2 - node_modules/shebang-regex/license | 21 - node_modules/shebang-regex/package.json | 68 - node_modules/shebang-regex/readme.md | 29 - node_modules/signal-exit/CHANGELOG.md | 27 - node_modules/signal-exit/LICENSE.txt | 16 - node_modules/signal-exit/README.md | 40 - node_modules/signal-exit/index.js | 157 - node_modules/signal-exit/package.json | 71 - node_modules/signal-exit/signals.js | 53 - node_modules/strip-eof/index.js | 15 - node_modules/strip-eof/license | 21 - node_modules/strip-eof/package.json | 75 - node_modules/strip-eof/readme.md | 28 - node_modules/tunnel/.idea/encodings.xml | 6 + node_modules/tunnel/.idea/modules.xml | 8 + node_modules/tunnel/.idea/node-tunnel.iml | 12 + node_modules/tunnel/.idea/vcs.xml | 6 + node_modules/tunnel/.idea/workspace.xml | 797 + node_modules/tunnel/.travis.yml | 6 + node_modules/tunnel/CHANGELOG.md | 22 + node_modules/{nice-try => tunnel}/LICENSE | 2 +- node_modules/tunnel/README.md | 185 + node_modules/tunnel/index.js | 1 + node_modules/tunnel/lib/tunnel.js | 264 + node_modules/tunnel/package.json | 67 + node_modules/universal-user-agent/.travis.yml | 38 - node_modules/universal-user-agent/README.md | 8 +- node_modules/universal-user-agent/browser.js | 6 - .../universal-user-agent/cypress.json | 4 - .../universal-user-agent/dist-node/index.js | 18 + .../dist-node/index.js.map | 1 + .../universal-user-agent/dist-src/index.js | 9 + .../dist-types/index.d.ts} | 0 .../universal-user-agent/dist-web/index.js | 12 + .../dist-web/index.js.map | 1 + node_modules/universal-user-agent/index.d.ts | 1 - node_modules/universal-user-agent/index.js | 15 - .../universal-user-agent/package.json | 97 +- .../universal-user-agent/test/smoke-test.js | 57 - node_modules/which/CHANGELOG.md | 152 - node_modules/which/LICENSE | 15 - node_modules/which/README.md | 51 - node_modules/which/bin/which | 52 - node_modules/which/package.json | 70 - node_modules/which/which.js | 135 - node_modules/windows-release/index.d.ts | 30 - node_modules/windows-release/index.js | 44 - node_modules/windows-release/license | 9 - node_modules/windows-release/package.json | 75 - node_modules/windows-release/readme.md | 56 - node_modules/wrappy/package.json | 6 +- 585 files changed, 125490 insertions(+), 100312 deletions(-) delete mode 120000 node_modules/.bin/which rename node_modules/@actions/{github => core}/LICENSE.md (97%) create mode 100644 node_modules/@actions/core/lib/file-command.d.ts create mode 100644 node_modules/@actions/core/lib/file-command.js create mode 100644 node_modules/@actions/core/lib/file-command.js.map create mode 100644 node_modules/@actions/core/lib/utils.d.ts create mode 100644 node_modules/@actions/core/lib/utils.js create mode 100644 node_modules/@actions/core/lib/utils.js.map create mode 100644 node_modules/@actions/github/lib/internal/utils.d.ts create mode 100644 node_modules/@actions/github/lib/internal/utils.js create mode 100644 node_modules/@actions/github/lib/internal/utils.js.map create mode 100644 node_modules/@actions/github/lib/utils.d.ts create mode 100644 node_modules/@actions/github/lib/utils.js create mode 100644 node_modules/@actions/github/lib/utils.js.map create mode 100644 node_modules/@actions/http-client/LICENSE create mode 100644 node_modules/@actions/http-client/README.md create mode 100644 node_modules/@actions/http-client/RELEASES.md create mode 100644 node_modules/@actions/http-client/actions.png create mode 100644 node_modules/@actions/http-client/auth.d.ts create mode 100644 node_modules/@actions/http-client/auth.js create mode 100644 node_modules/@actions/http-client/index.d.ts create mode 100644 node_modules/@actions/http-client/index.js create mode 100644 node_modules/@actions/http-client/interfaces.d.ts create mode 100644 node_modules/@actions/http-client/interfaces.js create mode 100644 node_modules/@actions/http-client/package.json create mode 100644 node_modules/@actions/http-client/proxy.d.ts create mode 100644 node_modules/@actions/http-client/proxy.js rename node_modules/{pump => @octokit/auth-token}/LICENSE (93%) create mode 100644 node_modules/@octokit/auth-token/README.md create mode 100644 node_modules/@octokit/auth-token/dist-node/index.js create mode 100644 node_modules/@octokit/auth-token/dist-node/index.js.map create mode 100644 node_modules/@octokit/auth-token/dist-src/auth.js create mode 100644 node_modules/@octokit/auth-token/dist-src/hook.js create mode 100644 node_modules/@octokit/auth-token/dist-src/index.js create mode 100644 node_modules/@octokit/auth-token/dist-src/types.js create mode 100644 node_modules/@octokit/auth-token/dist-src/with-authorization-prefix.js create mode 100644 node_modules/@octokit/auth-token/dist-types/auth.d.ts create mode 100644 node_modules/@octokit/auth-token/dist-types/hook.d.ts create mode 100644 node_modules/@octokit/auth-token/dist-types/index.d.ts create mode 100644 node_modules/@octokit/auth-token/dist-types/types.d.ts create mode 100644 node_modules/@octokit/auth-token/dist-types/with-authorization-prefix.d.ts create mode 100644 node_modules/@octokit/auth-token/dist-web/index.js create mode 100644 node_modules/@octokit/auth-token/dist-web/index.js.map create mode 100644 node_modules/@octokit/auth-token/package.json rename node_modules/{end-of-stream => @octokit/core}/LICENSE (93%) create mode 100644 node_modules/@octokit/core/README.md create mode 100644 node_modules/@octokit/core/dist-node/index.js create mode 100644 node_modules/@octokit/core/dist-node/index.js.map create mode 100644 node_modules/@octokit/core/dist-src/index.js create mode 100644 node_modules/@octokit/core/dist-src/types.js create mode 100644 node_modules/@octokit/core/dist-src/version.js create mode 100644 node_modules/@octokit/core/dist-types/index.d.ts create mode 100644 node_modules/@octokit/core/dist-types/types.d.ts create mode 100644 node_modules/@octokit/core/dist-types/version.d.ts create mode 100644 node_modules/@octokit/core/dist-web/index.js create mode 100644 node_modules/@octokit/core/dist-web/index.js.map create mode 100644 node_modules/@octokit/core/package.json create mode 100644 node_modules/@octokit/endpoint/dist-src/util/remove-undefined-properties.js create mode 100644 node_modules/@octokit/endpoint/dist-types/util/remove-undefined-properties.d.ts delete mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/LICENSE.md delete mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/README.md delete mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js delete mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map delete mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js delete mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/index.js delete mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js delete mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/index.d.ts delete mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/node.d.ts delete mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js delete mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map delete mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json create mode 100644 node_modules/@octokit/graphql/dist-node/index.js create mode 100644 node_modules/@octokit/graphql/dist-node/index.js.map create mode 100644 node_modules/@octokit/graphql/dist-src/error.js create mode 100644 node_modules/@octokit/graphql/dist-src/graphql.js create mode 100644 node_modules/@octokit/graphql/dist-src/index.js create mode 100644 node_modules/@octokit/graphql/dist-src/types.js create mode 100644 node_modules/@octokit/graphql/dist-src/version.js create mode 100644 node_modules/@octokit/graphql/dist-src/with-defaults.js create mode 100644 node_modules/@octokit/graphql/dist-types/error.d.ts create mode 100644 node_modules/@octokit/graphql/dist-types/graphql.d.ts create mode 100644 node_modules/@octokit/graphql/dist-types/index.d.ts create mode 100644 node_modules/@octokit/graphql/dist-types/types.d.ts create mode 100644 node_modules/@octokit/graphql/dist-types/version.d.ts create mode 100644 node_modules/@octokit/graphql/dist-types/with-defaults.d.ts create mode 100644 node_modules/@octokit/graphql/dist-web/index.js create mode 100644 node_modules/@octokit/graphql/dist-web/index.js.map delete mode 100644 node_modules/@octokit/graphql/index.js delete mode 100644 node_modules/@octokit/graphql/lib/error.js delete mode 100644 node_modules/@octokit/graphql/lib/graphql.js delete mode 100644 node_modules/@octokit/graphql/lib/with-defaults.js create mode 100644 node_modules/@octokit/openapi-types/.github/workflows/release-notification.yml create mode 100644 node_modules/@octokit/openapi-types/.github/workflows/release.yml create mode 100644 node_modules/@octokit/openapi-types/.github/workflows/update.yml rename node_modules/@octokit/{types => openapi-types}/CODE_OF_CONDUCT.md (97%) rename node_modules/{execa/license => @octokit/openapi-types/LICENSE} (91%) create mode 100644 node_modules/@octokit/openapi-types/README.md create mode 100644 node_modules/@octokit/openapi-types/cache/openapi-schema.json create mode 100644 node_modules/@octokit/openapi-types/generated/types.ts create mode 100644 node_modules/@octokit/openapi-types/package.json create mode 100644 node_modules/@octokit/openapi-types/scripts/download.js create mode 100644 node_modules/@octokit/openapi-types/scripts/update-package.js rename node_modules/{get-stream/license => @octokit/plugin-paginate-rest/LICENSE} (80%) create mode 100644 node_modules/@octokit/plugin-paginate-rest/README.md create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-node/index.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/index.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/types.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/version.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/version.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-web/index.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-web/index.js.map create mode 100644 node_modules/@octokit/plugin-paginate-rest/package.json rename node_modules/{os-name/license => @octokit/plugin-rest-endpoint-methods/LICENSE} (80%) create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/README.md create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js.map create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/endpoints-to-methods.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/endpoints.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/method-types.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/parameters-and-response-types.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/index.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/types.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/version.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/endpoints-to-methods.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/endpoints.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/index.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/types.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/version.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js.map create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/package.json delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/LICENSE.md delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/README.md delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js.map delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/browser.js delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/index.js delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/node.js delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/browser.d.ts delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/index.d.ts delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/node.d.ts delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js.map delete mode 100644 node_modules/@octokit/request/node_modules/universal-user-agent/package.json delete mode 100644 node_modules/@octokit/rest/LICENSE delete mode 100644 node_modules/@octokit/rest/README.md delete mode 100644 node_modules/@octokit/rest/index.d.ts delete mode 100644 node_modules/@octokit/rest/index.js delete mode 100644 node_modules/@octokit/rest/lib/constructor.js delete mode 100644 node_modules/@octokit/rest/lib/core.js delete mode 100644 node_modules/@octokit/rest/lib/factory.js delete mode 100644 node_modules/@octokit/rest/lib/parse-client-options.js delete mode 100644 node_modules/@octokit/rest/lib/register-plugin.js delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/LICENSE.md delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/README.md delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js.map delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/browser.js delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/index.js delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/node.js delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/browser.d.ts delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/index.d.ts delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/node.d.ts delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js.map delete mode 100644 node_modules/@octokit/rest/node_modules/universal-user-agent/package.json delete mode 100644 node_modules/@octokit/rest/package.json delete mode 100644 node_modules/@octokit/rest/plugins/authentication-deprecated/authenticate.js delete mode 100644 node_modules/@octokit/rest/plugins/authentication-deprecated/before-request.js delete mode 100644 node_modules/@octokit/rest/plugins/authentication-deprecated/index.js delete mode 100644 node_modules/@octokit/rest/plugins/authentication-deprecated/request-error.js delete mode 100644 node_modules/@octokit/rest/plugins/authentication/before-request.js delete mode 100644 node_modules/@octokit/rest/plugins/authentication/index.js delete mode 100644 node_modules/@octokit/rest/plugins/authentication/request-error.js delete mode 100644 node_modules/@octokit/rest/plugins/authentication/validate.js delete mode 100644 node_modules/@octokit/rest/plugins/authentication/with-authorization-prefix.js delete mode 100644 node_modules/@octokit/rest/plugins/log/index.js delete mode 100644 node_modules/@octokit/rest/plugins/pagination/index.js delete mode 100644 node_modules/@octokit/rest/plugins/pagination/iterator.js delete mode 100644 node_modules/@octokit/rest/plugins/pagination/normalize-paginated-list-response.js delete mode 100644 node_modules/@octokit/rest/plugins/pagination/paginate.js delete mode 100644 node_modules/@octokit/rest/plugins/register-endpoints/index.js delete mode 100644 node_modules/@octokit/rest/plugins/register-endpoints/register-endpoints.js delete mode 100644 node_modules/@octokit/rest/plugins/rest-api-endpoints/index.js delete mode 100644 node_modules/@octokit/rest/plugins/rest-api-endpoints/routes.json delete mode 100644 node_modules/@octokit/rest/plugins/validate/index.js delete mode 100644 node_modules/@octokit/rest/plugins/validate/validate.js delete mode 100644 node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md delete mode 100644 node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md delete mode 100644 node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md delete mode 100644 node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md delete mode 100644 node_modules/@octokit/types/.github/workflows/release.yml delete mode 100644 node_modules/@octokit/types/.github/workflows/routes-update.yml delete mode 100644 node_modules/@octokit/types/.github/workflows/test.yml delete mode 100644 node_modules/@octokit/types/CONTRIBUTING.md create mode 100644 node_modules/@octokit/types/dist-node/index.js create mode 100644 node_modules/@octokit/types/dist-node/index.js.map create mode 100644 node_modules/@octokit/types/dist-src/AuthInterface.js create mode 100644 node_modules/@octokit/types/dist-src/EndpointDefaults.js create mode 100644 node_modules/@octokit/types/dist-src/EndpointInterface.js create mode 100644 node_modules/@octokit/types/dist-src/EndpointOptions.js create mode 100644 node_modules/@octokit/types/dist-src/Fetch.js create mode 100644 node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js create mode 100644 node_modules/@octokit/types/dist-src/OctokitResponse.js create mode 100644 node_modules/@octokit/types/dist-src/RequestError.js create mode 100644 node_modules/@octokit/types/dist-src/RequestHeaders.js create mode 100644 node_modules/@octokit/types/dist-src/RequestInterface.js create mode 100644 node_modules/@octokit/types/dist-src/RequestMethod.js create mode 100644 node_modules/@octokit/types/dist-src/RequestOptions.js create mode 100644 node_modules/@octokit/types/dist-src/RequestParameters.js create mode 100644 node_modules/@octokit/types/dist-src/RequestRequestOptions.js create mode 100644 node_modules/@octokit/types/dist-src/ResponseHeaders.js create mode 100644 node_modules/@octokit/types/dist-src/Route.js create mode 100644 node_modules/@octokit/types/dist-src/Signal.js create mode 100644 node_modules/@octokit/types/dist-src/StrategyInterface.js create mode 100644 node_modules/@octokit/types/dist-src/Url.js create mode 100644 node_modules/@octokit/types/dist-src/VERSION.js create mode 100644 node_modules/@octokit/types/dist-src/generated/Endpoints.js rename node_modules/@octokit/types/{src/index.ts => dist-src/index.js} (82%) create mode 100644 node_modules/@octokit/types/dist-types/AuthInterface.d.ts rename node_modules/@octokit/types/{src/EndpointDefaults.ts => dist-types/EndpointDefaults.d.ts} (52%) create mode 100644 node_modules/@octokit/types/dist-types/EndpointInterface.d.ts rename node_modules/@octokit/types/{src/EndpointOptions.ts => dist-types/EndpointOptions.d.ts} (57%) rename node_modules/@octokit/types/{src/Fetch.ts => dist-types/Fetch.d.ts} (67%) create mode 100644 node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts create mode 100644 node_modules/@octokit/types/dist-types/OctokitResponse.d.ts create mode 100644 node_modules/@octokit/types/dist-types/RequestError.d.ts create mode 100644 node_modules/@octokit/types/dist-types/RequestHeaders.d.ts create mode 100644 node_modules/@octokit/types/dist-types/RequestInterface.d.ts create mode 100644 node_modules/@octokit/types/dist-types/RequestMethod.d.ts rename node_modules/@octokit/types/{src/RequestOptions.ts => dist-types/RequestOptions.d.ts} (63%) create mode 100644 node_modules/@octokit/types/dist-types/RequestParameters.d.ts create mode 100644 node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts create mode 100644 node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts create mode 100644 node_modules/@octokit/types/dist-types/Route.d.ts rename node_modules/@octokit/types/{src/Signal.ts => dist-types/Signal.d.ts} (73%) create mode 100644 node_modules/@octokit/types/dist-types/StrategyInterface.d.ts create mode 100644 node_modules/@octokit/types/dist-types/Url.d.ts create mode 100644 node_modules/@octokit/types/dist-types/VERSION.d.ts create mode 100644 node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts create mode 100644 node_modules/@octokit/types/dist-types/index.d.ts create mode 100644 node_modules/@octokit/types/dist-web/index.js create mode 100644 node_modules/@octokit/types/dist-web/index.js.map delete mode 100644 node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js delete mode 100644 node_modules/@octokit/types/scripts/update-endpoints/generated/README.md delete mode 100644 node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json delete mode 100644 node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template delete mode 100644 node_modules/@octokit/types/scripts/update-endpoints/typescript.js delete mode 100644 node_modules/@octokit/types/src/AuthInterface.ts delete mode 100644 node_modules/@octokit/types/src/EndpointInterface.ts delete mode 100644 node_modules/@octokit/types/src/OctokitResponse.ts delete mode 100644 node_modules/@octokit/types/src/RequestHeaders.ts delete mode 100644 node_modules/@octokit/types/src/RequestInterface.ts delete mode 100644 node_modules/@octokit/types/src/RequestMethod.ts delete mode 100644 node_modules/@octokit/types/src/RequestParameters.ts delete mode 100644 node_modules/@octokit/types/src/RequestRequestOptions.ts delete mode 100644 node_modules/@octokit/types/src/ResponseHeaders.ts delete mode 100644 node_modules/@octokit/types/src/Route.ts delete mode 100644 node_modules/@octokit/types/src/StrategyInterface.ts delete mode 100644 node_modules/@octokit/types/src/Url.ts delete mode 100644 node_modules/@octokit/types/src/VERSION.ts delete mode 100644 node_modules/@octokit/types/src/generated/Endpoints.ts delete mode 100644 node_modules/@octokit/types/src/generated/README.md create mode 100644 node_modules/@types/node/fs/promises.d.ts create mode 100644 node_modules/@types/node/globals.global.d.ts delete mode 100644 node_modules/@types/node/ts3.2/fs.d.ts delete mode 100644 node_modules/@types/node/ts3.2/globals.d.ts delete mode 100644 node_modules/@types/node/ts3.2/util.d.ts create mode 100644 node_modules/@types/node/ts3.4/assert.d.ts create mode 100644 node_modules/@types/node/ts3.4/base.d.ts create mode 100644 node_modules/@types/node/ts3.4/globals.global.d.ts create mode 100644 node_modules/@types/node/ts3.4/index.d.ts rename node_modules/@types/node/{ts3.2/index.d.ts => ts3.6/base.d.ts} (55%) create mode 100644 node_modules/@types/node/ts3.6/index.d.ts create mode 100644 node_modules/@types/node/wasi.d.ts delete mode 100644 node_modules/atob-lite/.npmignore delete mode 100644 node_modules/atob-lite/LICENSE.md delete mode 100644 node_modules/atob-lite/README.md delete mode 100644 node_modules/atob-lite/atob-browser.js delete mode 100644 node_modules/atob-lite/atob-node.js delete mode 100644 node_modules/atob-lite/package.json delete mode 100644 node_modules/btoa-lite/.npmignore delete mode 100644 node_modules/btoa-lite/LICENSE.md delete mode 100644 node_modules/btoa-lite/README.md delete mode 100644 node_modules/btoa-lite/btoa-browser.js delete mode 100644 node_modules/btoa-lite/btoa-node.js delete mode 100644 node_modules/btoa-lite/package.json delete mode 100644 node_modules/cross-spawn/CHANGELOG.md delete mode 100644 node_modules/cross-spawn/LICENSE delete mode 100644 node_modules/cross-spawn/README.md delete mode 100644 node_modules/cross-spawn/index.js delete mode 100644 node_modules/cross-spawn/lib/enoent.js delete mode 100644 node_modules/cross-spawn/lib/parse.js delete mode 100644 node_modules/cross-spawn/lib/util/escape.js delete mode 100644 node_modules/cross-spawn/lib/util/readShebang.js delete mode 100644 node_modules/cross-spawn/lib/util/resolveCommand.js delete mode 120000 node_modules/cross-spawn/node_modules/.bin/semver delete mode 100644 node_modules/cross-spawn/node_modules/semver/CHANGELOG.md delete mode 100644 node_modules/cross-spawn/node_modules/semver/LICENSE delete mode 100644 node_modules/cross-spawn/node_modules/semver/README.md delete mode 100755 node_modules/cross-spawn/node_modules/semver/bin/semver delete mode 100644 node_modules/cross-spawn/node_modules/semver/package.json delete mode 100644 node_modules/cross-spawn/node_modules/semver/range.bnf delete mode 100644 node_modules/cross-spawn/node_modules/semver/semver.js delete mode 100644 node_modules/cross-spawn/package.json delete mode 100644 node_modules/end-of-stream/README.md delete mode 100644 node_modules/end-of-stream/index.js delete mode 100644 node_modules/end-of-stream/package.json delete mode 100644 node_modules/execa/index.js delete mode 100644 node_modules/execa/lib/errname.js delete mode 100644 node_modules/execa/lib/stdio.js delete mode 100644 node_modules/execa/package.json delete mode 100644 node_modules/execa/readme.md delete mode 100644 node_modules/get-stream/buffer-stream.js delete mode 100644 node_modules/get-stream/index.js delete mode 100644 node_modules/get-stream/package.json delete mode 100644 node_modules/get-stream/readme.md create mode 100644 node_modules/is-plain-object/dist/is-plain-object.js rename node_modules/is-plain-object/{index.js => dist/is-plain-object.mjs} (58%) delete mode 100644 node_modules/is-plain-object/index.cjs.js delete mode 100644 node_modules/is-plain-object/index.d.ts create mode 100644 node_modules/is-plain-object/is-plain-object.d.ts delete mode 100644 node_modules/is-stream/index.js delete mode 100644 node_modules/is-stream/license delete mode 100644 node_modules/is-stream/package.json delete mode 100644 node_modules/is-stream/readme.md delete mode 100644 node_modules/isexe/.npmignore delete mode 100644 node_modules/isexe/LICENSE delete mode 100644 node_modules/isexe/README.md delete mode 100644 node_modules/isexe/index.js delete mode 100644 node_modules/isexe/mode.js delete mode 100644 node_modules/isexe/package.json delete mode 100644 node_modules/isexe/test/basic.js delete mode 100644 node_modules/isexe/windows.js delete mode 100644 node_modules/isobject/LICENSE delete mode 100644 node_modules/isobject/README.md delete mode 100644 node_modules/isobject/index.cjs.js delete mode 100644 node_modules/isobject/index.d.ts delete mode 100644 node_modules/isobject/index.js delete mode 100644 node_modules/isobject/package.json delete mode 100644 node_modules/lodash.get/LICENSE delete mode 100644 node_modules/lodash.get/README.md delete mode 100644 node_modules/lodash.get/index.js delete mode 100644 node_modules/lodash.get/package.json delete mode 100644 node_modules/lodash.set/LICENSE delete mode 100644 node_modules/lodash.set/README.md delete mode 100644 node_modules/lodash.set/index.js delete mode 100644 node_modules/lodash.set/package.json delete mode 100644 node_modules/lodash.uniq/LICENSE delete mode 100644 node_modules/lodash.uniq/README.md delete mode 100644 node_modules/lodash.uniq/index.js delete mode 100644 node_modules/lodash.uniq/package.json delete mode 100644 node_modules/macos-release/index.d.ts delete mode 100644 node_modules/macos-release/index.js delete mode 100644 node_modules/macos-release/license delete mode 100644 node_modules/macos-release/package.json delete mode 100644 node_modules/macos-release/readme.md delete mode 100644 node_modules/nice-try/CHANGELOG.md delete mode 100644 node_modules/nice-try/README.md delete mode 100644 node_modules/nice-try/package.json delete mode 100644 node_modules/nice-try/src/index.js delete mode 100644 node_modules/npm-run-path/index.js delete mode 100644 node_modules/npm-run-path/license delete mode 100644 node_modules/npm-run-path/package.json delete mode 100644 node_modules/npm-run-path/readme.md delete mode 100644 node_modules/octokit-pagination-methods/.travis.yml delete mode 100644 node_modules/octokit-pagination-methods/CODE_OF_CONDUCT.md delete mode 100644 node_modules/octokit-pagination-methods/LICENSE delete mode 100644 node_modules/octokit-pagination-methods/README.md delete mode 100644 node_modules/octokit-pagination-methods/index.js delete mode 100644 node_modules/octokit-pagination-methods/lib/deprecate.js delete mode 100644 node_modules/octokit-pagination-methods/lib/get-first-page.js delete mode 100644 node_modules/octokit-pagination-methods/lib/get-last-page.js delete mode 100644 node_modules/octokit-pagination-methods/lib/get-next-page.js delete mode 100644 node_modules/octokit-pagination-methods/lib/get-page-links.js delete mode 100644 node_modules/octokit-pagination-methods/lib/get-page.js delete mode 100644 node_modules/octokit-pagination-methods/lib/get-previous-page.js delete mode 100644 node_modules/octokit-pagination-methods/lib/has-first-page.js delete mode 100644 node_modules/octokit-pagination-methods/lib/has-last-page.js delete mode 100644 node_modules/octokit-pagination-methods/lib/has-next-page.js delete mode 100644 node_modules/octokit-pagination-methods/lib/has-previous-page.js delete mode 100644 node_modules/octokit-pagination-methods/lib/http-error.js delete mode 100644 node_modules/octokit-pagination-methods/package.json delete mode 100644 node_modules/octokit-pagination-methods/test.js delete mode 100644 node_modules/os-name/index.d.ts delete mode 100644 node_modules/os-name/index.js delete mode 100644 node_modules/os-name/package.json delete mode 100644 node_modules/os-name/readme.md delete mode 100644 node_modules/p-finally/index.js delete mode 100644 node_modules/p-finally/license delete mode 100644 node_modules/p-finally/package.json delete mode 100644 node_modules/p-finally/readme.md delete mode 100644 node_modules/path-key/index.js delete mode 100644 node_modules/path-key/license delete mode 100644 node_modules/path-key/package.json delete mode 100644 node_modules/path-key/readme.md delete mode 100644 node_modules/pump/.travis.yml delete mode 100644 node_modules/pump/README.md delete mode 100644 node_modules/pump/index.js delete mode 100644 node_modules/pump/package.json delete mode 100644 node_modules/pump/test-browser.js delete mode 100644 node_modules/pump/test-node.js delete mode 100644 node_modules/shebang-command/index.js delete mode 100644 node_modules/shebang-command/license delete mode 100644 node_modules/shebang-command/package.json delete mode 100644 node_modules/shebang-command/readme.md delete mode 100644 node_modules/shebang-regex/index.js delete mode 100644 node_modules/shebang-regex/license delete mode 100644 node_modules/shebang-regex/package.json delete mode 100644 node_modules/shebang-regex/readme.md delete mode 100644 node_modules/signal-exit/CHANGELOG.md delete mode 100644 node_modules/signal-exit/LICENSE.txt delete mode 100644 node_modules/signal-exit/README.md delete mode 100644 node_modules/signal-exit/index.js delete mode 100644 node_modules/signal-exit/package.json delete mode 100644 node_modules/signal-exit/signals.js delete mode 100644 node_modules/strip-eof/index.js delete mode 100644 node_modules/strip-eof/license delete mode 100644 node_modules/strip-eof/package.json delete mode 100644 node_modules/strip-eof/readme.md create mode 100644 node_modules/tunnel/.idea/encodings.xml create mode 100644 node_modules/tunnel/.idea/modules.xml create mode 100644 node_modules/tunnel/.idea/node-tunnel.iml create mode 100644 node_modules/tunnel/.idea/vcs.xml create mode 100644 node_modules/tunnel/.idea/workspace.xml create mode 100644 node_modules/tunnel/.travis.yml create mode 100644 node_modules/tunnel/CHANGELOG.md rename node_modules/{nice-try => tunnel}/LICENSE (96%) create mode 100644 node_modules/tunnel/README.md create mode 100644 node_modules/tunnel/index.js create mode 100644 node_modules/tunnel/lib/tunnel.js create mode 100644 node_modules/tunnel/package.json delete mode 100644 node_modules/universal-user-agent/.travis.yml delete mode 100644 node_modules/universal-user-agent/browser.js delete mode 100644 node_modules/universal-user-agent/cypress.json create mode 100644 node_modules/universal-user-agent/dist-node/index.js create mode 100644 node_modules/universal-user-agent/dist-node/index.js.map create mode 100644 node_modules/universal-user-agent/dist-src/index.js rename node_modules/{@octokit/endpoint/node_modules/universal-user-agent/dist-types/browser.d.ts => universal-user-agent/dist-types/index.d.ts} (100%) create mode 100644 node_modules/universal-user-agent/dist-web/index.js create mode 100644 node_modules/universal-user-agent/dist-web/index.js.map delete mode 100644 node_modules/universal-user-agent/index.d.ts delete mode 100644 node_modules/universal-user-agent/index.js delete mode 100644 node_modules/universal-user-agent/test/smoke-test.js delete mode 100644 node_modules/which/CHANGELOG.md delete mode 100644 node_modules/which/LICENSE delete mode 100644 node_modules/which/README.md delete mode 100755 node_modules/which/bin/which delete mode 100644 node_modules/which/package.json delete mode 100644 node_modules/which/which.js delete mode 100644 node_modules/windows-release/index.d.ts delete mode 100644 node_modules/windows-release/index.js delete mode 100644 node_modules/windows-release/license delete mode 100644 node_modules/windows-release/package.json delete mode 100644 node_modules/windows-release/readme.md diff --git a/node_modules/.bin/which b/node_modules/.bin/which deleted file mode 120000 index f62471c..0000000 --- a/node_modules/.bin/which +++ /dev/null @@ -1 +0,0 @@ -../which/bin/which \ No newline at end of file diff --git a/node_modules/@actions/github/LICENSE.md b/node_modules/@actions/core/LICENSE.md similarity index 97% rename from node_modules/@actions/github/LICENSE.md rename to node_modules/@actions/core/LICENSE.md index e5a73f4..dbae2ed 100644 --- a/node_modules/@actions/github/LICENSE.md +++ b/node_modules/@actions/core/LICENSE.md @@ -1,3 +1,5 @@ +The MIT License (MIT) + Copyright 2019 GitHub Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: diff --git a/node_modules/@actions/core/README.md b/node_modules/@actions/core/README.md index 457f73c..95428cf 100644 --- a/node_modules/@actions/core/README.md +++ b/node_modules/@actions/core/README.md @@ -82,7 +82,14 @@ try { core.warning('myInput was not set'); } + if (core.isDebug()) { + // curl -v https://github.com + } else { + // curl https://github.com + } + // Do stuff + core.info('Output to the actions build log') } catch (err) { core.error(`Error ${err}, action may still succeed though`); @@ -137,4 +144,4 @@ const core = require('@actions/core'); var pid = core.getState("pidToKill"); process.kill(pid); -``` \ No newline at end of file +``` diff --git a/node_modules/@actions/core/lib/command.d.ts b/node_modules/@actions/core/lib/command.d.ts index 7f6fecb..89eff66 100644 --- a/node_modules/@actions/core/lib/command.d.ts +++ b/node_modules/@actions/core/lib/command.d.ts @@ -1,16 +1,16 @@ interface CommandProperties { - [key: string]: string; + [key: string]: any; } /** * Commands * * Command Format: - * ##[name key=value;key=value]message + * ::name key=value,key=value::message * * Examples: - * ##[warning]This is the user warning message - * ##[set-secret name=mypassword]definitelyNotAPassword! + * ::warning::This is the message + * ::set-env name=MY_VAR::some value */ -export declare function issueCommand(command: string, properties: CommandProperties, message: string): void; +export declare function issueCommand(command: string, properties: CommandProperties, message: any): void; export declare function issue(name: string, message?: string): void; export {}; diff --git a/node_modules/@actions/core/lib/command.js b/node_modules/@actions/core/lib/command.js index b0ea009..10bf3eb 100644 --- a/node_modules/@actions/core/lib/command.js +++ b/node_modules/@actions/core/lib/command.js @@ -1,15 +1,23 @@ "use strict"; +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k]; + result["default"] = mod; + return result; +}; Object.defineProperty(exports, "__esModule", { value: true }); -const os = require("os"); +const os = __importStar(require("os")); +const utils_1 = require("./utils"); /** * Commands * * Command Format: - * ##[name key=value;key=value]message + * ::name key=value,key=value::message * * Examples: - * ##[warning]This is the user warning message - * ##[set-secret name=mypassword]definitelyNotAPassword! + * ::warning::This is the message + * ::set-env name=MY_VAR::some value */ function issueCommand(command, properties, message) { const cmd = new Command(command, properties, message); @@ -34,33 +42,38 @@ class Command { let cmdStr = CMD_STRING + this.command; if (this.properties && Object.keys(this.properties).length > 0) { cmdStr += ' '; + let first = true; for (const key in this.properties) { if (this.properties.hasOwnProperty(key)) { const val = this.properties[key]; if (val) { - // safely append the val - avoid blowing up when attempting to - // call .replace() if message is not a string for some reason - cmdStr += `${key}=${escape(`${val || ''}`)},`; + if (first) { + first = false; + } + else { + cmdStr += ','; + } + cmdStr += `${key}=${escapeProperty(val)}`; } } } } - cmdStr += CMD_STRING; - // safely append the message - avoid blowing up when attempting to - // call .replace() if message is not a string for some reason - const message = `${this.message || ''}`; - cmdStr += escapeData(message); + cmdStr += `${CMD_STRING}${escapeData(this.message)}`; return cmdStr; } } function escapeData(s) { - return s.replace(/\r/g, '%0D').replace(/\n/g, '%0A'); + return utils_1.toCommandValue(s) + .replace(/%/g, '%25') + .replace(/\r/g, '%0D') + .replace(/\n/g, '%0A'); } -function escape(s) { - return s +function escapeProperty(s) { + return utils_1.toCommandValue(s) + .replace(/%/g, '%25') .replace(/\r/g, '%0D') .replace(/\n/g, '%0A') - .replace(/]/g, '%5D') - .replace(/;/g, '%3B'); + .replace(/:/g, '%3A') + .replace(/,/g, '%2C'); } //# sourceMappingURL=command.js.map \ No newline at end of file diff --git a/node_modules/@actions/core/lib/command.js.map b/node_modules/@actions/core/lib/command.js.map index 918ab25..a95b303 100644 --- a/node_modules/@actions/core/lib/command.js.map +++ b/node_modules/@actions/core/lib/command.js.map @@ -1 +1 @@ -{"version":3,"file":"command.js","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":";;AAAA,yBAAwB;AAQxB;;;;;;;;;GASG;AACH,SAAgB,YAAY,CAC1B,OAAe,EACf,UAA6B,EAC7B,OAAe;IAEf,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAA;IACrD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAA;AAC/C,CAAC;AAPD,oCAOC;AAED,SAAgB,KAAK,CAAC,IAAY,EAAE,UAAkB,EAAE;IACtD,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;AACjC,CAAC;AAFD,sBAEC;AAED,MAAM,UAAU,GAAG,IAAI,CAAA;AAEvB,MAAM,OAAO;IAKX,YAAY,OAAe,EAAE,UAA6B,EAAE,OAAe;QACzE,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,iBAAiB,CAAA;SAC5B;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,QAAQ;QACN,IAAI,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC,OAAO,CAAA;QAEtC,IAAI,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YAC9D,MAAM,IAAI,GAAG,CAAA;YACb,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE;gBACjC,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;oBACvC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;oBAChC,IAAI,GAAG,EAAE;wBACP,8DAA8D;wBAC9D,6DAA6D;wBAC7D,MAAM,IAAI,GAAG,GAAG,IAAI,MAAM,CAAC,GAAG,GAAG,IAAI,EAAE,EAAE,CAAC,GAAG,CAAA;qBAC9C;iBACF;aACF;SACF;QAED,MAAM,IAAI,UAAU,CAAA;QAEpB,kEAAkE;QAClE,6DAA6D;QAC7D,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,EAAE,CAAA;QACvC,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,CAAA;QAE7B,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAED,SAAS,UAAU,CAAC,CAAS;IAC3B,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AACtD,CAAC;AAED,SAAS,MAAM,CAAC,CAAS;IACvB,OAAO,CAAC;SACL,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;AACzB,CAAC"} \ No newline at end of file +{"version":3,"file":"command.js","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":";;;;;;;;;AAAA,uCAAwB;AACxB,mCAAsC;AAWtC;;;;;;;;;GASG;AACH,SAAgB,YAAY,CAC1B,OAAe,EACf,UAA6B,EAC7B,OAAY;IAEZ,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAA;IACrD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAA;AAC/C,CAAC;AAPD,oCAOC;AAED,SAAgB,KAAK,CAAC,IAAY,EAAE,UAAkB,EAAE;IACtD,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;AACjC,CAAC;AAFD,sBAEC;AAED,MAAM,UAAU,GAAG,IAAI,CAAA;AAEvB,MAAM,OAAO;IAKX,YAAY,OAAe,EAAE,UAA6B,EAAE,OAAe;QACzE,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,iBAAiB,CAAA;SAC5B;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,QAAQ;QACN,IAAI,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC,OAAO,CAAA;QAEtC,IAAI,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YAC9D,MAAM,IAAI,GAAG,CAAA;YACb,IAAI,KAAK,GAAG,IAAI,CAAA;YAChB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE;gBACjC,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;oBACvC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;oBAChC,IAAI,GAAG,EAAE;wBACP,IAAI,KAAK,EAAE;4BACT,KAAK,GAAG,KAAK,CAAA;yBACd;6BAAM;4BACL,MAAM,IAAI,GAAG,CAAA;yBACd;wBAED,MAAM,IAAI,GAAG,GAAG,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE,CAAA;qBAC1C;iBACF;aACF;SACF;QAED,MAAM,IAAI,GAAG,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAA;QACpD,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAED,SAAS,UAAU,CAAC,CAAM;IACxB,OAAO,sBAAc,CAAC,CAAC,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AAC1B,CAAC;AAED,SAAS,cAAc,CAAC,CAAM;IAC5B,OAAO,sBAAc,CAAC,CAAC,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;AACzB,CAAC"} \ No newline at end of file diff --git a/node_modules/@actions/core/lib/core.d.ts b/node_modules/@actions/core/lib/core.d.ts index 6483c3c..8bb5093 100644 --- a/node_modules/@actions/core/lib/core.d.ts +++ b/node_modules/@actions/core/lib/core.d.ts @@ -21,9 +21,9 @@ export declare enum ExitCode { /** * Sets env variable for this action and future actions in the job * @param name the name of the variable to set - * @param val the value of the variable + * @param val the value of the variable. Non-string values will be converted to a string via JSON.stringify */ -export declare function exportVariable(name: string, val: string): void; +export declare function exportVariable(name: string, val: any): void; /** * Registers a secret which will get masked from logs * @param secret value of the secret @@ -46,15 +46,25 @@ export declare function getInput(name: string, options?: InputOptions): string; * Sets the value of an output. * * @param name name of the output to set - * @param value value to store + * @param value value to store. Non-string values will be converted to a string via JSON.stringify */ -export declare function setOutput(name: string, value: string): void; +export declare function setOutput(name: string, value: any): void; +/** + * Enables or disables the echoing of commands into stdout for the rest of the step. + * Echoing is disabled by default if ACTIONS_STEP_DEBUG is not set. + * + */ +export declare function setCommandEcho(enabled: boolean): void; /** * Sets the action status to failed. * When the action exits it will be with an exit code of 1 * @param message add error issue message */ -export declare function setFailed(message: string): void; +export declare function setFailed(message: string | Error): void; +/** + * Gets whether Actions Step Debug is on or not + */ +export declare function isDebug(): boolean; /** * Writes debug message to user log * @param message debug message @@ -62,14 +72,14 @@ export declare function setFailed(message: string): void; export declare function debug(message: string): void; /** * Adds an error issue - * @param message error issue message + * @param message error issue message. Errors will be converted to string via toString() */ -export declare function error(message: string): void; +export declare function error(message: string | Error): void; /** * Adds an warning issue - * @param message warning issue message + * @param message warning issue message. Errors will be converted to string via toString() */ -export declare function warning(message: string): void; +export declare function warning(message: string | Error): void; /** * Writes info to log with console.log. * @param message info message @@ -100,9 +110,9 @@ export declare function group(name: string, fn: () => Promise): Promise * Saves state for current action, the state can only be retrieved by this action's post job execution. * * @param name name of the state to store - * @param value value to store + * @param value value to store. Non-string values will be converted to a string via JSON.stringify */ -export declare function saveState(name: string, value: string): void; +export declare function saveState(name: string, value: any): void; /** * Gets the value of an state set by this action's main execution. * diff --git a/node_modules/@actions/core/lib/core.js b/node_modules/@actions/core/lib/core.js index f43d507..8b33110 100644 --- a/node_modules/@actions/core/lib/core.js +++ b/node_modules/@actions/core/lib/core.js @@ -8,10 +8,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge step((generator = generator.apply(thisArg, _arguments || [])).next()); }); }; +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k]; + result["default"] = mod; + return result; +}; Object.defineProperty(exports, "__esModule", { value: true }); const command_1 = require("./command"); -const os = require("os"); -const path = require("path"); +const file_command_1 = require("./file-command"); +const utils_1 = require("./utils"); +const os = __importStar(require("os")); +const path = __importStar(require("path")); /** * The code to exit an action */ @@ -32,11 +41,21 @@ var ExitCode; /** * Sets env variable for this action and future actions in the job * @param name the name of the variable to set - * @param val the value of the variable + * @param val the value of the variable. Non-string values will be converted to a string via JSON.stringify */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any function exportVariable(name, val) { - process.env[name] = val; - command_1.issueCommand('set-env', { name }, val); + const convertedVal = utils_1.toCommandValue(val); + process.env[name] = convertedVal; + const filePath = process.env['GITHUB_ENV'] || ''; + if (filePath) { + const delimiter = '_GitHubActionsFileCommandDelimeter_'; + const commandValue = `${name}<<${delimiter}${os.EOL}${convertedVal}${os.EOL}${delimiter}`; + file_command_1.issueCommand('ENV', commandValue); + } + else { + command_1.issueCommand('set-env', { name }, convertedVal); + } } exports.exportVariable = exportVariable; /** @@ -52,7 +71,13 @@ exports.setSecret = setSecret; * @param inputPath */ function addPath(inputPath) { - command_1.issueCommand('add-path', {}, inputPath); + const filePath = process.env['GITHUB_PATH'] || ''; + if (filePath) { + file_command_1.issueCommand('PATH', inputPath); + } + else { + command_1.issueCommand('add-path', {}, inputPath); + } process.env['PATH'] = `${inputPath}${path.delimiter}${process.env['PATH']}`; } exports.addPath = addPath; @@ -75,12 +100,22 @@ exports.getInput = getInput; * Sets the value of an output. * * @param name name of the output to set - * @param value value to store + * @param value value to store. Non-string values will be converted to a string via JSON.stringify */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any function setOutput(name, value) { command_1.issueCommand('set-output', { name }, value); } exports.setOutput = setOutput; +/** + * Enables or disables the echoing of commands into stdout for the rest of the step. + * Echoing is disabled by default if ACTIONS_STEP_DEBUG is not set. + * + */ +function setCommandEcho(enabled) { + command_1.issue('echo', enabled ? 'on' : 'off'); +} +exports.setCommandEcho = setCommandEcho; //----------------------------------------------------------------------- // Results //----------------------------------------------------------------------- @@ -97,6 +132,13 @@ exports.setFailed = setFailed; //----------------------------------------------------------------------- // Logging Commands //----------------------------------------------------------------------- +/** + * Gets whether Actions Step Debug is on or not + */ +function isDebug() { + return process.env['RUNNER_DEBUG'] === '1'; +} +exports.isDebug = isDebug; /** * Writes debug message to user log * @param message debug message @@ -107,18 +149,18 @@ function debug(message) { exports.debug = debug; /** * Adds an error issue - * @param message error issue message + * @param message error issue message. Errors will be converted to string via toString() */ function error(message) { - command_1.issue('error', message); + command_1.issue('error', message instanceof Error ? message.toString() : message); } exports.error = error; /** * Adds an warning issue - * @param message warning issue message + * @param message warning issue message. Errors will be converted to string via toString() */ function warning(message) { - command_1.issue('warning', message); + command_1.issue('warning', message instanceof Error ? message.toString() : message); } exports.warning = warning; /** @@ -176,8 +218,9 @@ exports.group = group; * Saves state for current action, the state can only be retrieved by this action's post job execution. * * @param name name of the state to store - * @param value value to store + * @param value value to store. Non-string values will be converted to a string via JSON.stringify */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any function saveState(name, value) { command_1.issueCommand('save-state', { name }, value); } diff --git a/node_modules/@actions/core/lib/core.js.map b/node_modules/@actions/core/lib/core.js.map index 6eda8da..7e7cbcc 100644 --- a/node_modules/@actions/core/lib/core.js.map +++ b/node_modules/@actions/core/lib/core.js.map @@ -1 +1 @@ -{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,uCAA6C;AAE7C,yBAAwB;AACxB,6BAA4B;AAU5B;;GAEG;AACH,IAAY,QAUX;AAVD,WAAY,QAAQ;IAClB;;OAEG;IACH,6CAAW,CAAA;IAEX;;OAEG;IACH,6CAAW,CAAA;AACb,CAAC,EAVW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAUnB;AAED,yEAAyE;AACzE,YAAY;AACZ,yEAAyE;AAEzE;;;;GAIG;AACH,SAAgB,cAAc,CAAC,IAAY,EAAE,GAAW;IACtD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAA;IACvB,sBAAY,CAAC,SAAS,EAAE,EAAC,IAAI,EAAC,EAAE,GAAG,CAAC,CAAA;AACtC,CAAC;AAHD,wCAGC;AAED;;;GAGG;AACH,SAAgB,SAAS,CAAC,MAAc;IACtC,sBAAY,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,CAAA;AACtC,CAAC;AAFD,8BAEC;AAED;;;GAGG;AACH,SAAgB,OAAO,CAAC,SAAiB;IACvC,sBAAY,CAAC,UAAU,EAAE,EAAE,EAAE,SAAS,CAAC,CAAA;IACvC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAA;AAC7E,CAAC;AAHD,0BAGC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,IAAY,EAAE,OAAsB;IAC3D,MAAM,GAAG,GACP,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,EAAE,CAAA;IACrE,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,GAAG,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAI,EAAE,CAAC,CAAA;KAC5D;IAED,OAAO,GAAG,CAAC,IAAI,EAAE,CAAA;AACnB,CAAC;AARD,4BAQC;AAED;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,IAAY,EAAE,KAAa;IACnD,sBAAY,CAAC,YAAY,EAAE,EAAC,IAAI,EAAC,EAAE,KAAK,CAAC,CAAA;AAC3C,CAAC;AAFD,8BAEC;AAED,yEAAyE;AACzE,UAAU;AACV,yEAAyE;AAEzE;;;;GAIG;AACH,SAAgB,SAAS,CAAC,OAAe;IACvC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAA;IACnC,KAAK,CAAC,OAAO,CAAC,CAAA;AAChB,CAAC;AAHD,8BAGC;AAED,yEAAyE;AACzE,mBAAmB;AACnB,yEAAyE;AAEzE;;;GAGG;AACH,SAAgB,KAAK,CAAC,OAAe;IACnC,sBAAY,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;AACpC,CAAC;AAFD,sBAEC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAC,OAAe;IACnC,eAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AACzB,CAAC;AAFD,sBAEC;AAED;;;GAGG;AACH,SAAgB,OAAO,CAAC,OAAe;IACrC,eAAK,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;AAC3B,CAAC;AAFD,0BAEC;AAED;;;GAGG;AACH,SAAgB,IAAI,CAAC,OAAe;IAClC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,CAAA;AACxC,CAAC;AAFD,oBAEC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,IAAY;IACrC,eAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;AACtB,CAAC;AAFD,gCAEC;AAED;;GAEG;AACH,SAAgB,QAAQ;IACtB,eAAK,CAAC,UAAU,CAAC,CAAA;AACnB,CAAC;AAFD,4BAEC;AAED;;;;;;;GAOG;AACH,SAAsB,KAAK,CAAI,IAAY,EAAE,EAAoB;;QAC/D,UAAU,CAAC,IAAI,CAAC,CAAA;QAEhB,IAAI,MAAS,CAAA;QAEb,IAAI;YACF,MAAM,GAAG,MAAM,EAAE,EAAE,CAAA;SACpB;gBAAS;YACR,QAAQ,EAAE,CAAA;SACX;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CAAA;AAZD,sBAYC;AAED,yEAAyE;AACzE,uBAAuB;AACvB,yEAAyE;AAEzE;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,IAAY,EAAE,KAAa;IACnD,sBAAY,CAAC,YAAY,EAAE,EAAC,IAAI,EAAC,EAAE,KAAK,CAAC,CAAA;AAC3C,CAAC;AAFD,8BAEC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,IAAY;IACnC,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,EAAE,CAAA;AAC3C,CAAC;AAFD,4BAEC"} \ No newline at end of file +{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,uCAA6C;AAC7C,iDAA+D;AAC/D,mCAAsC;AAEtC,uCAAwB;AACxB,2CAA4B;AAU5B;;GAEG;AACH,IAAY,QAUX;AAVD,WAAY,QAAQ;IAClB;;OAEG;IACH,6CAAW,CAAA;IAEX;;OAEG;IACH,6CAAW,CAAA;AACb,CAAC,EAVW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAUnB;AAED,yEAAyE;AACzE,YAAY;AACZ,yEAAyE;AAEzE;;;;GAIG;AACH,8DAA8D;AAC9D,SAAgB,cAAc,CAAC,IAAY,EAAE,GAAQ;IACnD,MAAM,YAAY,GAAG,sBAAc,CAAC,GAAG,CAAC,CAAA;IACxC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,YAAY,CAAA;IAEhC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAA;IAChD,IAAI,QAAQ,EAAE;QACZ,MAAM,SAAS,GAAG,qCAAqC,CAAA;QACvD,MAAM,YAAY,GAAG,GAAG,IAAI,KAAK,SAAS,GAAG,EAAE,CAAC,GAAG,GAAG,YAAY,GAAG,EAAE,CAAC,GAAG,GAAG,SAAS,EAAE,CAAA;QACzF,2BAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;KACtC;SAAM;QACL,sBAAY,CAAC,SAAS,EAAE,EAAC,IAAI,EAAC,EAAE,YAAY,CAAC,CAAA;KAC9C;AACH,CAAC;AAZD,wCAYC;AAED;;;GAGG;AACH,SAAgB,SAAS,CAAC,MAAc;IACtC,sBAAY,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,CAAA;AACtC,CAAC;AAFD,8BAEC;AAED;;;GAGG;AACH,SAAgB,OAAO,CAAC,SAAiB;IACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,CAAA;IACjD,IAAI,QAAQ,EAAE;QACZ,2BAAgB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;KACpC;SAAM;QACL,sBAAY,CAAC,UAAU,EAAE,EAAE,EAAE,SAAS,CAAC,CAAA;KACxC;IACD,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAA;AAC7E,CAAC;AARD,0BAQC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,IAAY,EAAE,OAAsB;IAC3D,MAAM,GAAG,GACP,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,EAAE,CAAA;IACrE,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,GAAG,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAI,EAAE,CAAC,CAAA;KAC5D;IAED,OAAO,GAAG,CAAC,IAAI,EAAE,CAAA;AACnB,CAAC;AARD,4BAQC;AAED;;;;;GAKG;AACH,8DAA8D;AAC9D,SAAgB,SAAS,CAAC,IAAY,EAAE,KAAU;IAChD,sBAAY,CAAC,YAAY,EAAE,EAAC,IAAI,EAAC,EAAE,KAAK,CAAC,CAAA;AAC3C,CAAC;AAFD,8BAEC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,OAAgB;IAC7C,eAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AACvC,CAAC;AAFD,wCAEC;AAED,yEAAyE;AACzE,UAAU;AACV,yEAAyE;AAEzE;;;;GAIG;AACH,SAAgB,SAAS,CAAC,OAAuB;IAC/C,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAA;IAEnC,KAAK,CAAC,OAAO,CAAC,CAAA;AAChB,CAAC;AAJD,8BAIC;AAED,yEAAyE;AACzE,mBAAmB;AACnB,yEAAyE;AAEzE;;GAEG;AACH,SAAgB,OAAO;IACrB,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,GAAG,CAAA;AAC5C,CAAC;AAFD,0BAEC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAC,OAAe;IACnC,sBAAY,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;AACpC,CAAC;AAFD,sBAEC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAC,OAAuB;IAC3C,eAAK,CAAC,OAAO,EAAE,OAAO,YAAY,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;AACzE,CAAC;AAFD,sBAEC;AAED;;;GAGG;AACH,SAAgB,OAAO,CAAC,OAAuB;IAC7C,eAAK,CAAC,SAAS,EAAE,OAAO,YAAY,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;AAC3E,CAAC;AAFD,0BAEC;AAED;;;GAGG;AACH,SAAgB,IAAI,CAAC,OAAe;IAClC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,CAAA;AACxC,CAAC;AAFD,oBAEC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,IAAY;IACrC,eAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;AACtB,CAAC;AAFD,gCAEC;AAED;;GAEG;AACH,SAAgB,QAAQ;IACtB,eAAK,CAAC,UAAU,CAAC,CAAA;AACnB,CAAC;AAFD,4BAEC;AAED;;;;;;;GAOG;AACH,SAAsB,KAAK,CAAI,IAAY,EAAE,EAAoB;;QAC/D,UAAU,CAAC,IAAI,CAAC,CAAA;QAEhB,IAAI,MAAS,CAAA;QAEb,IAAI;YACF,MAAM,GAAG,MAAM,EAAE,EAAE,CAAA;SACpB;gBAAS;YACR,QAAQ,EAAE,CAAA;SACX;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CAAA;AAZD,sBAYC;AAED,yEAAyE;AACzE,uBAAuB;AACvB,yEAAyE;AAEzE;;;;;GAKG;AACH,8DAA8D;AAC9D,SAAgB,SAAS,CAAC,IAAY,EAAE,KAAU;IAChD,sBAAY,CAAC,YAAY,EAAE,EAAC,IAAI,EAAC,EAAE,KAAK,CAAC,CAAA;AAC3C,CAAC;AAFD,8BAEC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,IAAY;IACnC,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,EAAE,CAAA;AAC3C,CAAC;AAFD,4BAEC"} \ No newline at end of file diff --git a/node_modules/@actions/core/lib/file-command.d.ts b/node_modules/@actions/core/lib/file-command.d.ts new file mode 100644 index 0000000..ed408eb --- /dev/null +++ b/node_modules/@actions/core/lib/file-command.d.ts @@ -0,0 +1 @@ +export declare function issueCommand(command: string, message: any): void; diff --git a/node_modules/@actions/core/lib/file-command.js b/node_modules/@actions/core/lib/file-command.js new file mode 100644 index 0000000..10783c0 --- /dev/null +++ b/node_modules/@actions/core/lib/file-command.js @@ -0,0 +1,29 @@ +"use strict"; +// For internal use, subject to change. +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k]; + result["default"] = mod; + return result; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +// We use any as a valid input type +/* eslint-disable @typescript-eslint/no-explicit-any */ +const fs = __importStar(require("fs")); +const os = __importStar(require("os")); +const utils_1 = require("./utils"); +function issueCommand(command, message) { + const filePath = process.env[`GITHUB_${command}`]; + if (!filePath) { + throw new Error(`Unable to find environment variable for file command ${command}`); + } + if (!fs.existsSync(filePath)) { + throw new Error(`Missing file at path: ${filePath}`); + } + fs.appendFileSync(filePath, `${utils_1.toCommandValue(message)}${os.EOL}`, { + encoding: 'utf8' + }); +} +exports.issueCommand = issueCommand; +//# sourceMappingURL=file-command.js.map \ No newline at end of file diff --git a/node_modules/@actions/core/lib/file-command.js.map b/node_modules/@actions/core/lib/file-command.js.map new file mode 100644 index 0000000..45fd8c4 --- /dev/null +++ b/node_modules/@actions/core/lib/file-command.js.map @@ -0,0 +1 @@ +{"version":3,"file":"file-command.js","sourceRoot":"","sources":["../src/file-command.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;;;;;;;AAEvC,mCAAmC;AACnC,uDAAuD;AAEvD,uCAAwB;AACxB,uCAAwB;AACxB,mCAAsC;AAEtC,SAAgB,YAAY,CAAC,OAAe,EAAE,OAAY;IACxD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,OAAO,EAAE,CAAC,CAAA;IACjD,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CACb,wDAAwD,OAAO,EAAE,CAClE,CAAA;KACF;IACD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QAC5B,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,EAAE,CAAC,CAAA;KACrD;IAED,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,GAAG,sBAAc,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;QACjE,QAAQ,EAAE,MAAM;KACjB,CAAC,CAAA;AACJ,CAAC;AAdD,oCAcC"} \ No newline at end of file diff --git a/node_modules/@actions/core/lib/utils.d.ts b/node_modules/@actions/core/lib/utils.d.ts new file mode 100644 index 0000000..b39c9be --- /dev/null +++ b/node_modules/@actions/core/lib/utils.d.ts @@ -0,0 +1,5 @@ +/** + * Sanitizes an input into a string so it can be passed into issueCommand safely + * @param input input to sanitize into a string + */ +export declare function toCommandValue(input: any): string; diff --git a/node_modules/@actions/core/lib/utils.js b/node_modules/@actions/core/lib/utils.js new file mode 100644 index 0000000..97cea33 --- /dev/null +++ b/node_modules/@actions/core/lib/utils.js @@ -0,0 +1,19 @@ +"use strict"; +// We use any as a valid input type +/* eslint-disable @typescript-eslint/no-explicit-any */ +Object.defineProperty(exports, "__esModule", { value: true }); +/** + * Sanitizes an input into a string so it can be passed into issueCommand safely + * @param input input to sanitize into a string + */ +function toCommandValue(input) { + if (input === null || input === undefined) { + return ''; + } + else if (typeof input === 'string' || input instanceof String) { + return input; + } + return JSON.stringify(input); +} +exports.toCommandValue = toCommandValue; +//# sourceMappingURL=utils.js.map \ No newline at end of file diff --git a/node_modules/@actions/core/lib/utils.js.map b/node_modules/@actions/core/lib/utils.js.map new file mode 100644 index 0000000..ce43f03 --- /dev/null +++ b/node_modules/@actions/core/lib/utils.js.map @@ -0,0 +1 @@ +{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAAA,mCAAmC;AACnC,uDAAuD;;AAEvD;;;GAGG;AACH,SAAgB,cAAc,CAAC,KAAU;IACvC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;QACzC,OAAO,EAAE,CAAA;KACV;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,MAAM,EAAE;QAC/D,OAAO,KAAe,CAAA;KACvB;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;AAC9B,CAAC;AAPD,wCAOC"} \ No newline at end of file diff --git a/node_modules/@actions/core/package.json b/node_modules/@actions/core/package.json index b11b97c..8bb0474 100644 --- a/node_modules/@actions/core/package.json +++ b/node_modules/@actions/core/package.json @@ -1,28 +1,28 @@ { - "_from": "@actions/core@1.2.0", - "_id": "@actions/core@1.2.0", + "_from": "@actions/core@^1.2.6", + "_id": "@actions/core@1.2.6", "_inBundle": false, - "_integrity": "sha512-ZKdyhlSlyz38S6YFfPnyNgCDZuAF2T0Qv5eHflNWytPS8Qjvz39bZFMry9Bb/dpSnqWcNeav5yM2CTYpJeY+Dw==", + "_integrity": "sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA==", "_location": "/@actions/core", "_phantomChildren": {}, "_requested": { - "type": "version", + "type": "range", "registry": true, - "raw": "@actions/core@1.2.0", + "raw": "@actions/core@^1.2.6", "name": "@actions/core", "escapedName": "@actions%2fcore", "scope": "@actions", - "rawSpec": "1.2.0", + "rawSpec": "^1.2.6", "saveSpec": null, - "fetchSpec": "1.2.0" + "fetchSpec": "^1.2.6" }, "_requiredBy": [ "#USER", "/" ], - "_resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.0.tgz", - "_shasum": "aa5f52b26c362c821d41557e599371a42f6c0b3d", - "_spec": "@actions/core@1.2.0", + "_resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.6.tgz", + "_shasum": "a78d49f41a4def18e88ce47c2cac615d5694bf09", + "_spec": "@actions/core@^1.2.6", "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", "bugs": { "url": "https://github.com/actions/toolkit/issues" @@ -38,9 +38,10 @@ "test": "__tests__" }, "files": [ - "lib" + "lib", + "!.DS_Store" ], - "homepage": "https://github.com/actions/toolkit/tree/master/packages/core", + "homepage": "https://github.com/actions/toolkit/tree/main/packages/core", "keywords": [ "github", "actions", @@ -58,8 +59,10 @@ "directory": "packages/core" }, "scripts": { + "audit-moderate": "npm install && npm audit --json --audit-level=moderate > audit.json", "test": "echo \"Error: run tests from root\" && exit 1", "tsc": "tsc" }, - "version": "1.2.0" + "types": "lib/core.d.ts", + "version": "1.2.6" } diff --git a/node_modules/@actions/github/README.md b/node_modules/@actions/github/README.md index b431256..02e9be0 100644 --- a/node_modules/@actions/github/README.md +++ b/node_modules/@actions/github/README.md @@ -4,31 +4,39 @@ ## Usage -Returns an Octokit client. See https://octokit.github.io/rest.js for the API. +Returns an authenticated Octokit client that follows the machine [proxy settings](https://help.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners) and correctly sets GHES base urls. See https://octokit.github.io/rest.js for the API. ```js const github = require('@actions/github'); const core = require('@actions/core'); -// This should be a token with access to your repository scoped in as a secret. -const myToken = core.getInput('myToken'); +async function run() { + // This should be a token with access to your repository scoped in as a secret. + // The YML workflow will need to set myToken with the GitHub Secret Token + // myToken: ${{ secrets.GITHUB_TOKEN }} + // https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token#about-the-github_token-secret + const myToken = core.getInput('myToken'); -const octokit = new github.GitHub(myToken); + const octokit = github.getOctokit(myToken) -const { data: pullRequest } = await octokit.pulls.get({ - owner: 'octokit', - repo: 'rest.js', - pull_number: 123, - mediaType: { - format: 'diff' - } -}); + // You can also pass in additional options as a second parameter to getOctokit + // const octokit = github.getOctokit(myToken, {userAgent: "MyActionVersion1"}); -console.log(pullRequest); + const { data: pullRequest } = await octokit.pulls.get({ + owner: 'octokit', + repo: 'rest.js', + pull_number: 123, + mediaType: { + format: 'diff' + } + }); + + console.log(pullRequest); +} + +run(); ``` -You can pass client options (except `auth`, which is handled by the token argument), as specified by [Octokit](https://octokit.github.io/rest.js/), as a second argument to the `GitHub` constructor. - You can also make GraphQL requests. See https://github.com/octokit/graphql.js for the API. ```js @@ -48,3 +56,42 @@ const newIssue = await octokit.issues.create({ body: 'Hello Universe!' }); ``` + +## Webhook payload typescript definitions + +The npm module `@octokit/webhooks` provides type definitions for the response payloads. You can cast the payload to these types for better type information. + +First, install the npm module `npm install @octokit/webhooks` + +Then, assert the type based on the eventName +```ts +import * as core from '@actions/core' +import * as github from '@actions/github' +import * as Webhooks from '@octokit/webhooks' +if (github.context.eventName === 'push') { + const pushPayload = github.context.payload as Webhooks.WebhookPayloadPush + core.info(`The head commit is: ${pushPayload.head}`) +} +``` + +## Extending the Octokit instance +`@octokit/core` now supports the [plugin architecture](https://github.com/octokit/core.js#plugins). You can extend the GitHub instance using plugins. + +For example, using the `@octokit/plugin-enterprise-server` you can now access enterprise admin apis on GHES instances. + +```ts +import { GitHub, getOctokitOptions } from '@actions/github/lib/utils' +import { enterpriseServer220Admin } from '@octokit/plugin-enterprise-server' + +const octokit = GitHub.plugin(enterpriseServer220Admin) +// or override some of the default values as well +// const octokit = GitHub.plugin(enterpriseServer220Admin).defaults({userAgent: "MyNewUserAgent"}) + +const myToken = core.getInput('myToken'); +const myOctokit = new octokit(getOctokitOptions(token)) +// Create a new user +myOctokit.enterpriseAdmin.createUser({ + login: "testuser", + email: "testuser@test.com", +}); +``` diff --git a/node_modules/@actions/github/lib/context.d.ts b/node_modules/@actions/github/lib/context.d.ts index 3ee7583..daab690 100644 --- a/node_modules/@actions/github/lib/context.d.ts +++ b/node_modules/@actions/github/lib/context.d.ts @@ -10,16 +10,19 @@ export declare class Context { workflow: string; action: string; actor: string; + job: string; + runNumber: number; + runId: number; /** * Hydrate the context from the environment */ constructor(); - readonly issue: { + get issue(): { owner: string; repo: string; number: number; }; - readonly repo: { + get repo(): { owner: string; repo: string; }; diff --git a/node_modules/@actions/github/lib/context.js b/node_modules/@actions/github/lib/context.js index 0df128f..dd4d10a 100644 --- a/node_modules/@actions/github/lib/context.js +++ b/node_modules/@actions/github/lib/context.js @@ -1,5 +1,6 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); +exports.Context = void 0; const fs_1 = require("fs"); const os_1 = require("os"); class Context { @@ -13,7 +14,8 @@ class Context { this.payload = JSON.parse(fs_1.readFileSync(process.env.GITHUB_EVENT_PATH, { encoding: 'utf8' })); } else { - process.stdout.write(`GITHUB_EVENT_PATH ${process.env.GITHUB_EVENT_PATH} does not exist${os_1.EOL}`); + const path = process.env.GITHUB_EVENT_PATH; + process.stdout.write(`GITHUB_EVENT_PATH ${path} does not exist${os_1.EOL}`); } } this.eventName = process.env.GITHUB_EVENT_NAME; @@ -22,10 +24,13 @@ class Context { this.workflow = process.env.GITHUB_WORKFLOW; this.action = process.env.GITHUB_ACTION; this.actor = process.env.GITHUB_ACTOR; + this.job = process.env.GITHUB_JOB; + this.runNumber = parseInt(process.env.GITHUB_RUN_NUMBER, 10); + this.runId = parseInt(process.env.GITHUB_RUN_ID, 10); } get issue() { const payload = this.payload; - return Object.assign(Object.assign({}, this.repo), { number: (payload.issue || payload.pullRequest || payload).number }); + return Object.assign(Object.assign({}, this.repo), { number: (payload.issue || payload.pull_request || payload).number }); } get repo() { if (process.env.GITHUB_REPOSITORY) { diff --git a/node_modules/@actions/github/lib/context.js.map b/node_modules/@actions/github/lib/context.js.map index 24eabd8..9c4eafe 100644 --- a/node_modules/@actions/github/lib/context.js.map +++ b/node_modules/@actions/github/lib/context.js.map @@ -1 +1 @@ -{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":";;AAEA,2BAA2C;AAC3C,2BAAsB;AAEtB,MAAa,OAAO;IAalB;;OAEG;IACH;QACE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,IAAI,eAAU,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE;gBAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CACvB,iBAAY,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAChE,CAAA;aACF;iBAAM;gBACL,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,qBACE,OAAO,CAAC,GAAG,CAAC,iBACd,kBAAkB,QAAG,EAAE,CACxB,CAAA;aACF;SACF;QACD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,iBAA2B,CAAA;QACxD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAoB,CAAA;QAC3C,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAoB,CAAA;QAC3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,eAAyB,CAAA;QACrD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,aAAuB,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,YAAsB,CAAA;IACjD,CAAC;IAED,IAAI,KAAK;QACP,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAE5B,uCACK,IAAI,CAAC,IAAI,KACZ,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,CAAC,MAAM,IACjE;IACH,CAAC;IAED,IAAI,IAAI;QACN,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC9D,OAAO,EAAC,KAAK,EAAE,IAAI,EAAC,CAAA;SACrB;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YAC3B,OAAO;gBACL,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK;gBAC1C,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI;aACnC,CAAA;SACF;QAED,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAA;IACH,CAAC;CACF;AAjED,0BAiEC"} \ No newline at end of file +{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":";;;AAEA,2BAA2C;AAC3C,2BAAsB;AAEtB,MAAa,OAAO;IAgBlB;;OAEG;IACH;QACE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,IAAI,eAAU,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE;gBAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CACvB,iBAAY,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAChE,CAAA;aACF;iBAAM;gBACL,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;gBAC1C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,IAAI,kBAAkB,QAAG,EAAE,CAAC,CAAA;aACvE;SACF;QACD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,iBAA2B,CAAA;QACxD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAoB,CAAA;QAC3C,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAoB,CAAA;QAC3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,eAAyB,CAAA;QACrD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,aAAuB,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,YAAsB,CAAA;QAC/C,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAoB,CAAA;QAC3C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAA2B,EAAE,EAAE,CAAC,CAAA;QACtE,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAuB,EAAE,EAAE,CAAC,CAAA;IAChE,CAAC;IAED,IAAI,KAAK;QACP,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAE5B,uCACK,IAAI,CAAC,IAAI,KACZ,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,CAAC,MAAM,IAClE;IACH,CAAC;IAED,IAAI,IAAI;QACN,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC9D,OAAO,EAAC,KAAK,EAAE,IAAI,EAAC,CAAA;SACrB;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YAC3B,OAAO;gBACL,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK;gBAC1C,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI;aACnC,CAAA;SACF;QAED,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAA;IACH,CAAC;CACF;AApED,0BAoEC"} \ No newline at end of file diff --git a/node_modules/@actions/github/lib/github.d.ts b/node_modules/@actions/github/lib/github.d.ts index 7c5b9f2..90c3b98 100644 --- a/node_modules/@actions/github/lib/github.d.ts +++ b/node_modules/@actions/github/lib/github.d.ts @@ -1,8 +1,11 @@ -import { GraphQlQueryResponse, Variables } from '@octokit/graphql'; -import Octokit from '@octokit/rest'; import * as Context from './context'; +import { GitHub } from './utils'; +import { OctokitOptions } from '@octokit/core/dist-types/types'; export declare const context: Context.Context; -export declare class GitHub extends Octokit { - graphql: (query: string, variables?: Variables) => Promise; - constructor(token: string, opts?: Omit); -} +/** + * Returns a hydrated octokit ready to use for GitHub Actions + * + * @param token the repo PAT or GITHUB_TOKEN + * @param options other options to set + */ +export declare function getOctokit(token: string, options?: OctokitOptions): InstanceType; diff --git a/node_modules/@actions/github/lib/github.js b/node_modules/@actions/github/lib/github.js index d5c782f..e30e81e 100644 --- a/node_modules/@actions/github/lib/github.js +++ b/node_modules/@actions/github/lib/github.js @@ -1,29 +1,36 @@ "use strict"; -var __importDefault = (this && this.__importDefault) || function (mod) { - return (mod && mod.__esModule) ? mod : { "default": mod }; -}; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); var __importStar = (this && this.__importStar) || function (mod) { if (mod && mod.__esModule) return mod; var result = {}; - if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k]; - result["default"] = mod; + if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); return result; }; Object.defineProperty(exports, "__esModule", { value: true }); -// Originally pulled from https://github.com/JasonEtco/actions-toolkit/blob/master/src/github.ts -const graphql_1 = require("@octokit/graphql"); -const rest_1 = __importDefault(require("@octokit/rest")); +exports.getOctokit = exports.context = void 0; const Context = __importStar(require("./context")); -// We need this in order to extend Octokit -rest_1.default.prototype = new rest_1.default(); +const utils_1 = require("./utils"); exports.context = new Context.Context(); -class GitHub extends rest_1.default { - constructor(token, opts = {}) { - super(Object.assign(Object.assign({}, opts), { auth: `token ${token}` })); - this.graphql = graphql_1.defaults({ - headers: { authorization: `token ${token}` } - }); - } +/** + * Returns a hydrated octokit ready to use for GitHub Actions + * + * @param token the repo PAT or GITHUB_TOKEN + * @param options other options to set + */ +function getOctokit(token, options) { + return new utils_1.GitHub(utils_1.getOctokitOptions(token, options)); } -exports.GitHub = GitHub; +exports.getOctokit = getOctokit; //# sourceMappingURL=github.js.map \ No newline at end of file diff --git a/node_modules/@actions/github/lib/github.js.map b/node_modules/@actions/github/lib/github.js.map index 0c268e8..717d03e 100644 --- a/node_modules/@actions/github/lib/github.js.map +++ b/node_modules/@actions/github/lib/github.js.map @@ -1 +1 @@ -{"version":3,"file":"github.js","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gGAAgG;AAChG,8CAA0E;AAC1E,yDAAmC;AACnC,mDAAoC;AAEpC,0CAA0C;AAC1C,cAAO,CAAC,SAAS,GAAG,IAAI,cAAO,EAAE,CAAA;AAEpB,QAAA,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;AAE5C,MAAa,MAAO,SAAQ,cAAO;IAMjC,YAAY,KAAa,EAAE,OAAsC,EAAE;QACjE,KAAK,iCAAK,IAAI,KAAE,IAAI,EAAE,SAAS,KAAK,EAAE,IAAE,CAAA;QACxC,IAAI,CAAC,OAAO,GAAG,kBAAQ,CAAC;YACtB,OAAO,EAAE,EAAC,aAAa,EAAE,SAAS,KAAK,EAAE,EAAC;SAC3C,CAAC,CAAA;IACJ,CAAC;CACF;AAZD,wBAYC"} \ No newline at end of file +{"version":3,"file":"github.js","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAoC;AACpC,mCAAiD;AAKpC,QAAA,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;AAE5C;;;;;GAKG;AACH,SAAgB,UAAU,CACxB,KAAa,EACb,OAAwB;IAExB,OAAO,IAAI,cAAM,CAAC,yBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AACtD,CAAC;AALD,gCAKC"} \ No newline at end of file diff --git a/node_modules/@actions/github/lib/interfaces.d.ts b/node_modules/@actions/github/lib/interfaces.d.ts index 23788cc..f810333 100644 --- a/node_modules/@actions/github/lib/interfaces.d.ts +++ b/node_modules/@actions/github/lib/interfaces.d.ts @@ -33,4 +33,8 @@ export interface WebhookPayload { id: number; [key: string]: any; }; + comment?: { + id: number; + [key: string]: any; + }; } diff --git a/node_modules/@actions/github/lib/internal/utils.d.ts b/node_modules/@actions/github/lib/internal/utils.d.ts new file mode 100644 index 0000000..5790d91 --- /dev/null +++ b/node_modules/@actions/github/lib/internal/utils.d.ts @@ -0,0 +1,6 @@ +/// +import * as http from 'http'; +import { OctokitOptions } from '@octokit/core/dist-types/types'; +export declare function getAuthString(token: string, options: OctokitOptions): string | undefined; +export declare function getProxyAgent(destinationUrl: string): http.Agent; +export declare function getApiBaseUrl(): string; diff --git a/node_modules/@actions/github/lib/internal/utils.js b/node_modules/@actions/github/lib/internal/utils.js new file mode 100644 index 0000000..197a441 --- /dev/null +++ b/node_modules/@actions/github/lib/internal/utils.js @@ -0,0 +1,43 @@ +"use strict"; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.getApiBaseUrl = exports.getProxyAgent = exports.getAuthString = void 0; +const httpClient = __importStar(require("@actions/http-client")); +function getAuthString(token, options) { + if (!token && !options.auth) { + throw new Error('Parameter token or opts.auth is required'); + } + else if (token && options.auth) { + throw new Error('Parameters token and opts.auth may not both be specified'); + } + return typeof options.auth === 'string' ? options.auth : `token ${token}`; +} +exports.getAuthString = getAuthString; +function getProxyAgent(destinationUrl) { + const hc = new httpClient.HttpClient(); + return hc.getAgent(destinationUrl); +} +exports.getProxyAgent = getProxyAgent; +function getApiBaseUrl() { + return process.env['GITHUB_API_URL'] || 'https://api.github.com'; +} +exports.getApiBaseUrl = getApiBaseUrl; +//# sourceMappingURL=utils.js.map \ No newline at end of file diff --git a/node_modules/@actions/github/lib/internal/utils.js.map b/node_modules/@actions/github/lib/internal/utils.js.map new file mode 100644 index 0000000..f1f519d --- /dev/null +++ b/node_modules/@actions/github/lib/internal/utils.js.map @@ -0,0 +1 @@ +{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/internal/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AACA,iEAAkD;AAGlD,SAAgB,aAAa,CAC3B,KAAa,EACb,OAAuB;IAEvB,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;KAC5D;SAAM,IAAI,KAAK,IAAI,OAAO,CAAC,IAAI,EAAE;QAChC,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;KAC5E;IAED,OAAO,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,KAAK,EAAE,CAAA;AAC3E,CAAC;AAXD,sCAWC;AAED,SAAgB,aAAa,CAAC,cAAsB;IAClD,MAAM,EAAE,GAAG,IAAI,UAAU,CAAC,UAAU,EAAE,CAAA;IACtC,OAAO,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;AACpC,CAAC;AAHD,sCAGC;AAED,SAAgB,aAAa;IAC3B,OAAO,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,wBAAwB,CAAA;AAClE,CAAC;AAFD,sCAEC"} \ No newline at end of file diff --git a/node_modules/@actions/github/lib/utils.d.ts b/node_modules/@actions/github/lib/utils.d.ts new file mode 100644 index 0000000..0015a35 --- /dev/null +++ b/node_modules/@actions/github/lib/utils.d.ts @@ -0,0 +1,21 @@ +import * as Context from './context'; +import { Octokit } from '@octokit/core'; +import { OctokitOptions } from '@octokit/core/dist-types/types'; +export declare const context: Context.Context; +export declare const GitHub: (new (...args: any[]) => { + [x: string]: any; +}) & { + new (...args: any[]): { + [x: string]: any; + }; + plugins: any[]; +} & typeof Octokit & import("@octokit/core/dist-types/types").Constructor; +/** + * Convience function to correctly format Octokit Options to pass into the constructor. + * + * @param token the repo PAT or GITHUB_TOKEN + * @param options other options to set + */ +export declare function getOctokitOptions(token: string, options?: OctokitOptions): OctokitOptions; diff --git a/node_modules/@actions/github/lib/utils.js b/node_modules/@actions/github/lib/utils.js new file mode 100644 index 0000000..b066c22 --- /dev/null +++ b/node_modules/@actions/github/lib/utils.js @@ -0,0 +1,54 @@ +"use strict"; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.getOctokitOptions = exports.GitHub = exports.context = void 0; +const Context = __importStar(require("./context")); +const Utils = __importStar(require("./internal/utils")); +// octokit + plugins +const core_1 = require("@octokit/core"); +const plugin_rest_endpoint_methods_1 = require("@octokit/plugin-rest-endpoint-methods"); +const plugin_paginate_rest_1 = require("@octokit/plugin-paginate-rest"); +exports.context = new Context.Context(); +const baseUrl = Utils.getApiBaseUrl(); +const defaults = { + baseUrl, + request: { + agent: Utils.getProxyAgent(baseUrl) + } +}; +exports.GitHub = core_1.Octokit.plugin(plugin_rest_endpoint_methods_1.restEndpointMethods, plugin_paginate_rest_1.paginateRest).defaults(defaults); +/** + * Convience function to correctly format Octokit Options to pass into the constructor. + * + * @param token the repo PAT or GITHUB_TOKEN + * @param options other options to set + */ +function getOctokitOptions(token, options) { + const opts = Object.assign({}, options || {}); // Shallow clone - don't mutate the object provided by the caller + // Auth + const auth = Utils.getAuthString(token, opts); + if (auth) { + opts.auth = auth; + } + return opts; +} +exports.getOctokitOptions = getOctokitOptions; +//# sourceMappingURL=utils.js.map \ No newline at end of file diff --git a/node_modules/@actions/github/lib/utils.js.map b/node_modules/@actions/github/lib/utils.js.map new file mode 100644 index 0000000..3a6f6b4 --- /dev/null +++ b/node_modules/@actions/github/lib/utils.js.map @@ -0,0 +1 @@ +{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAoC;AACpC,wDAAyC;AAEzC,oBAAoB;AACpB,wCAAqC;AAErC,wFAAyE;AACzE,wEAA0D;AAE7C,QAAA,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;AAE5C,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,EAAE,CAAA;AACrC,MAAM,QAAQ,GAAG;IACf,OAAO;IACP,OAAO,EAAE;QACP,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC;KACpC;CACF,CAAA;AAEY,QAAA,MAAM,GAAG,cAAO,CAAC,MAAM,CAClC,kDAAmB,EACnB,mCAAY,CACb,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAEpB;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,KAAa,EACb,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,IAAI,EAAE,CAAC,CAAA,CAAC,iEAAiE;IAE/G,OAAO;IACP,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAC7C,IAAI,IAAI,EAAE;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;KACjB;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAbD,8CAaC"} \ No newline at end of file diff --git a/node_modules/@actions/github/package.json b/node_modules/@actions/github/package.json index 733a1e3..e42a5cf 100644 --- a/node_modules/@actions/github/package.json +++ b/node_modules/@actions/github/package.json @@ -1,50 +1,55 @@ { - "_from": "@actions/github@1.1.0", - "_id": "@actions/github@1.1.0", + "_args": [ + [ + "@actions/github@4.0.0", + "." + ] + ], + "_from": "@actions/github@4.0.0", + "_id": "@actions/github@4.0.0", "_inBundle": false, - "_integrity": "sha512-cHf6PyoNMdei13jEdGPhKprIMFmjVVW/dnM5/9QmQDJ1ZTaGVyezUSCUIC/ySNLRvDUpeFwPYMdThSEJldSbUw==", + "_integrity": "sha512-Ej/Y2E+VV6sR9X7pWL5F3VgEWrABaT292DRqRU6R4hnQjPtC/zD3nagxVdXWiRQvYDh8kHXo7IDmG42eJ/dOMA==", "_location": "/@actions/github", "_phantomChildren": {}, "_requested": { "type": "version", "registry": true, - "raw": "@actions/github@1.1.0", + "raw": "@actions/github@4.0.0", "name": "@actions/github", "escapedName": "@actions%2fgithub", "scope": "@actions", - "rawSpec": "1.1.0", + "rawSpec": "4.0.0", "saveSpec": null, - "fetchSpec": "1.1.0" + "fetchSpec": "4.0.0" }, "_requiredBy": [ - "#USER", "/" ], - "_resolved": "https://registry.npmjs.org/@actions/github/-/github-1.1.0.tgz", - "_shasum": "06f34e6b0cf07eb2b3641de3e680dbfae6bcd400", - "_spec": "@actions/github@1.1.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", + "_resolved": "https://registry.npmjs.org/@actions/github/-/github-4.0.0.tgz", + "_spec": "4.0.0", + "_where": ".", "bugs": { "url": "https://github.com/actions/toolkit/issues" }, - "bundleDependencies": false, "dependencies": { - "@octokit/graphql": "^2.0.1", - "@octokit/rest": "^16.15.0" + "@actions/http-client": "^1.0.8", + "@octokit/core": "^3.0.0", + "@octokit/plugin-paginate-rest": "^2.2.3", + "@octokit/plugin-rest-endpoint-methods": "^4.0.0" }, - "deprecated": false, "description": "Actions github lib", "devDependencies": { - "jest": "^24.7.1" + "jest": "^25.1.0", + "proxy": "^1.0.1" }, "directories": { "lib": "lib", "test": "__tests__" }, "files": [ - "lib" + "lib", + "!.DS_Store" ], - "gitHead": "a2ab4bcf78e4f7080f0d45856e6eeba16f0bbc52", "homepage": "https://github.com/actions/toolkit/tree/master/packages/github", "keywords": [ "github", @@ -58,12 +63,17 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/actions/toolkit.git" + "url": "git+https://github.com/actions/toolkit.git", + "directory": "packages/github" }, "scripts": { + "audit-moderate": "npm install && npm audit --audit-level=moderate", "build": "tsc", + "format": "prettier --write **/*.ts", + "format-check": "prettier --check **/*.ts", "test": "jest", "tsc": "tsc" }, - "version": "1.1.0" + "types": "lib/github.d.ts", + "version": "4.0.0" } diff --git a/node_modules/@actions/http-client/LICENSE b/node_modules/@actions/http-client/LICENSE new file mode 100644 index 0000000..5823a51 --- /dev/null +++ b/node_modules/@actions/http-client/LICENSE @@ -0,0 +1,21 @@ +Actions Http Client for Node.js + +Copyright (c) GitHub, Inc. + +All rights reserved. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and +associated documentation files (the "Software"), to deal in the Software without restriction, +including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT +LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN +NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/@actions/http-client/README.md b/node_modules/@actions/http-client/README.md new file mode 100644 index 0000000..be61eb3 --- /dev/null +++ b/node_modules/@actions/http-client/README.md @@ -0,0 +1,79 @@ + +

+ +

+ +# Actions Http-Client + +[![Http Status](https://github.com/actions/http-client/workflows/http-tests/badge.svg)](https://github.com/actions/http-client/actions) + +A lightweight HTTP client optimized for use with actions, TypeScript with generics and async await. + +## Features + + - HTTP client with TypeScript generics and async/await/Promises + - Typings included so no need to acquire separately (great for intellisense and no versioning drift) + - [Proxy support](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners#using-a-proxy-server-with-self-hosted-runners) just works with actions and the runner + - Targets ES2019 (runner runs actions with node 12+). Only supported on node 12+. + - Basic, Bearer and PAT Support out of the box. Extensible handlers for others. + - Redirects supported + +Features and releases [here](./RELEASES.md) + +## Install + +``` +npm install @actions/http-client --save +``` + +## Samples + +See the [HTTP](./__tests__) tests for detailed examples. + +## Errors + +### HTTP + +The HTTP client does not throw unless truly exceptional. + +* A request that successfully executes resulting in a 404, 500 etc... will return a response object with a status code and a body. +* Redirects (3xx) will be followed by default. + +See [HTTP tests](./__tests__) for detailed examples. + +## Debugging + +To enable detailed console logging of all HTTP requests and responses, set the NODE_DEBUG environment varible: + +``` +export NODE_DEBUG=http +``` + +## Node support + +The http-client is built using the latest LTS version of Node 12. It may work on previous node LTS versions but it's tested and officially supported on Node12+. + +## Support and Versioning + +We follow semver and will hold compatibility between major versions and increment the minor version with new features and capabilities (while holding compat). + +## Contributing + +We welcome PRs. Please create an issue and if applicable, a design before proceeding with code. + +once: + +```bash +$ npm install +``` + +To build: + +```bash +$ npm run build +``` + +To run all tests: +```bash +$ npm test +``` diff --git a/node_modules/@actions/http-client/RELEASES.md b/node_modules/@actions/http-client/RELEASES.md new file mode 100644 index 0000000..245477d --- /dev/null +++ b/node_modules/@actions/http-client/RELEASES.md @@ -0,0 +1,22 @@ +## Releases + +## 1.0.9 +Throw HttpClientError instead of a generic Error from the \Json() helper methods when the server responds with a non-successful status code. + +## 1.0.8 +Fixed security issue where a redirect (e.g. 302) to another domain would pass headers. The fix was to strip the authorization header if the hostname was different. More [details in PR #27](https://github.com/actions/http-client/pull/27) + +## 1.0.7 +Update NPM dependencies and add 429 to the list of HttpCodes + +## 1.0.6 +Automatically sends Content-Type and Accept application/json headers for \Json() helper methods if not set in the client or parameters. + +## 1.0.5 +Adds \Json() helper methods for json over http scenarios. + +## 1.0.4 +Started to add \Json() helper methods. Do not use this release for that. Use >= 1.0.5 since there was an issue with types. + +## 1.0.1 to 1.0.3 +Adds proxy support. diff --git a/node_modules/@actions/http-client/actions.png b/node_modules/@actions/http-client/actions.png new file mode 100644 index 0000000000000000000000000000000000000000..1857ef375592b5bbce3f2b225865d32428c13acb GIT binary patch literal 33889 zcmdSAWpo|Qt{`fRDQ0Hon3-{RMHd;v*6ILy$;QPLW6i;9yF`M$b-X%*4t`#KA?+ z#Lmjd!v2MbnURT$fsvDeiG_}liJOs~n~j6$UyTGv&B4TsTUk{6U$lUCd?eqTob0$6 z7+hUl>0Mdq0S@L2Ok7+*9Lx;N%yd8qI!AX~Cqp+nTSwA=V-PiUGqpm$->BgQ>Nt zjj64ZBM_G9Kd^S+08RkMZ-D;|>i=~APXvIXm6Q7qjsJEmHa7nu;pimh0%YS~0{L&D z9aY`!Oc|6-9Rbb`#-?H}z+sa9;l_?z#KF|i3E-d#09gNfq7?r>^ zQFH*9Sy%%*9F--6iKN6t*qON4+3A?+nf?w}PL5m3*3rq(*4R`^l#c``9(oH46K)PB zE@o3k7Bf0CP9sJ-RxV=>I!;bjLpoLyBMwt8BMv53HXxzDbH*(SFn0c<1pj{D&H2-K1x1@z5a9-X2WjrdT_W!!FwjlbeFx-a5e++?-#Q2W}n3|CM z>#@cEwFLe_>-x1p?x8CM7DQ>Xvbu>DsQVHXoAhy>gqn z>gjO-V?maH7Jj?#i42M?D)#mzCxD8^MN~)-DP~>fTP~Eaq_D@u-aXHQd^VTk z*#p~?@D6P5-#$zn4QM@GVC$S}5kA}ow(HF`j3C7vn>+O_4d)TbAk)uwf) z8;`w+c_-s`{uq~fjZSKU_(txjUVgLF*r5@ox2}yds~nRvKJyBai8*h+XH2)_>wTS z>l>Cf1-`Q0bUD!G6Sg1=Z<@HccOuqJ)EsrAraGJyemSn=tSgGU-n(ge*Qke?Lon^l z?f1>*6$Tmu5zz`T$xn#I@~f& z)pq!{S}#k>bKTr=N^hC(h);+CEkfc1iXaJ9q0Y#`1A*|Yu1<@p)7(Dd(r7v8b&;db zu$R>JYHJ~4F>}(7bbZ6G1k|A{pfV+U6N2{EUV5Od|Hk>Y#Q${^^64;TR=x9xurQK0 zu3rbGQIv=kNf|UT0AxS>S27VABpwn9p!2)Xnam!MLiW|{D#oal$#a2e-HeZ2dS;se z@`zkYY480XjfMtl^s;#@3L3g9KCgToH`{B56`>S-+msKMuhddBK6q)MI=vtm0uj|~ zNAa+{UxOgkS5+93PuEQTir%EnoqMmh7l8pBU*%fYcygXFQ#fzF)-sOev%*Hr5*l|Qyo3@&8%9t6QQm@_JH{{3oCP_Azu?;k zcAQh%v=Hv zhbCMA5+8oN%C?IdyQ5s%+dW`Cg(lNylrZhV(L{L8{y2;9Oay4)}%s;!3-7zJ-?i zQ6<)XIp58`w70Ia`zp(?I|{RNLM+eit)nk{^19n_n8oUlJVgpOa+^w42j^q?oGB-z4tGyF#M9r(w8^bq_8lF^DllFIQre4Y@tMkw? zkBWO$ZtWG}i&|sX`!(tYK+Z&&3MxZHdHzVPXu6I+DsyBzC{8nLs!R}rg6$oheC0i~ z+h4t)aHA)*nY^!fD6cc$6r*|^y;z4F8Xpbxr`qHCfE+`Q)t}kSBsPg~+orc$jo2Jl5r%Z*sut1@U940uk?wYH?73~ksYH4FLwAS)n)a7$OSL1yPaQje?MRSE`^?ZbodVPvxus+MXIGbB!(vwU6~tN z4V*196SUlB`3oiWMnY4|1dq}4vRT8|4M7n1uoCXE**BlNHrFN_+Db$LthFSf>|Y;? zCJEBiN^0n8YOx>W+h^M|sKC{1#`ueu@7B4iq`$R+#1WJP;&OY`>KwiQN(Tj1Hxscj z&u0OlC)2)i$1YlZuT=I6u16Gn*3OnR!w{i#R~|KkXOuTTalu8^3Q;&6ntO>e1NjS5 zabyBs9HY#zBCKz)*Q60%D7jQ6x!fyB07-n6=En>S@1;@n+~e$LWwA_DB0R;NOKs!6 z4e`v^AMk`3Eg$VBDmZk97qKS~*>O^2SdAN;MFgygqP$n`gi#S={DJ>SxQ2x!L3vw> zlCk=Qm^O3gJ*OgnuwKR}a$9hP7TXR=4thakK^euwzR9rUkEv-b5TKk*z+4!uNfjn~A>jGPV-|pP6~@Twd|@oAm9M3i zlOEL3LR;+}Kd=i@c2baZ&_<%09w|Ze@iF)8O1Iqhm{$nIkSrt$DFfjdA^Qj#tEyY~ zeJJ8bMI5ZljqVD&O>SN@((oc~(zbj}uQq--%R5 zCSCI&DnD~)zpdu);cmQ4hvk0^dI*})1*Hxwugk78Qa9_Qq+4(rR1rRBPW;m8BfPcP z^y6SO{m!&Cy5ZT(&_bL3gE-Mc^!J#4c*rgr{OFk)+#kV;h&Gm zPJiZ_*~qoqVqA@fHfzaZCC{p?;u`%DzgYyOy(s|U-NeT0&O&-uttsk@ODYApq*?vz zo9803%|-XljrV%!?sna;P1szSXySZ)5R+~DXL+2-CZ&xoh zAr!d4g9N1p4i5!#6pVF_Og&Jj=<&I^6w7mb9A;gcOf_uv8=1$-7_xf~4N0%YITI?7 z+#E8k`8MlFb!Jg*zgU?_xRjP*xRUr|LHl0xi9mVVq|Nd?u%K2&yE#y)+ct}0A4#HF zOP2-S9?x$V7?5r(B*X*cI> zWx7wV#oezuAEkM*{#062W)j@(0GpZ*+-&dwcfo~2Zl?fOqXUPaGPcplk5%_t^n{nd zVD9X&fLJ}45sCDDQ$j?%J47_E1oH((d2et^Y!Ms45Vsr3>KiIO(irvlgSVz@_y@x* z5n6SzW9Pgo%0f{ zmI`V@=<~ai$7&J~S}clWX<^>;@SKRTP~Zw(IK*jh$wso=vv4#^Q90EMHGDU)k|jt2 zpFebS`bhrJwchlVNn48AqauE(MasJ6N#k3oa6utNP@X`f<#}2vNe=~=M5Q8_<$}OM zIHqMV2`FSF^e`{gT|NW)RV!+{_&d&g{S&_kg=;x%K2?D3WPyz*>K%(2^IJPySaTzq z@Q^6pMz{XhM^jX>Iv}n%q%XKc`6keK#{8(#ks@@l^SMA}rRJAfT5WLndS@_yhcq&I zq2$8@~RomQQ88|x3}+mCY#^3a01Ev)*k&`@|pJ8LR0uVS5rWJLN)M{AZu>ez}^oKWBmSIh9ZQ`%sT7P`Ok&-}oB zI;p=B^k-Af&| z2_i`$a3KQRmmK_67ESvdjp@-78czdXT?RJQlq!fR8Dh4Ny+!^MzH*CN$}lt>Gezo4Mfdvkn5{KaV?h=O|Mp9I zFYTv2=W@`_=yW(%J1CwQa^z-Ar zn#uvPkWlJ`537bveayM1JX)#PGKPMwKU%|Gl)ne*Sg#J4BL4M-s(4PwmQowY^4fD} zkNinF&&1if9L?@KmeBAJc#_sV?Cq-Hc`1rFQk+S_>RNIJ6U1q7D*1cZNIoa~lPp90 ztF5{F51AJueduyI--5lRVZuM{vEfw8IY<|?KXt6Q*gFdF+=!5`$3EPjMc^Qij*=FL z!Ehl9PEaECA@*>14X#Z77%-08G!Z;}Pb*`gzo;%XTIP@Er0G`w+P&IEzR^OkMfcPm zJq*<9{y$os|9s6Ob5=1+xk~W^e{asut4-uB*kDcHcMF~8HAr$R_E;+MaCAqX;Km+p#6dKhwkaG`>fVpwrX~d(?$7~pV*;cw4$Y}3mF#Se_taq zXO(pTcPQj|L&Sh(H?)X$N?`Wm&yFhM&w?KUBP0>#VC@o?KGnliUpihlaH5tS;slGh zbcN?pLm;%_>n@-iP$cOj7c&Mk-V#_m7NOTD=K=ajIn*Uh9PV@zmg(Z2gBaGFGWHgvJDY-%0&E~|VVtr*k!jq9 z?y6`CJu$Y$cnx1iy6*1I5JQ*itg)Y(5QK{}L^%^E=B>AHlD?*aK671+6YN#s&1yG( zXvEz=UhJlqUS!cEqI|A4SDha(z0*g`M2PwI!_0F80#7E728E|2eN^2c#V@(H!J2?| z9``a~AxE6wmsqyAE|P%9FRmtAl(|nJ(*T&e0IO%f9Cv*(5UCsL7NtVNII%9itlmLG zyH>%O6=+Y~;dBGXG1DH>w|02s6j&*G!gGe5AZo5B1 z2Pq@65Y`n2lQgrruGFc~W;bNB>9z%+N%n^}ifwa7#Y=E69C(bG)h8sm9qDKYQ`}H9 z{{ZI9Hi2Qh%rC>QJ6~&MczARD;vLZ_6JzBm!0Q+lsHJvN_PZK!^;D$TT~XBfRB5zx z#hV(gsIx z2Tg=PAvv{>!jaFN&pOCwj88Rr8c;B{n6`Y~y{BRkas^}HJ;+znb|SB+HT{wlVl}$4 zeQs-G^#g6!R)}#L@Z5Nf%u{h-+@Z>79e+K4IIN1Jz@YK@*^(3QN_=`fl#eq_*QSXJ z9QV^;bAc|I>Ir8Xysn+l99j5v81NP$33bE?LF2(v^6_rsXp4@GnXK?nY=f<5ufnoo z973oxz7fMN*`=@DYOvAiBlo4D?W8V65MA@bC^IQ%aqK?PN^8ZFrqK+JJB|k8=(*=D znWA`oZm*h`tprV*->^mn0y4)x(>d?X+i3BGb^%3aR$5BaeBLEgPM(|}JRw6Y0{`eB z*|Jm-c4)(!K)Rq^>PmEq=K1XaQwBO{s^%JnN4E!IcAGL6YwBmBeV_E@OFLQok#{3) z0?=y&{|yuNL=2+YtVEhk#C;hEr>0Fik+9PEA@6=3SXyGfhevi1fHW4S&Xt-Yb)BN{ zuZbGxy5``2uJPXdI-|o4V};#n9kHl>tU(zU2#^$?&yfI^Fh8i%VxnO~|K7EtMOa!( zZ&&g9iBdBhITAS{VVd`dgn91k$QP7!6u>exW!1B*8!>*3HooO#7pt1*mFb5PCB+b! z3>fzJOq9n2GBqm$AtKk4!WK&Fc?qJ%;MPasnWISB0DAgt6ks;N<8!@fVj}Vt`ec|U zk4Hh1PGmc*^>UT0ZZkc|mN2NYqmJLGOC~>BK%YY1%M1VJO|7LBYWnj$>UAL#?U1a` z2jAQNnH4AFwu+M1z-zi*k?;f_RicT<>e&0#{pgxNZ1Ed2X<>Lk;5OpTsFjR`?=i~d zcVWnj!9rHuw?{?52Wia;TpyKw%#$qh`?gFu+*sg;HbPpS#V)roS!?U1hKADK;&5o$ zh!rlj`#ozwHE&P@{uKYy4o$(2$|p&yEu)fSVEW49@6wLN=?2XP@7+v?wY!m^DOIW8 zKrqai(g-Cx3+5XUc|>khv@Nl4CuDF%@bn{;_+_4yIh(NtBvn?b5dh)ohOR9`bBgPI ze}}(iuQ4i~Ael2I>M8+Y9>@sWs;-UiYd#gbRh`J7d(~srJV9zufm#L|no_F5{uS1= z6d@>YbDAvoEgIUoE_A%cm5X2t^tOM-ra7y2YUJG$hF@9?-8d9}dlQ_&d?Ie(i@Q1e z^VLuu4Xj1SXSA1W*ewJ+4G5rRqW|@y?AA+?RkSiI^)|6MryQmd6p=ygl)tM#4o9G} zcqiQG&niKOgr!W~=B;WH@qf_Vhs8qxKGF*KOntAHg(%(M-fWfXwzRhg;8k6;ImnQ} zkn<*vJ>EjXClPJWtO(4TLr!Y=3WJ4NW{9U}{H<+GytH5}H3w>Kq(8^E%5-tOGr+w> zImL;shJw^%OW!l-@Eq4Rx^&J8QDyT|Qlmlgq(dHkEpo)Fyx3w}X?gxVJHo+b&E&mw zl0H=!V)K)L5;M8uPx_xvTtb4N)|C1#wDU<Y(@RL4IBsb1^-j$$C-CaoyDS7-&)bxDG9z?juL3R6*fu zUkV^Q4X56BH_XkG+Wpn_A4c9Kh-*}+Z)cPn?9ffk<<0vC%xkX@U1t^&#YRdrxkd!E z5P&t1r_XESL={n8D1D+OLGy^`TQL%vK z5qx0$%ixgvX;9qSNHxm|bQ-f6MduOaiL^7=W-B}!Sk4K0nRYy4nkmkbzrMYh4qC6Y{muPK8fhoD)SNSJ!z9!l*KaO5KpBmCTY1%HGKJemUB+Yu0A2~j z{p=^C-p_+ZLP$YKNE*z#gvSXmeR&Eq7g9oc;=K>Kn#pWEdnf`#f>$CgY$jv$t@blaj)>X6+g2hyqWi6_ ziryNNl~fb0xd+3*5r48MExeTc05~fDY*vgE|0Y<=Ye9hs+IKu^o#Jg{V6$_^%snbQ zUE^4$0wSFA4dJ^rY@JbY2vuuTmUWTS-c6Ts|CV{aB|l!co=49~d3F-#b5*v@n#%**);wSf zCb-tQ1|I#DjqJmPhXq03Q@k3S;dSptW_Pi7PgsR@c)weU^C>NMw8Qwty7hkT;;od4 z=~feL<(#XyjAZJRGxb|o=S~r$#i3#nq}mEJ5`DEO3%ke(?Pq?f;iT35*vUCPD>p6^ z4dbB9P)Pt5q3-L8lTFyVdFGGS6XC!eL6YxWPFS_^3Io_ISYL*V;H)x%lk ze60aN?dc3YHdX?EUvltN^IWAHH<JwGY?=EKa6+x0<=1dnX0p17ZI;OA&?hHXrHHBog&b0Or zD}+8WV+yuIT^;qCa!z(_#6Me3^Z$moqUmX_@6ic)RqU zRPL|%7vHLbjx%RRv=I-sEtsR^vZ+zAQ)ZW5&vg!$!p_Y)!x1G)+(owvkECjU{K_4IOMvJynI7e(A?|Jt6;c-I+sPeJWYG-l2>1-as zJM673w!2=OtuD;N4`9IAeSx#kQdL(qLckqAY_-Iz4mW%AOf&-)!95Uw8M7JV5}%Dp zo$hFylKxSrspo@P{Ro zb9Pb|NP)nT)4&Gr3hzVv1-^GMXMv8SSFKRP=k|hit)P`Dzb(K0k{oJ6rcNtZO_#{- z1lmpm_m#|OTI$bgYo;tv4lpAzrLQfM+D{Fsp+$of+PLW!8%oMbt> zLaj=`BpH7+E^@0^6dKxKxW(rZ`PW+V+CpMf>uMih7Jf>}KW3RV_rp*Na zR_FcRx(TMX1z{coprCbMvW%V!`ofid>kP0y($uxq4Qie#wcOk(&ipB=3=>5xGg=$n zng|-=Ek=H(hTUb;#^t+50u6e>NK|(C3@9bTRW!1zXLj2QWnUit?axhGs_^b`+aZp3 zlcH!sNfmy7r&Her#*u*mQ^MXK!0MJc#GyXkM9xiZwGYSB`o=|Er|=B9;^BK0Iy0YK z+ieY7y7(72Qu|Fg+6MnUeoAl?MQ@?G986??UDi*2+RDKblpKb3byA~X2&-hd5Bg&U zZQBSxD;!gO5*QPEBQ2QRC04$YllA0Y=U!sbkFyObeF@DO%ArBanMSB#p7lenB1;}` zH3Uk{7aOUt#(>+RytJQ!=+6oa`QYiB?(vj?*bk4;hnt))Q6&sj(gKB5~#o1+3^(y_s zUdWAy;pEzX$p7Wb@Bto4G4;cfM}#Bl#HJf~$?}&gFCM}KS;Lzp3szQJ@llUv*)-s| zh=HE#6ju^=>&o~5UR>6`N?!A+axAMEu)xL;F4V(@m?NYm86z_$8PBwREO`-YAQO>z z)4+Xk`kOroCf^AiOYYY4+bqZ$NHMFQwifc7@SDe88Wswc>&mx!cD`ATuctj$It5e6 z32NnSV!0&)M^n(Z=jrX8zXr{H60$NW0Z-6PmBfUlMLVY~-}ILv4`-$dM5VP(?P4WB z@mQjyF~DnFYni2C8)eW_2b*R}#J9MV&q==*3KLcGhL;hk;#yEJy$0{NxNsrD*Sre0 zL(*YFtwlHJMTd>~68_8V{t}1Uu?(mdzxO*_GC)V$Fn%VrdV&bv7cUrG*C^! zci2^UiUHQxB_f9kIwuth5NthWoANfV*tH@dqo4YtnmYXQc&RsHxtzi5;?u2bTJ0CR zpl;ePqrl=FP8p0hxN$T={8>rbZ_a2?mv9j6T#>oa0@6sdsG6C0DO=Gy<;7KxVwpX)@%oR?y3FhoiAVdQ`Xat zTfIvvx<=5Jxw)?p>`AD6>*I&8(4qKGS*0x9Pgf6ucOcwU`uG#YJGq(K#C8B%t zKvvkpl%WABA31BU`)o&plV{7*lraqDy|PwcvBG3O8Lm>f3o6-F;1Qs(9=zo?b9g8u zCMIXMZ)+^%Y7Yp7q$aQm>=LO$8lpWI!)CMxHZS@Vb4&GHuhv)gtib7e8LNzuir~_i zKV8Go8R`rZpriP2nM`LuFihyPH@qFv{@Undb#}YGh`fU5Qay8<5LyCr@}C05&Bzd) z?%~{(P3l7US!tkMXQ=xWkGlUZhIZ*vYoT&;t!;O9@jZ8LFd)b?*K(e)u`Rz|G&#!f6WNs&9lPmFp4J`5= zcI7fc{hf^Q(}>!UtFc=EidQqjos2j&&T zlE2CDi2Lk8Jv868&U|o&Y~T{rAPGI zY+wslqAw`y3h0ZjIZ3Vo@6|bcGk2E0)%K5{py(xSXYi<;cXj2zDL$Y%i6&Fy1{n(@ z!ow{^kF#|lf*=7H1v#UUGKw-}yO~=a_Jb?qE9#VQY38^+)Lii4rC*|*t0Sp;vaTdC z=JMJ7E+2g)c6}zHt!DO;*XE`u+agb&h;9DTPbnI%EbUZ{sip>JmE`HBJI^Z04)>jG z7v&MBY}f`aqiv99GfDN#&#q89HzZ@Jkn?e}Xqd303AV()H=9_%FOT|-LLY@1*UOS( zVsY4c?ZO^qDeu}idUas$=1(@+8%IoV-M^twP&~IT*~@$$%GaC2VQBmVszBWQ==^iycY^92kUEE4mmMyw3Zg#hAvx?k^6q2t3GU`U6w}tL^)Wa zv-L(x?5k3u<`rwW-LNM(r_5q58S1bXLG*HPQn>LQe2hFtMy{%^orDJ+=sY;Tw|PVn ze(2XgI=BFmgn)YCeKPe=ta3T0b$C?dkL`Y!J8pye){9Z;E9f=?bcc8JWBoI3G9-_z zHql^QfB198Eq5mIsGGFNK(^*yjkOd99F&Y%wP(HFAtLnOHZuaE$*?z4`+k z8g`?Lt2WibiSnlio| z8Y*wQWJl)>FsXg6cR5V56E?)X$j1i-sP^Y12OGQ2!QzjR&&`Z4L{>FQ@L`0aO%cLn z4ac}pWQ->Zk$W9X(s~AnQkHZ^69DKbrb)pDz?qG!5`W;TuRf7+Mv(-}^H;Y2f@YIU zoQIKDHWGz!NUl&r7qUd|Q*Tgfr)?yi)c#ls{^hlEm(1llgSE1=9Q{)g%wVc7zUvv^ z>Yz)Zrs0+}{n1-L=~t@6>&i#|N3BH2!UyStn+JYq*&zMwcyMk_{a3E9L4xzcaWWM( zi`DBPWu=nTq6Gl#&bnH+%QU6$=X7MOXEjRPIsG}_=m)=Oe->OUoh{;P95oEGWLdhT zmH@NFzky-?UKfJc^e{|t1%A%$8B}UTg_+1y{cE2oUoa?F@m($P{g}W*rT2G)N`ap{ z(Z#t2e54#4H}6Rkn(xoTEmYwONt@6$V>E}ejo;VN-P_S)PEa17?}|z{MjD#0R`hdk+3;6Rp6PLyhEmHhG()rT_9V zwsY~2y;hWkhE=mcePmM?y@k4DM*Lj@EDh8wAxF(~w{I?*OI3sCAjsc(X>4cxti zJU1M{PmwLd3r~h4(Wcyuv31U|gmT;#IkTZhR+1N(K@@cF8U9?;a*=9m$YNWu=-zIS&l`I*!GvXCUoSNTX&p1uzM;| zyheBXcNO||1dRa%fqkHHH1gMO5e%f#n^KXppO@J^8d)Gomt% z4UPRzjahUR;G^ddC{VZ3F`Z3`9mTF$KHbZaH%kg@NRrjQzLC<&3S+3ZRza@>mc80O zc&xb5Z_k-IPg86v3??Rb{ZWKwv(u4NOBSP;IZI#N&;YvuZ5Q*s`Ia)&VQZlPAwg#% zND~!{-YujpJGW*XDR)S5_9%|S!n?*5o_q#}1j^n?0BA81I*q>6lj_s!R5f$qg->}D z`f8TD36}M_L0&Y$&>$}Q6{XGWvW7gHSph8_QdrG!Olr9p91ERX@S0m9e0zK%>Xq!4>Eml&Rpz_)7u52Ug0j;?U#i*7 z{LYP&^p=6&P0zc-WzDhgYX`=&wOHVkvR|L)zRyMDO^7saNVT*l;D?hz91T*4XL^5G zzv#R~x6$7PW9A_oq^~GmDcw&{kkX&N81{cS6r`y%-pNM|(+OzL&*#JurXf4+jlaQS zWh;`h$!zPzUH39NEQ$EFaUFCQnp4et%CR)reC@`qL^y^wU_wC)mQ`!SV}?6#t2(*cSl`U{Vr@dFYT>z$`F*r2 zck2WTQdkh#_dLghl9E1;Y})BuMs6Nw(KU9jkyV7jCS0ZfL-zE$@AG`+)(;jVba<=94LZ%^kxQSFH!y)oEw;aT6Bn9}P*1s2*-zxqNvXk+{-|KAsIybh zX?ji_*Plo~1#!Arp*lGeAv~c(?VM_6L||dFS5zx;H24D+wb(%mecaCH`=t`ibv>@# z)_hJI&G(UFwA4TU4BDR~dCulUVh5OY%|;tfj})tnJQYY$CsNcOz2(1~ z1IK^!xN(tyTGe(e4UyW%PD<{+Z{D32uQ{AYMH&Zr8+sEA-^nTm=(bQ}mIy1Mp=9d0 zk(kQz-eWa^pbkbGK7TL1c}7LtI-AF|&{|sl+{p~Tk-}gw%ajb;Hx{*v#{+Lfb`_#e z8?}6Wrg6YMUvZf@t2;4%zPc;r+R)dZz`vc!trL#;WRrI6d3l zAF%G(8?anCLHYYq-bX(By`z2YCsX(*mjD#=amYo4-`oe=LV*%(1R}}5@c$HTBEz3o zqJNtg&OXwPj?nAMSrCP(!QF3D%nf2S))N*D7RPnDBGjvbPcYiu>UH)+VEtrY30YiP zFXMhx?2XI}EvrKU*z6{$Hrd)1aw5t1_QjNkoo7Yv0t!92k1^x01~EwmT1BpVxVpD zEAzku?#Ub+@4wMLC7H&KXk4ycWC>T7DRW+iT{3ya9o63@Vt;041vvJ0DXuyZ0e9Ozv$RM zfO&liuq|@D!8tx28##&N7mlHUaeQc{=!}bDb?R(ofq;F{Pg6z&^Xhf*35jr<1va)be@+VMsgHyuR>*r zhYIXX!Ml32OR7H5Bg2eAByK|ixdQK8#>sR!rL53?h|rICI5xhD{?BwHUmcV6vBxH! zm>j!)VoXr#oX%WrAS%4=Z%icRH41@7`vs|ZXzz?QzX=aHU6;~-QpoH{F8YWe^9#Di zlP&$SM@2a#hu9v;>BhaEG_W-KF7X_qvYt6l4bhK^z~;P9Dv@aI_I2|0?laEs=x-;? zO+F_&b9nYNR&U0fM#Ds(iIPT$As*X5`70tR=|h22AhDD!OnFD zdgck;%uxJP>RQ@)&#K;e1)IL1Gad#$m{Xx2o|<$>js&&>mFa!^CUfG8+Zqe%QL>Sy z+r`2#kJ)i!b`tS`DR1DttDpZ~!V>wME3vGH#%x$0Gix zi+bpn)dcb`PxO@46k43=PAaD(qYk^R+1pGZ1PQV=4D-5F(IOK2j~8wo^#Y&kV}m`l zD0wNlGYvv&p54T1Td%$EF1a|8s|6jegSev#EpLpDEaX&vV4#re-fP^W(Dy%;a811; znPvtG&Ht&k+Fv$wFxyJX)aEt{uc3igcOKXjfW(3VT09bvo*wK`7NHRzzKLgf@z<}q zz;5!{!S-lm7o7#lx1NSu=;KrQ=)o}zTQ}vOO$+dIm**oFx2G}nIkA6UCzSJz3_I_m zx-u^PDg~t`Z4JBcBqsPB@m!Zu!OdYOhO*s5=#)k8b0zN^Eh3EL)~*fWMiV*n6Oy!f zRG&b}&BZd7M6MzgsX2O`s!SB0yZ9`AH2;QGH>db1M|eTw%hNtSqhI_>w=q|G(~o=2 z4~S3B5kx3+NMTKM3IM&EgRL;CB8V5^)Cq$bRMYqF#4bb z3}mY%Kd}JW${Yyh*LtBFPl5*H3P;8GCfJr>moW)xIM> zDn$eW%rl)v@8(zhcJ@!Mf9s0hR@>dHBhx9wh*j0^+A3r- z_;O`xd0V-~9Ke9rg<}sWItJ6Q^P~HC!K*aUIFAw15vE69=n^)>BV~P?Xw>1xY_?^j zHh5x9T*kH@h2t&rFN3{COJYVxQx)q0bpjrV?* z@uOR=qR%UDn)!MBi$NWa$sXIn#^k|0=#}x|Z7F7Yi$=cXQj~^@_oMI15teheJ1}*Y zH5$;lBfETChI(~08l_7x1{Zr)&9}hji?J6gZCOkx*sFo~i$RR#GpiaM*=H#vVWAS5 z@YDiUt63!sv)YT8whF}EVEyc+=@Ajgy7EBO#?5YSx?R>L_Qtw14&R*J%Qy)URC;dO z4P{O!H7Fj)oApTioF)!)&dj~+Egj(Z5C(sXQ6fqYQRcEjv~%+bZEG-1~{9 zbgXS>Rno=*7`=16r4u0jInkX^lijPEN6fVI^FJ7vW~i2b+C-&&SMhNQ=hzarAxjyCODN`LxTCUwKt(yWIA1C+%_d+!#` zc#eVPT#y84#@q}3oWE<9dOQ8O8uG(*$tNG1q)s!c_vC7vS>`7DH(zB7*Ncwe zX6Id;jLwbc1wLoB@vGCvmz3#;Sl(deG87-=FH!9cKmodSfa1XkgA+47q;6=*;X0Op zipyn>_JBh%0<0RS7xDDMlw1@aYN^Y*Q7kVi=y3S+n*$=oy8fR2864$uydQ1RFAo%5 z(;R}nTb?eS8VOW{X2YxKN^HPbUu>Fq$x!EiRcu3TU0lr}`s@MX1Yr_B8L0=RLD+V1 z%E>j1y@aZOzo<-u(9?d+Ll(uAk(Bu4=%7&kpf1nm74Z~9D>aIfEJI|$ZO#+>`X#mhG4+2Lnuih>Q+ zbJb04uyn~mAOmO({KISL`7ccs^`s;2h}R`?XrobOtZ1kPqd8^mH&L;UzFs4BNfWyg zKg{-K_S%_FxTqFfO0j;&Dh^1X8YSvQ-^HU?KU}8ZLw%%_Idx&?MOG|6g%0(N+DwA# z;U=Ius|{F!MMKDx6Ffbj^LAD;JN1t(zjZC*!5M7VQ;DwEkRIROhAgyI@lP16Jh!ON zVEVlk=?8y7JP3ocEH7}_P+1U}Qua~d+56d~x&X1{Q; zi~6_Uj!0WbBsQhY)fmETFxp5J6eE_-yCO}3)2oGf!7feOCw`M-L%xHxs)!#rF!&1W z)QMkH@Tc{Mp>PjIzBg+iuI`R(KI|T&pn&*EBz{lJgksl4?G_f_2+!h;P}nt2JMb`q->AkMpIj^KG;)G z!TlWSl>br&TfffA%Gj#@TaSHUx^H~TcH2<Db7`gcYd{7r8^Cs;_OT98(uRsoC!?66d~da zD#P4*7L)?TMoLa38dAA~$+mM!M3ANMs8m^pXD&>pw^z8ZrlxHcva{)o=kEL5MzgZV zLQ+9(6lzlfxutBp8Q|AQdjITkeb1LWn5!0#bIPk0v*7RY7$GgJz8;`JPeha^vlxCg zmB@?p)L(WP;xmrsQ3{T>+j~;S(ol=3M*Rm849yt@ioTt5nP**$OKqmL*`26ZANf*3W59;f9_|C*ATw^+QS(Plru<9Y(1% zTrl$i^9Ci>X=ChYcPysy_@cl&8HI^B1d(wWQ>OCHT2S8TK5{LvF@_xaBkw_~Z?e-_ zY=YLT!lb2ECJ=6~58acDGncn>JWmBmuF~t4uk!P^erfR|K6~c)D87*6+_&$F-%!z| zRI1;D-yAGl!bX#`^NUlx~|#Swr$(CjgD<6 zJ5D<6*zDN0(Q(JNZQDG#`?;?7H=O->eVJ>|nzP0jRkhCjLBEe{V)}vCMdyL2E8|kk zKV)sgeE?m{(_YIfb`ov7UG7jWB6-M#f`0fPmuYWMdJgNIChJ5@KK|{N4a_?Pvb- z1|K5>3Ow@p`H1C6$L$It3tDbx2G^wV5rI-}Jw5T+%V~;;oNjg;H6U&0yiKxxZfm>l z1{R7%35BWDJdjsgl-@qP zLqbAxFy}e1@F=tsll|lhx`ZsQjV1LE-8yKJ#4c+m|g@ zW!j&lf=L{mxyKhV1|O>^t+|(9_|i-h!ca==4y}etSk8}>BULL9`V*P#(wje%M636z zGrXAJ>fV(95?Wi3fk}nqJBZDU9eZ3pa>~TK*r}9yDXsnr&4MFaYfMXC801$kP%Q9T z{*jO_zHl1a0x9xB%7MUtrEbySSDHw#06!K;rENBS)5ka|)BP9!$^rZd?YR-G;@j#5e2b{Kxto z&;9CuKU~E`{!;srJ`4+nQ*t>G52L?Wo|%l@njcqHQ5DavOsQ^ixq;Vx%!ZQZ2_^%# zk-)geIVBm=b<1!4=rq9IWWgcy0x3fmP#As3t;TswO>;gF)h$wy;v3;%@(?_WsW$LC zNT}9Ls0S{XMt4+E200LZ)%(=b->TepaOmH=L$0Qytojz2c226aU=+J6!zi0`KtE<; z9_|knaa~_y(;2kJ9S&ls#n#>7*}~?XB;f%N+%zGzrF{aFOKKErjH6CzGeb9^!$ZJX0=@dSWVpsB%-5hV4 zv7l6&NE!mak`-7!=I_#OuQzOg8+X;}cYXyAY{ScPYita-lv*O`WN2&oS#G)Re7t_1 zF}6pJS%m#}cSxA!2>i!fQ~KskG2Nmz61WBA1mF)$yhtYngWv088BJ&Xj)@Ss_le|K z6*v5MY%jDQ?wcv@(*3QmHmGA?G>&2Le=d{>ew=ke&W|2yA@YeXQqdKbNrY{FPS(^s z(OVUou9~^oq^i6fBy_|7xPMmEtkQ{Q_wwtIiJ5%FfQso8^c6fsB#=JSx!Qf1n}`ww z@M!uRzbn?|LfBCcutY{|(O{l$1t&Ha$xY_$vXYCAU`Qbn^^v%<{# z-r7PP)N^<=?Pn=6P*_dy(V$)LWAa%onMd%)^RYN%#6vm5#o&ZUI!zEIHjj+Wg3fzY zO&Of!A6=d0v<;OglJMJ_@}DZ?gs?Q-b&RF=(kcy;OmpJ$s(9nKKGC)O3@E01$JfCl&62| z5rA(8y})X<0kC8C{LPHDaTbCkJ_fOzH}l#Kh$7yo;9*nf_STm_E$Ayf&l9!|2!3Yo z>`6Gk4_MqRMmiYf8FAFeQsGy5prPxr&)hK|c74LIaG-pIjUm%^gSgeXicJneodWO$ zvTzNqw>Da{l+h0iF)I$Jcz#f~;}EuAUN+Gl`QEQb5y|A@jUz}Pr1jrJ7f4ySNUcdE zBd|1_1hoX!h4Qe(N6PYn+XR#PKjcb0cDt%?+;Pn4iKm7y$V8zpVr{>@Xm*@upGLnRm6O%vT_2C?E zlt+DQNLn~Y!i!Sn^6Ryt#lnW;s%Y~Lf2ViZm>Y~QLIy_i2ZvzR`n1X?-7I&X5Y0-4 zunvzEEF2lChGiBjq24{E+v`Q+27vE#aU!V*zwi|N1dXT1f_E7Hd;$`6>eJ+nMS%tu zom~Y;BQMcMdSW)`sG{@i*!z`XP;C1Br*Va5;*U?@-c@}#?B&>)qipgVR$-_@JCkMV zK|QW#bC=uk22|K?)yQGpm9c@%BL6_=rXe27Y&kgeZ&c3H-4Bod^tjc;P08X|PLoKArztsdd zoptqF++c&zef0wKqN4*vq5p22-%gvJ-^XPv>%1Rc446UJHoe+t1v7wAnn*=sG|4G3 zufwP1q6mzBL9Xzj2{-jg;1 zKZ1}z`VHD*_G`0gIOw(Ds|iegI51r%oWWK^$gpR5wCZo@)?`rTHYQPIv_E*R`)$jB- zef16w1*1tVE-}6Yw&@?d54D3$P43V;R!E+1i}vVoW1`}<2dgtnSuG@q9Lu&VIn7`7 zkz@LQ|Lg0U>{M!bo9Wh|7gaR3*nvH*|A$cQ(vDr2+wwp&QE4Wjt((1Cl6XWrDk(N~ z7GZmBZM{XW5tE9sPvv||UOMmyL@|u!YP)BN(F9e#p=;65ep}k5m^hS7zKAIy&`K^Y z^PMq+RZph9{-WZ}j$g1XQx_j5Y)vt8b+Qt5_EwW%eqkx3BC_4)KkuH%?jvHuBt_KA zT5hq(;mH!HRYuU7?XG@sg4H4e2IowTYc|jE`F_g$Oy(Qe!{j}!qJg36iWt?kS(#(( z8q7kM{s@W7UdwKjH|>gppec$Nf*@bgqg4=}Xx=6rsW-<-nb?6mTYT)CPn8VIKSF|e zj0B+JJnqe;805U&A?o{JS2fxniP#@))-8VLJK_ARL?9HiJ2VI3%cvItNz^Z5bz21I z_N8A~!C-3@)7rLFwDcKbd;wKHjSj{niGNkKV!sv$`Qui&oP(^ex*Zp`pqXl!nrF<$~phHiMhn09CeRvAhb8(B#&a+CgB6p8*xH z;ec_@J4jpWJ<`AGzHV{x`_d%e{h<)Uf4oFVDzq<5V@R7@Jm;fJZbM8Kb4pB*_`Li) z*A-e&{WFQshQsnSMoYn`H&826=?eS8)nY=4m%ib0v?L|Wf7!ALIkCBX-tTEcMeYhH zDP8%~3NykMH@H*$&ez?%D7XWRb)V@H>!5N5)Ptc*XRH?u%m-KvYOYtP|oTl014Ez1ut zYJ5`EAGA01aHbBqaQrDinhv7Q{%AOjqNJ@%N7pr0edh^v@2(NUt;j#=pOnV9D(54h ztNRH4Z%(*0FY?kOQsANE*p8f;wlM2xyCZtH2 zPijt6q7jAAkq$(nkk>XqNkR?HBZFW87e3n2rihRzhhnl)g_mlN7S1Fi1b!Sj4x z-+)F)uk|K+QSiMs;D2kghJah9-3w`A%RcN8WS{q=t49hL=mJpnE}0j!G#Q7I60(!1 z(8-&NA{<}oef~KPQHL$?wRm56M0}_;XW4`%37xT#Pa3dkFs~R@ZH0yi(tau}?J<|A`R5EI8tZy@~)U^E6)!!2p>Uawv_OIfE;ia~FLe zJ6|C+s-1>8tV= ztXNnAzY!{ggFd$($jXb2K&lD*Jl@uS1)EmN9lOwCspS&EGff zDO=9NA3ASq^XDzr1xx?QD>tWk#A*!rod1{FU=K@RnBSt)Q-g?%lKQL!c(y4_ti_tH zI9>Kx1@FB#?$75nP~0x}H8$ji*Fw!|+u>YrG(AnH!Z-~I^Ly-NjLHXxpx(rG`X z$YHP~`@t`zWB-V)X_7RJeu#4$u5eCbb8#9Cyl#m?OpqX;UjwePBVf0Tq@|NOUhAcg zj@e(U=`OY5^l5LvO&Rk#c?oxx!_4iiPwWHHpk;JWzQA+Lczn^BtpIO`MG0U~XFS#2 zV0pGX+web}c%2;lSM)@nRGge)1-xd3yejUHuA`DbrWjB%-#OCQf3Ygm)=C{pF{!~+ zB~q=D!~7x6$FOxxFlLE1D*!7OiZ(0}Qibz+!u>t*GFC5KV>qS)gii^ta!i#@XvHm6 zRoiccF_f%fgfLrJ3x_!iJ9JYg6>f4UxDf9BAkwEe8^Qohu7adkq(q;=0Hzlc6cDgm zQP>0F6=;mkRf z|7`&Im&i5PbMy9%9#QLvg&7nh@)xVdSOIsqCd6HRhC6W%FCO}f!gXaEGIxTDyUMpQMY-e=paTv z;zCh~3WfBc=9P#$szB=PpfTuwL=By7>@mwy&j7M+PhocP?R=ccitBwpFixGB>e+{$`;W>ZASmI4@b- z7Q#lb0Tu947Y|!loOLi`L}#fBR<*`SYR| zCcCdEp~$1zzW3$@_*#;r(x5i(f>vWY%ZG`^P^uO`LzAE*)@th&qg-kDs8{n$c$i{* z9wG{7SVsEpal&Js$CfrW?*v>n5I$QUa=UCLY2RyU(vjJAPnWH3^F6AfGJJ{&XSK=n8RKqEMF`5sN5};7+eIinno1cO zu6l+NcSqshWM4xowOgUV5F#k?frut$b*)}A$pvL)c-f&4uD>=W7I{&84oM-{thp%< zq7cTN-2M(3(jWmUo1n(uxH~ubw{;8mZaP_Oql~<7ZyS(Atk6n$b38HPCrCtz9r5ti z1~H*>y*s&L8ph^Jg|L84p8%#a7RSFaA{2>$=+_{)xb$>->guZKv^gTo{Kp4s6RFwI zfX|~Uz=jKXMh;=J*i;6_SJbT#RUQQGw0yJ_5T8Zh2jQX+))x83=8T zIMsm6W)3Wfq)eenff-7YSO-}7SOqF|vDhmd4F1bQhRv*7=_D@P$%%(%SG^h=P7%7i z^zpSg$W?N1qh&`Mx)u&~W219}xZbDizxJrdSsvumXsbkZat!lFQBB8^!kbvHlEWDR zo+#vzDg~nq(R-h)ziKJ&qoR+G3Ki5?e}!2*3k9DqWz3oGtgG|>unwXOgM5^OFR)-x zOs?}iGS^137TV)tov@P;_|T> zv7PKy9;8b^FGWrp9QVrVp$YhEK2vxZ00SjRYM!ZsWd}irvj~kp6bb z4~eBY{RJnu%qjWV|FfTq5T4#WY3($Dc?m2Wpz*f3`@NOxv!m(MZ>Fxbq8Wh+SU~~F z)x^H4Wo{2X{60wj>R^k`Ct}evb%w4djUhxm!+LSCsrYGXuERLap(IM2i3Wx0ydfjH z^Na>OivcyDitL+alGIaZl3(#WLo0mq1l>D7)jSJ z@9rTHom7p}et!0ihg*YKCHRC$!mVRG08(ECX(YVG0?hL5n|H<9<;O?~LB(Ou305M7 z2}L4dxAIM--jp~r1f1W}iu+b$snt3vt*O05&Y{3ho`OAJ_FYVm#dSo{O#Y^Yz9$AbBgO%6aByc?28N*s_FxvjRb$M z7z{tei{HhR*XVA*HQrK*4eU{F+YXkA-Ewzxm`LR_Y|iN$rd^t6>1>eUX8A1f&?& zAg?f|^6BD~;xYUYngNQ=vI}e1p*it~uV22Erj96RT(RR;f)^5kl0sp&F5bwdA@mVr zqhc%zI^I+gHPT8_lUUA#(-U}oCUw|o#^%F@0uXL7Jcz4<2Lrdk?Xzyf2b!Y=ckud2 z%1lQdT|JyW1AOItVw!S4w^h3d5FqV=1@3ltzK5OQ|KJ?`rdOvqxKQ}ZLCD#rOH9jQ z2)nw}ABYtu5BM(vu0ux=mmM`_XvA|ImJAvkrMPqrR82^+aaY@6&gB%-ZDW60+w(_= zz>QwlV8d4O+7IEXaR(D`~ikn-C0^lcRF@)YvgTP+Y<=?`L)wM=gz z%Kha6QUh~y0Oz{{Y%Wdf`y)JM-4Yi3#tFHC>QS!0pZQ4*(6sz}NhSyew~y2zoZ%3r zrurfUlPo~4dYaB-Au#!jZ-IQO(su2AmsfLK*JZJ##`0yA(J%S)fz*%D`+P_9xwDIZ=7a%-PtJQjANj^RW^lpZn$ma(zBcHDhsUaDw`{5~r=$V)iaJX+ zO5p1SLQP)piJuM1h*hrc_ma2n*5T!!b&`Vd8^tG?h2Nv2)wN^gHMN-6L94s;v&A%H zG5`6N%OBmYcyco(;#cD!J8nuRuhW5|y}XWwzvY=db5@q?oK59~6oY*Lsd~EA>swXC;AVpNw=@17$d-r5p+co_Uwb>sdDS8wxvdWw>Q~l8YiGWv? zRUbFE7djg^(@NLy9k6XOJvM6jTyRygBCeJX7nkeDG=e<$1a<+2=`m^!pMYB@Nm$ZnlG>6owirK}ic9RkVZ zHCqnDQkR_jqyO#t3_ZcLYadl*#_~o~&O@Ol?lvUIa(@TMhVwPW;j+hqBjkxwYkgN* zV?ACS$GFB2SAzOZoJiFg?`jjo6QH?$h!!#{Q!uH3%)`JyU^ggb`h7|JzW1<06$nF` zDA4nl{{vB#(APozHpHFtt;^^KjRZ4~8oE;FbaO(^=e;-QI6j)vX51%>N?FueR^Nfk z(7!I9&uwQXrw328vdUt+Q{~-#aSPTVJxn+f(Og(lwtyfaycO4Ydds{sT#%F}_JJ93 zv+EDF z3v-Mmmmg!S&*kxxmoqjBbI=@iCaqJURaSqhP-TP$ii@i`;t0L^t`@5Ua{Wr6%w3dJ z5X{PwQw5m3A1@?h+aZ8|r$nInh;YI|i;(Z3orZ;|s|==Sc60mA3Xd(>GIloE@Inl* z>xhPWpj1r}OMcRDTrK=nwX3V{1@$)a6KTTxj^qBPaQJ}9b>pPSI98r~x1{}^HebURPEU2BC?k&Hp0)Zr?t|TdwVM!61 z1?ijmcpgDAtOZiR8l<_Lg!^mAnZ@6I$3`dfiI7j`bg0|d!sjoW!%WX5_zbj7_O1RJ zV9voHwJxPUn?cl9Pw?~pbu0>-Ew{F2gJ9xzT>I^;rphdM>W>T0{CJQt7ao^*8&~^q z8|_-!7W>JADzRG|dkcl*rtisQ^l5)o;nznpTEDIg6fTnmJL=V+hY5$~&il|a35Cok zJKm1F)yS{DO;#zjb_$Tw4E0^KMt*Ql4!BrzaRpEZ(3)~w~v%{xm zGjjvKi~{X2#I%JfOSG%$&-;%9MXje)Nu_xz)=QtYZk3zb`?5; z4Yw_;!>PqJJ(pDE3qdSYkC&MvCHCkKTsHlYmc)}`)G^Uy196$G+uA<=Ac)>driL7! zm~m*yM4Bog>9qZyu4a36EzyD>ZOK6xKd=GnMM`jd(4YDXsNPv`1*{iC4jp>0W0B-5 zJx+LN;zsw&$Vpf{Fid_gGTIt75||*o8TniLA2y4HZwA{xa;aJ5HZdm_f=>KYxDyny#HLU=mgfzOMF4HoEKVKKA>JMa<#URDgyA zQ^Dv6i?0tEJ<o|v*m)sQf zK()QT@{0hxe|v&iZKo@U8ecbf%|C8&9q3OMV&%^`R2HT)Dnb$WqgQG`#tR z_=8E^F-9lN=98`aUgI9=gH<|?{!t}y0F@?Z(H@lcq^hG$`UWB6s+&T zvXfRiO>_Bqr9|UoitnG7xQ&zWcuu#{9znpyIxW|uS?;U_?gk(P7pS-&FnNZu0eM2y zzb;WQGkqyS@ovb0LgrH~oQZ#S^f+d_;&&iskBm4dmn|W={3{@q5C#QE!f~^F7!DA3YId6VjJy^zZh- zLkTDZzXn}p@S5c>T9H>(P@&nbfPC7`JK8cmt6EYuJ;Qo^W>v})-UIS{BA99^e<`9sm!5qpjPr(bvp-;WgLKnaE)8(o7SU#$?lWVdrXd8p<&3Y z&K!J|i$8OtPkn?=LtcOn?>Z1enSsJ8m{1X=sGw`~szwbG4d6xdT7qPO*i zCwsm7W}mz&9LY;Gz9FaIEtb%ov>wmTR-_n^qr)`rk^(FQ{)W_xXfG zV_h4Va%7*!*L~A|Z8jCs?66}!0ii|Lnt%KY;qE1g!St)H#G5qJp7QjlNbzmYhW8&yb^+)G49(!BAXi(M#0d6pOo5xUJF=$D`6a=(eBa+vPxHe7(F>=w>^^DQIelokO ztIiyLRk5&Nhku={VG+%*gTc)Y$WUnY1e*IITLEm@JjGzvbS3z?^*n4u&UzT&cOMoAZK@Ent&t- z&Y{{pxK}9)j#+hbLqUrz(Vs$w7O{~n8Ch%Dj9IS@Sk*@daGxGiw%lfP2ZaS^s% zNT18&W(wC8XB{Dj2?5p?;ahwkY%1{eL^nhai;)65E(|GahE5;Vc~C%y)0smEeaK?@ z0sI2ns4#Oopy>^ZkM3K;)#~V1*OxBCrsSd_3s2Zuss>LEUDMyiIP~|e`;NG0SRrt| zfaH4~Y=FnZ{H||2d*WxGKBQEi>k*kDtpwLY7nXlGhlVDTiAK)LBMpfC4LTRZzEc^# z=JTqY1cy8Ef|)5^W9VO$_3`BGBH*Vv=P?Re+s^Nky92-ZhkHlP=AK%sn{xQ6`it8u zKe@WSj&w79j9(qYi~!MRx(qL3(%0(u<-=P7z2FP<6`gKGx?RzGp9 z=$645->%rs2#{+qHD_jYwP*@RoK!}O>FJ;EFV%0B8=Jx9zCK%GqKUS4QRG?adrR_J z96vqknOx+A&~2N<%_t;YxBT`NT%BGjzdL#dez?#g3qm#KAziNzg9(Tflczd2dMh($ zI&EMAdT7Ns?p#yuCm_U6rrwRhvBWM%*~hj5Cmsq5=!2fOh(s2DGoZa{h$?zMU?Np1P|&f=#|H*Q4osp$?Np5824UsjhKR7;eM?y$INl@6vdj81AUq`j zfF%P1|9^VyZ{Ha-L6DdPuv?dT{+9aPKE1_*a+KD&!F8yV z+n9k-2d0^H+sbh$vl!=^^7i42X&&%IGxc}Z-_*3YG7Q{VdE zBYbx{`e29n03!8HFB1*KSMPzwtL#qd%Z!~nAxV%)KB4uepu|aSZoe6AkR7Pht!G(~ zX8EOQf!MJ!$<73iF>baJ8dLS~E)wq{&6+OTk)0tz`TEAp7CI_*W7|!x#`dPV-?pk9 z(qkhK@(JoxT=W+mFY7L*_1HcSSNu+g(NA5ij>rZH*2L3IbN;@e!BuZ^Vln(r z!BaS{3Sq7qPVJzapQ8Mf#$h7OMKF^bVM`NOnSwRDRX(}EC5l*Ii%U>P%|}BIXFN?L z+kfh7QaA5VC&xfflOThsz@f|1V7r}X&UaoRtcHZBA z9KE08P$;JN*!csC0e#UvQoWHwAAr{>k#R-LHqA?7uC|y-r$tF7Lt{i`4R7H{>;l;&W~9<3iwk4zKc$#9iLhI&DA<7jwP# zK-?cwU{qO2j9DlJ6A?tR+8@d(2poWEukyMB3SXHbj8)4+Pe1E=Si5N9y_i2)17P&* zuS(|5zhegeeLu~BD|m0)!Dt6!8*NvpnKxYxy$}81 zSf6pU*)EKdKtb;Hu5n8ZWNiMy_IOna-tq6&<-y_C8}#NalSB?g)8RX1s2AxUw2Ma} zhGt*U_mq-!_E_=u#*pa9lw4`)Sruk=WWmigQ*nqKkg65Y-G>gt`;Z0E%E7V+T0#rJTVzunZ%-RjvJg^e{|ZKIsmy<$()2f z-)8t*^$>XMh^?amH@D_674`4%kyMv=`Rj~#K! zpT#wG-%hH)Z!|IhLE%|VTU!NFEdzJC-`Q2>bOItBz8L9MPrVhB2CVoy;Sy-aM<)DQ zyBX$Y7Q#@7SRI*~gceiC0*H_bnCQ#U(B~%$fx;c}uD#;T)Ol?osdoz6I}$KC?f1$o zBhq0fht9;9y(Th^>{ThKvW;(Jf&mZ|3gL7Sn=g%Rwj&y7IjKUPV(;?899a5nKZ|BmY1pKkPw zCn}Ql3!x~~ja@PXWCZr4BqVY6OnkNG9R9kqI*U-&&}c5`@uEmP_{}Kai!E^1uYQ)N zOFz%fbjM^%)W}(7P;WkvLHl3tWeV{dfx2$JPA~`4^Wu@iRcoWy5OWGInjLe6kJ*+& zM!u6^MPw|s@4*$ZIIGXA_-3F(@e?J}^|a772)&neRE^g4D$+nA?7s1(f2xXHhZM+v z680S(C~iID*yMOw5AA*UxxOlUVQY8&>I=*P;RYtx;T*?hx5A4Sr6@S1iBLK|Jtx7Y zH+=kO9)i#~FBS{>dcrKT!rYK|@WxuM=2P6FTl8c-`y>fGLUQMk=? zwLdVbn%G9u!wG>*p&N6^*uJC3VsRBY74%v8c6pP2w^^L1Nq`NeMJcZrvm8*iPKyeC zn9^dFGh}|(6rgb?fD7jB*|l~QHhyH+@58=Wss?h95C6GKnSQDbDuX-?FrOf{4O{6e$ApaMPlFqK{Q_>sgv9N;{VM(cts5%UZ{u zO0LeWvbb8|>@Avkxl9qfIlV~BG2`4*c3-?691*Pz)N~HbURaE8RE{9% zlH-tE^Z$8|kpbt0p(|USUYdlMF^hg86R={2=n;y4vk-GAQb>~}vMaN(9AI#k zm>ApjxEv|V(#F?b?bI)KhE`H%3;6RhuHPzn!bB7f;e^e z9wspzxy6wVB2Ud!d7=38h1Mc|xGkLJe?6vFwD6?V+TE-+zPIHwB^Ee`o>;gLM;>kb zhLf~4{vgGi?|e5A+I2P9X2$)H%1IGu#$^z+9N}+_+HHTN>gRvu8RQS{5vNJ{YaC0& zOIu(G`al`4Vf_3!)U}p?A288*9wQ|K1e6yYAMbiK47e9=W*txiL*AM(QN1n_BI0Pt zP8z5yu?i`xvz)+{CF{*EF1cK|3hvc;e+HL(0teWch1qG{K9alBWt-vVk+T0WEV}mG z{&=E(IOjah{+XJ^`cVuz6{QE58dKBI0P(R7$^o*K++|e@6v)~Xj@Ez@Z0P&KbUtqX z{JPliwoN|3hrGVJ>$+;|INF4zFH*9kY+Tn-69RTZ_{}gFfN5%N9A#>6I$7!@E7xI| zf?cu;&$;ni6%{`@7b*f2jLwKEU)OY98|FYIx9G{GyJM(+4#&}$xkM=J=rvwPlqc3`qu48Y%CD&3ebK-z5ZG-(0Y&beh>0R16ckKyV10NCUU z{AE($hP~sy9?T}4zZ+R`A#aUK$tr#Ifcch27yH#erbKT#Wg1&q8&SW|N7cM+GNR z&rS_!t%Q1Yz3SVMS3rx+3R7|t9Ijc1g(NnVVZ3dw{-i>y@gy@&np*NcOSA@J5qjl% zzbxl=$g8*|_su<=F#$zFZILAb7*Y@zHsWJ4Fj*KOsU^ zM1Y{+>nL%vU2jB^jE{Z_ffNH$U}Mej;IV&{BfcP->hZ1Bl`Dx47li^Qr-wR5>RckG zmnzzp5;ts>LxZDP>@X?WXnJ|>*^0%l3Pn*S3g5Jvvpp*s!89r8Ho5}km3hC`h<#7- zaudUZ2#T|nhX!S+fE+mSE!A;?yJ^u7n(J<3p-2wKj{fVu@jjG*Iwo1fu|rW3a89Dl zkc0vWv{Umbeul7KKiZeiQIX%APjsb9JSS8Ssc}k{gdUO-{0yiK}8fpmb=mMf%pQyMnPLE++7HSYLz%fGOyNj83geSr_lv+xv2x zlk3qtZp#EnP`A>oW?FAJL>-1?&jn2d9D7qNPCNpdo?E3B zJb+z>>m4UJ9#(i?LfHvOm}te*@~81y`B9P^x18zQ+XFkvJ&{g|JQfe2q+zN8Nu<|+ z3uz-u&wJ2x)#BnJr=`3}Z_MSi?bZp#5!>J1YI!9r9$D+fN2|_*&xfzccX)iLrRCjZ z#NOaqs{T*z_qcLr_4au>e}uBCqx|vjEFr*Z+LQxK-Cn-d-LtU(=^|%|p}pF5gb*Pr zhX=GhFRPA&dgj+45g89H2$MXVl`cfv4N-N++h)cR=KFn7C$3`&wklHbFnk5j4w%R< zoM7M&A=2{TlG0IS7hE_X>g1}r6#~%4ETL&yBKezWRcYB?ZjszlIxlzOi!<2J1vs&_ zQNLYAozr-k;#Z&0kh$>eW)2U~0D&CH`ec2HnDYMH1Dl)8*&-eDDer5TtLyNw7`7eA zG^p*#D&JF{?U{gF2BfpV7RX6y^1mU9?RmFGmN;=ErX{xCv;JW~0|f9Im#^yftnqok z(2z{Ucn^dfH|rB+?W$*KOssh$8eU%gbZ8(6h3Mg1fG2sPtz{9?)IwlPQ{o3JJ92Cy+QA zne_AZGQ69wN4ZN2oMq0S27@ZW zl`037`Ti26@6Yvzo=XgK-0%2@gqZIP*mT(uX`?s4b?u2bntO~qr%#7m znh+fvQKC+EB3DyNNtfIG=)y-5H4zH1DS^r_d{@OXeAsf6(B>N1Aplu4P(Czl`&Ouu zGV(h(xGzC(KFRN&U)ZA86-g?NJb2d_soRkgIc%CdXBL?41q}!`;hiFoUVShsKkd?# zvv4jR2uk!39ifO)z!G4FIZdKz4ZPhHY&LFJzzGaAK*`y#()~+n zK`tJ2p6;(cEf+KEPG~>W@vn+uk)#1SNH0KOaVH>Zd@ZPK;KM&2nOlK&AW$w)E= zl5`F3FGk{Bm>|RhUZ^6(mv&*ia|fKRy6YiPGzPhQXG6KSxubrg+?(RsL^2ap=qNG= zh9((!&p%M6obN)E6gUeoEeu9eu*^1&Vsl@>$6M83s% z9}ZRzA617#7b$|zv5dLo`Pt(hZlW`yzFNFo>`EAu!&6wY`-3&TBgl}u!?E0fa3w3% z1~|^yL#b49`s0xF26>9_%{rI$)7tFWbV8i9c%oF#x3!(Crc!&(tPCYxmIezbDZZ|+ zT*zT{Yq{0^vj6sicB%5!BkXd6smUBhqc8T8yoibItntJk|B4iXc*dP9uIh9a9Si7V zV*$&=6v6s{%j3Ci&4BgiU0}&>3bZHXV_1h8E}jg?AyGVCwb0R|=aqZEn`Gi&^NpZE z^f%;a1W7cn$Df_BdOuaArSe1(F+`u9M14g`Y4Be;{PvHV2Vis1Wm6fCDRs4LX@Mo> zdgp;{;>w;%qt1UCPr_et3Ve{!Y$yX7-ANF7WMm6jP$Ci)?)`)uVOf!pSFpeINJ&U^ zOps8J#vjK;J)UaRsqz5yQa$2bqkT3;+NC literal 0 HcmV?d00001 diff --git a/node_modules/@actions/http-client/auth.d.ts b/node_modules/@actions/http-client/auth.d.ts new file mode 100644 index 0000000..1094189 --- /dev/null +++ b/node_modules/@actions/http-client/auth.d.ts @@ -0,0 +1,23 @@ +import ifm = require('./interfaces'); +export declare class BasicCredentialHandler implements ifm.IRequestHandler { + username: string; + password: string; + constructor(username: string, password: string); + prepareRequest(options: any): void; + canHandleAuthentication(response: ifm.IHttpClientResponse): boolean; + handleAuthentication(httpClient: ifm.IHttpClient, requestInfo: ifm.IRequestInfo, objs: any): Promise; +} +export declare class BearerCredentialHandler implements ifm.IRequestHandler { + token: string; + constructor(token: string); + prepareRequest(options: any): void; + canHandleAuthentication(response: ifm.IHttpClientResponse): boolean; + handleAuthentication(httpClient: ifm.IHttpClient, requestInfo: ifm.IRequestInfo, objs: any): Promise; +} +export declare class PersonalAccessTokenCredentialHandler implements ifm.IRequestHandler { + token: string; + constructor(token: string); + prepareRequest(options: any): void; + canHandleAuthentication(response: ifm.IHttpClientResponse): boolean; + handleAuthentication(httpClient: ifm.IHttpClient, requestInfo: ifm.IRequestInfo, objs: any): Promise; +} diff --git a/node_modules/@actions/http-client/auth.js b/node_modules/@actions/http-client/auth.js new file mode 100644 index 0000000..67a58aa --- /dev/null +++ b/node_modules/@actions/http-client/auth.js @@ -0,0 +1,58 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +class BasicCredentialHandler { + constructor(username, password) { + this.username = username; + this.password = password; + } + prepareRequest(options) { + options.headers['Authorization'] = + 'Basic ' + + Buffer.from(this.username + ':' + this.password).toString('base64'); + } + // This handler cannot handle 401 + canHandleAuthentication(response) { + return false; + } + handleAuthentication(httpClient, requestInfo, objs) { + return null; + } +} +exports.BasicCredentialHandler = BasicCredentialHandler; +class BearerCredentialHandler { + constructor(token) { + this.token = token; + } + // currently implements pre-authorization + // TODO: support preAuth = false where it hooks on 401 + prepareRequest(options) { + options.headers['Authorization'] = 'Bearer ' + this.token; + } + // This handler cannot handle 401 + canHandleAuthentication(response) { + return false; + } + handleAuthentication(httpClient, requestInfo, objs) { + return null; + } +} +exports.BearerCredentialHandler = BearerCredentialHandler; +class PersonalAccessTokenCredentialHandler { + constructor(token) { + this.token = token; + } + // currently implements pre-authorization + // TODO: support preAuth = false where it hooks on 401 + prepareRequest(options) { + options.headers['Authorization'] = + 'Basic ' + Buffer.from('PAT:' + this.token).toString('base64'); + } + // This handler cannot handle 401 + canHandleAuthentication(response) { + return false; + } + handleAuthentication(httpClient, requestInfo, objs) { + return null; + } +} +exports.PersonalAccessTokenCredentialHandler = PersonalAccessTokenCredentialHandler; diff --git a/node_modules/@actions/http-client/index.d.ts b/node_modules/@actions/http-client/index.d.ts new file mode 100644 index 0000000..9583dc7 --- /dev/null +++ b/node_modules/@actions/http-client/index.d.ts @@ -0,0 +1,124 @@ +/// +import http = require('http'); +import ifm = require('./interfaces'); +export declare enum HttpCodes { + OK = 200, + MultipleChoices = 300, + MovedPermanently = 301, + ResourceMoved = 302, + SeeOther = 303, + NotModified = 304, + UseProxy = 305, + SwitchProxy = 306, + TemporaryRedirect = 307, + PermanentRedirect = 308, + BadRequest = 400, + Unauthorized = 401, + PaymentRequired = 402, + Forbidden = 403, + NotFound = 404, + MethodNotAllowed = 405, + NotAcceptable = 406, + ProxyAuthenticationRequired = 407, + RequestTimeout = 408, + Conflict = 409, + Gone = 410, + TooManyRequests = 429, + InternalServerError = 500, + NotImplemented = 501, + BadGateway = 502, + ServiceUnavailable = 503, + GatewayTimeout = 504 +} +export declare enum Headers { + Accept = "accept", + ContentType = "content-type" +} +export declare enum MediaTypes { + ApplicationJson = "application/json" +} +/** + * Returns the proxy URL, depending upon the supplied url and proxy environment variables. + * @param serverUrl The server URL where the request will be sent. For example, https://api.github.com + */ +export declare function getProxyUrl(serverUrl: string): string; +export declare class HttpClientError extends Error { + constructor(message: string, statusCode: number); + statusCode: number; + result?: any; +} +export declare class HttpClientResponse implements ifm.IHttpClientResponse { + constructor(message: http.IncomingMessage); + message: http.IncomingMessage; + readBody(): Promise; +} +export declare function isHttps(requestUrl: string): boolean; +export declare class HttpClient { + userAgent: string | undefined; + handlers: ifm.IRequestHandler[]; + requestOptions: ifm.IRequestOptions; + private _ignoreSslError; + private _socketTimeout; + private _allowRedirects; + private _allowRedirectDowngrade; + private _maxRedirects; + private _allowRetries; + private _maxRetries; + private _agent; + private _proxyAgent; + private _keepAlive; + private _disposed; + constructor(userAgent?: string, handlers?: ifm.IRequestHandler[], requestOptions?: ifm.IRequestOptions); + options(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise; + get(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise; + del(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise; + post(requestUrl: string, data: string, additionalHeaders?: ifm.IHeaders): Promise; + patch(requestUrl: string, data: string, additionalHeaders?: ifm.IHeaders): Promise; + put(requestUrl: string, data: string, additionalHeaders?: ifm.IHeaders): Promise; + head(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise; + sendStream(verb: string, requestUrl: string, stream: NodeJS.ReadableStream, additionalHeaders?: ifm.IHeaders): Promise; + /** + * Gets a typed object from an endpoint + * Be aware that not found returns a null. Other errors (4xx, 5xx) reject the promise + */ + getJson(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise>; + postJson(requestUrl: string, obj: any, additionalHeaders?: ifm.IHeaders): Promise>; + putJson(requestUrl: string, obj: any, additionalHeaders?: ifm.IHeaders): Promise>; + patchJson(requestUrl: string, obj: any, additionalHeaders?: ifm.IHeaders): Promise>; + /** + * Makes a raw http request. + * All other methods such as get, post, patch, and request ultimately call this. + * Prefer get, del, post and patch + */ + request(verb: string, requestUrl: string, data: string | NodeJS.ReadableStream, headers: ifm.IHeaders): Promise; + /** + * Needs to be called if keepAlive is set to true in request options. + */ + dispose(): void; + /** + * Raw request. + * @param info + * @param data + */ + requestRaw(info: ifm.IRequestInfo, data: string | NodeJS.ReadableStream): Promise; + /** + * Raw request with callback. + * @param info + * @param data + * @param onResult + */ + requestRawWithCallback(info: ifm.IRequestInfo, data: string | NodeJS.ReadableStream, onResult: (err: any, res: ifm.IHttpClientResponse) => void): void; + /** + * Gets an http agent. This function is useful when you need an http agent that handles + * routing through a proxy server - depending upon the url and proxy environment variables. + * @param serverUrl The server URL where the request will be sent. For example, https://api.github.com + */ + getAgent(serverUrl: string): http.Agent; + private _prepareRequest; + private _mergeHeaders; + private _getExistingOrDefaultHeader; + private _getAgent; + private _performExponentialBackoff; + private static dateTimeDeserializer; + private _processResponse; +} diff --git a/node_modules/@actions/http-client/index.js b/node_modules/@actions/http-client/index.js new file mode 100644 index 0000000..5c54cf8 --- /dev/null +++ b/node_modules/@actions/http-client/index.js @@ -0,0 +1,535 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +const http = require("http"); +const https = require("https"); +const pm = require("./proxy"); +let tunnel; +var HttpCodes; +(function (HttpCodes) { + HttpCodes[HttpCodes["OK"] = 200] = "OK"; + HttpCodes[HttpCodes["MultipleChoices"] = 300] = "MultipleChoices"; + HttpCodes[HttpCodes["MovedPermanently"] = 301] = "MovedPermanently"; + HttpCodes[HttpCodes["ResourceMoved"] = 302] = "ResourceMoved"; + HttpCodes[HttpCodes["SeeOther"] = 303] = "SeeOther"; + HttpCodes[HttpCodes["NotModified"] = 304] = "NotModified"; + HttpCodes[HttpCodes["UseProxy"] = 305] = "UseProxy"; + HttpCodes[HttpCodes["SwitchProxy"] = 306] = "SwitchProxy"; + HttpCodes[HttpCodes["TemporaryRedirect"] = 307] = "TemporaryRedirect"; + HttpCodes[HttpCodes["PermanentRedirect"] = 308] = "PermanentRedirect"; + HttpCodes[HttpCodes["BadRequest"] = 400] = "BadRequest"; + HttpCodes[HttpCodes["Unauthorized"] = 401] = "Unauthorized"; + HttpCodes[HttpCodes["PaymentRequired"] = 402] = "PaymentRequired"; + HttpCodes[HttpCodes["Forbidden"] = 403] = "Forbidden"; + HttpCodes[HttpCodes["NotFound"] = 404] = "NotFound"; + HttpCodes[HttpCodes["MethodNotAllowed"] = 405] = "MethodNotAllowed"; + HttpCodes[HttpCodes["NotAcceptable"] = 406] = "NotAcceptable"; + HttpCodes[HttpCodes["ProxyAuthenticationRequired"] = 407] = "ProxyAuthenticationRequired"; + HttpCodes[HttpCodes["RequestTimeout"] = 408] = "RequestTimeout"; + HttpCodes[HttpCodes["Conflict"] = 409] = "Conflict"; + HttpCodes[HttpCodes["Gone"] = 410] = "Gone"; + HttpCodes[HttpCodes["TooManyRequests"] = 429] = "TooManyRequests"; + HttpCodes[HttpCodes["InternalServerError"] = 500] = "InternalServerError"; + HttpCodes[HttpCodes["NotImplemented"] = 501] = "NotImplemented"; + HttpCodes[HttpCodes["BadGateway"] = 502] = "BadGateway"; + HttpCodes[HttpCodes["ServiceUnavailable"] = 503] = "ServiceUnavailable"; + HttpCodes[HttpCodes["GatewayTimeout"] = 504] = "GatewayTimeout"; +})(HttpCodes = exports.HttpCodes || (exports.HttpCodes = {})); +var Headers; +(function (Headers) { + Headers["Accept"] = "accept"; + Headers["ContentType"] = "content-type"; +})(Headers = exports.Headers || (exports.Headers = {})); +var MediaTypes; +(function (MediaTypes) { + MediaTypes["ApplicationJson"] = "application/json"; +})(MediaTypes = exports.MediaTypes || (exports.MediaTypes = {})); +/** + * Returns the proxy URL, depending upon the supplied url and proxy environment variables. + * @param serverUrl The server URL where the request will be sent. For example, https://api.github.com + */ +function getProxyUrl(serverUrl) { + let proxyUrl = pm.getProxyUrl(new URL(serverUrl)); + return proxyUrl ? proxyUrl.href : ''; +} +exports.getProxyUrl = getProxyUrl; +const HttpRedirectCodes = [ + HttpCodes.MovedPermanently, + HttpCodes.ResourceMoved, + HttpCodes.SeeOther, + HttpCodes.TemporaryRedirect, + HttpCodes.PermanentRedirect +]; +const HttpResponseRetryCodes = [ + HttpCodes.BadGateway, + HttpCodes.ServiceUnavailable, + HttpCodes.GatewayTimeout +]; +const RetryableHttpVerbs = ['OPTIONS', 'GET', 'DELETE', 'HEAD']; +const ExponentialBackoffCeiling = 10; +const ExponentialBackoffTimeSlice = 5; +class HttpClientError extends Error { + constructor(message, statusCode) { + super(message); + this.name = 'HttpClientError'; + this.statusCode = statusCode; + Object.setPrototypeOf(this, HttpClientError.prototype); + } +} +exports.HttpClientError = HttpClientError; +class HttpClientResponse { + constructor(message) { + this.message = message; + } + readBody() { + return new Promise(async (resolve, reject) => { + let output = Buffer.alloc(0); + this.message.on('data', (chunk) => { + output = Buffer.concat([output, chunk]); + }); + this.message.on('end', () => { + resolve(output.toString()); + }); + }); + } +} +exports.HttpClientResponse = HttpClientResponse; +function isHttps(requestUrl) { + let parsedUrl = new URL(requestUrl); + return parsedUrl.protocol === 'https:'; +} +exports.isHttps = isHttps; +class HttpClient { + constructor(userAgent, handlers, requestOptions) { + this._ignoreSslError = false; + this._allowRedirects = true; + this._allowRedirectDowngrade = false; + this._maxRedirects = 50; + this._allowRetries = false; + this._maxRetries = 1; + this._keepAlive = false; + this._disposed = false; + this.userAgent = userAgent; + this.handlers = handlers || []; + this.requestOptions = requestOptions; + if (requestOptions) { + if (requestOptions.ignoreSslError != null) { + this._ignoreSslError = requestOptions.ignoreSslError; + } + this._socketTimeout = requestOptions.socketTimeout; + if (requestOptions.allowRedirects != null) { + this._allowRedirects = requestOptions.allowRedirects; + } + if (requestOptions.allowRedirectDowngrade != null) { + this._allowRedirectDowngrade = requestOptions.allowRedirectDowngrade; + } + if (requestOptions.maxRedirects != null) { + this._maxRedirects = Math.max(requestOptions.maxRedirects, 0); + } + if (requestOptions.keepAlive != null) { + this._keepAlive = requestOptions.keepAlive; + } + if (requestOptions.allowRetries != null) { + this._allowRetries = requestOptions.allowRetries; + } + if (requestOptions.maxRetries != null) { + this._maxRetries = requestOptions.maxRetries; + } + } + } + options(requestUrl, additionalHeaders) { + return this.request('OPTIONS', requestUrl, null, additionalHeaders || {}); + } + get(requestUrl, additionalHeaders) { + return this.request('GET', requestUrl, null, additionalHeaders || {}); + } + del(requestUrl, additionalHeaders) { + return this.request('DELETE', requestUrl, null, additionalHeaders || {}); + } + post(requestUrl, data, additionalHeaders) { + return this.request('POST', requestUrl, data, additionalHeaders || {}); + } + patch(requestUrl, data, additionalHeaders) { + return this.request('PATCH', requestUrl, data, additionalHeaders || {}); + } + put(requestUrl, data, additionalHeaders) { + return this.request('PUT', requestUrl, data, additionalHeaders || {}); + } + head(requestUrl, additionalHeaders) { + return this.request('HEAD', requestUrl, null, additionalHeaders || {}); + } + sendStream(verb, requestUrl, stream, additionalHeaders) { + return this.request(verb, requestUrl, stream, additionalHeaders); + } + /** + * Gets a typed object from an endpoint + * Be aware that not found returns a null. Other errors (4xx, 5xx) reject the promise + */ + async getJson(requestUrl, additionalHeaders = {}) { + additionalHeaders[Headers.Accept] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.Accept, MediaTypes.ApplicationJson); + let res = await this.get(requestUrl, additionalHeaders); + return this._processResponse(res, this.requestOptions); + } + async postJson(requestUrl, obj, additionalHeaders = {}) { + let data = JSON.stringify(obj, null, 2); + additionalHeaders[Headers.Accept] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.Accept, MediaTypes.ApplicationJson); + additionalHeaders[Headers.ContentType] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.ContentType, MediaTypes.ApplicationJson); + let res = await this.post(requestUrl, data, additionalHeaders); + return this._processResponse(res, this.requestOptions); + } + async putJson(requestUrl, obj, additionalHeaders = {}) { + let data = JSON.stringify(obj, null, 2); + additionalHeaders[Headers.Accept] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.Accept, MediaTypes.ApplicationJson); + additionalHeaders[Headers.ContentType] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.ContentType, MediaTypes.ApplicationJson); + let res = await this.put(requestUrl, data, additionalHeaders); + return this._processResponse(res, this.requestOptions); + } + async patchJson(requestUrl, obj, additionalHeaders = {}) { + let data = JSON.stringify(obj, null, 2); + additionalHeaders[Headers.Accept] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.Accept, MediaTypes.ApplicationJson); + additionalHeaders[Headers.ContentType] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.ContentType, MediaTypes.ApplicationJson); + let res = await this.patch(requestUrl, data, additionalHeaders); + return this._processResponse(res, this.requestOptions); + } + /** + * Makes a raw http request. + * All other methods such as get, post, patch, and request ultimately call this. + * Prefer get, del, post and patch + */ + async request(verb, requestUrl, data, headers) { + if (this._disposed) { + throw new Error('Client has already been disposed.'); + } + let parsedUrl = new URL(requestUrl); + let info = this._prepareRequest(verb, parsedUrl, headers); + // Only perform retries on reads since writes may not be idempotent. + let maxTries = this._allowRetries && RetryableHttpVerbs.indexOf(verb) != -1 + ? this._maxRetries + 1 + : 1; + let numTries = 0; + let response; + while (numTries < maxTries) { + response = await this.requestRaw(info, data); + // Check if it's an authentication challenge + if (response && + response.message && + response.message.statusCode === HttpCodes.Unauthorized) { + let authenticationHandler; + for (let i = 0; i < this.handlers.length; i++) { + if (this.handlers[i].canHandleAuthentication(response)) { + authenticationHandler = this.handlers[i]; + break; + } + } + if (authenticationHandler) { + return authenticationHandler.handleAuthentication(this, info, data); + } + else { + // We have received an unauthorized response but have no handlers to handle it. + // Let the response return to the caller. + return response; + } + } + let redirectsRemaining = this._maxRedirects; + while (HttpRedirectCodes.indexOf(response.message.statusCode) != -1 && + this._allowRedirects && + redirectsRemaining > 0) { + const redirectUrl = response.message.headers['location']; + if (!redirectUrl) { + // if there's no location to redirect to, we won't + break; + } + let parsedRedirectUrl = new URL(redirectUrl); + if (parsedUrl.protocol == 'https:' && + parsedUrl.protocol != parsedRedirectUrl.protocol && + !this._allowRedirectDowngrade) { + throw new Error('Redirect from HTTPS to HTTP protocol. This downgrade is not allowed for security reasons. If you want to allow this behavior, set the allowRedirectDowngrade option to true.'); + } + // we need to finish reading the response before reassigning response + // which will leak the open socket. + await response.readBody(); + // strip authorization header if redirected to a different hostname + if (parsedRedirectUrl.hostname !== parsedUrl.hostname) { + for (let header in headers) { + // header names are case insensitive + if (header.toLowerCase() === 'authorization') { + delete headers[header]; + } + } + } + // let's make the request with the new redirectUrl + info = this._prepareRequest(verb, parsedRedirectUrl, headers); + response = await this.requestRaw(info, data); + redirectsRemaining--; + } + if (HttpResponseRetryCodes.indexOf(response.message.statusCode) == -1) { + // If not a retry code, return immediately instead of retrying + return response; + } + numTries += 1; + if (numTries < maxTries) { + await response.readBody(); + await this._performExponentialBackoff(numTries); + } + } + return response; + } + /** + * Needs to be called if keepAlive is set to true in request options. + */ + dispose() { + if (this._agent) { + this._agent.destroy(); + } + this._disposed = true; + } + /** + * Raw request. + * @param info + * @param data + */ + requestRaw(info, data) { + return new Promise((resolve, reject) => { + let callbackForResult = function (err, res) { + if (err) { + reject(err); + } + resolve(res); + }; + this.requestRawWithCallback(info, data, callbackForResult); + }); + } + /** + * Raw request with callback. + * @param info + * @param data + * @param onResult + */ + requestRawWithCallback(info, data, onResult) { + let socket; + if (typeof data === 'string') { + info.options.headers['Content-Length'] = Buffer.byteLength(data, 'utf8'); + } + let callbackCalled = false; + let handleResult = (err, res) => { + if (!callbackCalled) { + callbackCalled = true; + onResult(err, res); + } + }; + let req = info.httpModule.request(info.options, (msg) => { + let res = new HttpClientResponse(msg); + handleResult(null, res); + }); + req.on('socket', sock => { + socket = sock; + }); + // If we ever get disconnected, we want the socket to timeout eventually + req.setTimeout(this._socketTimeout || 3 * 60000, () => { + if (socket) { + socket.end(); + } + handleResult(new Error('Request timeout: ' + info.options.path), null); + }); + req.on('error', function (err) { + // err has statusCode property + // res should have headers + handleResult(err, null); + }); + if (data && typeof data === 'string') { + req.write(data, 'utf8'); + } + if (data && typeof data !== 'string') { + data.on('close', function () { + req.end(); + }); + data.pipe(req); + } + else { + req.end(); + } + } + /** + * Gets an http agent. This function is useful when you need an http agent that handles + * routing through a proxy server - depending upon the url and proxy environment variables. + * @param serverUrl The server URL where the request will be sent. For example, https://api.github.com + */ + getAgent(serverUrl) { + let parsedUrl = new URL(serverUrl); + return this._getAgent(parsedUrl); + } + _prepareRequest(method, requestUrl, headers) { + const info = {}; + info.parsedUrl = requestUrl; + const usingSsl = info.parsedUrl.protocol === 'https:'; + info.httpModule = usingSsl ? https : http; + const defaultPort = usingSsl ? 443 : 80; + info.options = {}; + info.options.host = info.parsedUrl.hostname; + info.options.port = info.parsedUrl.port + ? parseInt(info.parsedUrl.port) + : defaultPort; + info.options.path = + (info.parsedUrl.pathname || '') + (info.parsedUrl.search || ''); + info.options.method = method; + info.options.headers = this._mergeHeaders(headers); + if (this.userAgent != null) { + info.options.headers['user-agent'] = this.userAgent; + } + info.options.agent = this._getAgent(info.parsedUrl); + // gives handlers an opportunity to participate + if (this.handlers) { + this.handlers.forEach(handler => { + handler.prepareRequest(info.options); + }); + } + return info; + } + _mergeHeaders(headers) { + const lowercaseKeys = obj => Object.keys(obj).reduce((c, k) => ((c[k.toLowerCase()] = obj[k]), c), {}); + if (this.requestOptions && this.requestOptions.headers) { + return Object.assign({}, lowercaseKeys(this.requestOptions.headers), lowercaseKeys(headers)); + } + return lowercaseKeys(headers || {}); + } + _getExistingOrDefaultHeader(additionalHeaders, header, _default) { + const lowercaseKeys = obj => Object.keys(obj).reduce((c, k) => ((c[k.toLowerCase()] = obj[k]), c), {}); + let clientHeader; + if (this.requestOptions && this.requestOptions.headers) { + clientHeader = lowercaseKeys(this.requestOptions.headers)[header]; + } + return additionalHeaders[header] || clientHeader || _default; + } + _getAgent(parsedUrl) { + let agent; + let proxyUrl = pm.getProxyUrl(parsedUrl); + let useProxy = proxyUrl && proxyUrl.hostname; + if (this._keepAlive && useProxy) { + agent = this._proxyAgent; + } + if (this._keepAlive && !useProxy) { + agent = this._agent; + } + // if agent is already assigned use that agent. + if (!!agent) { + return agent; + } + const usingSsl = parsedUrl.protocol === 'https:'; + let maxSockets = 100; + if (!!this.requestOptions) { + maxSockets = this.requestOptions.maxSockets || http.globalAgent.maxSockets; + } + if (useProxy) { + // If using proxy, need tunnel + if (!tunnel) { + tunnel = require('tunnel'); + } + const agentOptions = { + maxSockets: maxSockets, + keepAlive: this._keepAlive, + proxy: { + proxyAuth: `${proxyUrl.username}:${proxyUrl.password}`, + host: proxyUrl.hostname, + port: proxyUrl.port + } + }; + let tunnelAgent; + const overHttps = proxyUrl.protocol === 'https:'; + if (usingSsl) { + tunnelAgent = overHttps ? tunnel.httpsOverHttps : tunnel.httpsOverHttp; + } + else { + tunnelAgent = overHttps ? tunnel.httpOverHttps : tunnel.httpOverHttp; + } + agent = tunnelAgent(agentOptions); + this._proxyAgent = agent; + } + // if reusing agent across request and tunneling agent isn't assigned create a new agent + if (this._keepAlive && !agent) { + const options = { keepAlive: this._keepAlive, maxSockets: maxSockets }; + agent = usingSsl ? new https.Agent(options) : new http.Agent(options); + this._agent = agent; + } + // if not using private agent and tunnel agent isn't setup then use global agent + if (!agent) { + agent = usingSsl ? https.globalAgent : http.globalAgent; + } + if (usingSsl && this._ignoreSslError) { + // we don't want to set NODE_TLS_REJECT_UNAUTHORIZED=0 since that will affect request for entire process + // http.RequestOptions doesn't expose a way to modify RequestOptions.agent.options + // we have to cast it to any and change it directly + agent.options = Object.assign(agent.options || {}, { + rejectUnauthorized: false + }); + } + return agent; + } + _performExponentialBackoff(retryNumber) { + retryNumber = Math.min(ExponentialBackoffCeiling, retryNumber); + const ms = ExponentialBackoffTimeSlice * Math.pow(2, retryNumber); + return new Promise(resolve => setTimeout(() => resolve(), ms)); + } + static dateTimeDeserializer(key, value) { + if (typeof value === 'string') { + let a = new Date(value); + if (!isNaN(a.valueOf())) { + return a; + } + } + return value; + } + async _processResponse(res, options) { + return new Promise(async (resolve, reject) => { + const statusCode = res.message.statusCode; + const response = { + statusCode: statusCode, + result: null, + headers: {} + }; + // not found leads to null obj returned + if (statusCode == HttpCodes.NotFound) { + resolve(response); + } + let obj; + let contents; + // get the result from the body + try { + contents = await res.readBody(); + if (contents && contents.length > 0) { + if (options && options.deserializeDates) { + obj = JSON.parse(contents, HttpClient.dateTimeDeserializer); + } + else { + obj = JSON.parse(contents); + } + response.result = obj; + } + response.headers = res.message.headers; + } + catch (err) { + // Invalid resource (contents not json); leaving result obj null + } + // note that 3xx redirects are handled by the http layer. + if (statusCode > 299) { + let msg; + // if exception/error in body, attempt to get better error + if (obj && obj.message) { + msg = obj.message; + } + else if (contents && contents.length > 0) { + // it may be the case that the exception is in the body message as string + msg = contents; + } + else { + msg = 'Failed request: (' + statusCode + ')'; + } + let err = new HttpClientError(msg, statusCode); + err.result = response.result; + reject(err); + } + else { + resolve(response); + } + }); + } +} +exports.HttpClient = HttpClient; diff --git a/node_modules/@actions/http-client/interfaces.d.ts b/node_modules/@actions/http-client/interfaces.d.ts new file mode 100644 index 0000000..78bd85b --- /dev/null +++ b/node_modules/@actions/http-client/interfaces.d.ts @@ -0,0 +1,49 @@ +/// +import http = require('http'); +export interface IHeaders { + [key: string]: any; +} +export interface IHttpClient { + options(requestUrl: string, additionalHeaders?: IHeaders): Promise; + get(requestUrl: string, additionalHeaders?: IHeaders): Promise; + del(requestUrl: string, additionalHeaders?: IHeaders): Promise; + post(requestUrl: string, data: string, additionalHeaders?: IHeaders): Promise; + patch(requestUrl: string, data: string, additionalHeaders?: IHeaders): Promise; + put(requestUrl: string, data: string, additionalHeaders?: IHeaders): Promise; + sendStream(verb: string, requestUrl: string, stream: NodeJS.ReadableStream, additionalHeaders?: IHeaders): Promise; + request(verb: string, requestUrl: string, data: string | NodeJS.ReadableStream, headers: IHeaders): Promise; + requestRaw(info: IRequestInfo, data: string | NodeJS.ReadableStream): Promise; + requestRawWithCallback(info: IRequestInfo, data: string | NodeJS.ReadableStream, onResult: (err: any, res: IHttpClientResponse) => void): void; +} +export interface IRequestHandler { + prepareRequest(options: http.RequestOptions): void; + canHandleAuthentication(response: IHttpClientResponse): boolean; + handleAuthentication(httpClient: IHttpClient, requestInfo: IRequestInfo, objs: any): Promise; +} +export interface IHttpClientResponse { + message: http.IncomingMessage; + readBody(): Promise; +} +export interface IRequestInfo { + options: http.RequestOptions; + parsedUrl: URL; + httpModule: any; +} +export interface IRequestOptions { + headers?: IHeaders; + socketTimeout?: number; + ignoreSslError?: boolean; + allowRedirects?: boolean; + allowRedirectDowngrade?: boolean; + maxRedirects?: number; + maxSockets?: number; + keepAlive?: boolean; + deserializeDates?: boolean; + allowRetries?: boolean; + maxRetries?: number; +} +export interface ITypedResponse { + statusCode: number; + result: T | null; + headers: Object; +} diff --git a/node_modules/@actions/http-client/interfaces.js b/node_modules/@actions/http-client/interfaces.js new file mode 100644 index 0000000..c8ad2e5 --- /dev/null +++ b/node_modules/@actions/http-client/interfaces.js @@ -0,0 +1,2 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); diff --git a/node_modules/@actions/http-client/package.json b/node_modules/@actions/http-client/package.json new file mode 100644 index 0000000..f29bb9d --- /dev/null +++ b/node_modules/@actions/http-client/package.json @@ -0,0 +1,70 @@ +{ + "_args": [ + [ + "@actions/http-client@1.0.9", + "." + ] + ], + "_from": "@actions/http-client@1.0.9", + "_id": "@actions/http-client@1.0.9", + "_inBundle": false, + "_integrity": "sha512-0O4SsJ7q+MK0ycvXPl2e6bMXV7dxAXOGjrXS1eTF9s2S401Tp6c/P3c3Joz04QefC1J6Gt942Wl2jbm3f4mLcg==", + "_location": "/@actions/http-client", + "_phantomChildren": {}, + "_requested": { + "type": "version", + "registry": true, + "raw": "@actions/http-client@1.0.9", + "name": "@actions/http-client", + "escapedName": "@actions%2fhttp-client", + "scope": "@actions", + "rawSpec": "1.0.9", + "saveSpec": null, + "fetchSpec": "1.0.9" + }, + "_requiredBy": [ + "/@actions/github" + ], + "_resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.9.tgz", + "_spec": "1.0.9", + "_where": ".", + "author": { + "name": "GitHub, Inc." + }, + "bugs": { + "url": "https://github.com/actions/http-client/issues" + }, + "dependencies": { + "tunnel": "0.0.6" + }, + "description": "Actions Http Client", + "devDependencies": { + "@types/jest": "^25.1.4", + "@types/node": "^12.12.31", + "jest": "^25.1.0", + "prettier": "^2.0.4", + "proxy": "^1.0.1", + "ts-jest": "^25.2.1", + "typescript": "^3.8.3" + }, + "homepage": "https://github.com/actions/http-client#readme", + "keywords": [ + "Actions", + "Http" + ], + "license": "MIT", + "main": "index.js", + "name": "@actions/http-client", + "repository": { + "type": "git", + "url": "git+https://github.com/actions/http-client.git" + }, + "scripts": { + "audit-check": "npm audit --audit-level=moderate", + "build": "rm -Rf ./_out && tsc && cp package*.json ./_out && cp *.md ./_out && cp LICENSE ./_out && cp actions.png ./_out", + "format": "prettier --write *.ts && prettier --write **/*.ts", + "format-check": "prettier --check *.ts && prettier --check **/*.ts", + "test": "jest" + }, + "version": "1.0.9" +} diff --git a/node_modules/@actions/http-client/proxy.d.ts b/node_modules/@actions/http-client/proxy.d.ts new file mode 100644 index 0000000..4599865 --- /dev/null +++ b/node_modules/@actions/http-client/proxy.d.ts @@ -0,0 +1,2 @@ +export declare function getProxyUrl(reqUrl: URL): URL | undefined; +export declare function checkBypass(reqUrl: URL): boolean; diff --git a/node_modules/@actions/http-client/proxy.js b/node_modules/@actions/http-client/proxy.js new file mode 100644 index 0000000..88f00ec --- /dev/null +++ b/node_modules/@actions/http-client/proxy.js @@ -0,0 +1,57 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +function getProxyUrl(reqUrl) { + let usingSsl = reqUrl.protocol === 'https:'; + let proxyUrl; + if (checkBypass(reqUrl)) { + return proxyUrl; + } + let proxyVar; + if (usingSsl) { + proxyVar = process.env['https_proxy'] || process.env['HTTPS_PROXY']; + } + else { + proxyVar = process.env['http_proxy'] || process.env['HTTP_PROXY']; + } + if (proxyVar) { + proxyUrl = new URL(proxyVar); + } + return proxyUrl; +} +exports.getProxyUrl = getProxyUrl; +function checkBypass(reqUrl) { + if (!reqUrl.hostname) { + return false; + } + let noProxy = process.env['no_proxy'] || process.env['NO_PROXY'] || ''; + if (!noProxy) { + return false; + } + // Determine the request port + let reqPort; + if (reqUrl.port) { + reqPort = Number(reqUrl.port); + } + else if (reqUrl.protocol === 'http:') { + reqPort = 80; + } + else if (reqUrl.protocol === 'https:') { + reqPort = 443; + } + // Format the request hostname and hostname with port + let upperReqHosts = [reqUrl.hostname.toUpperCase()]; + if (typeof reqPort === 'number') { + upperReqHosts.push(`${upperReqHosts[0]}:${reqPort}`); + } + // Compare request host against noproxy + for (let upperNoProxyItem of noProxy + .split(',') + .map(x => x.trim().toUpperCase()) + .filter(x => x)) { + if (upperReqHosts.some(x => x === upperNoProxyItem)) { + return true; + } + } + return false; +} +exports.checkBypass = checkBypass; diff --git a/node_modules/pump/LICENSE b/node_modules/@octokit/auth-token/LICENSE similarity index 93% rename from node_modules/pump/LICENSE rename to node_modules/@octokit/auth-token/LICENSE index 757562e..ef2c18e 100644 --- a/node_modules/pump/LICENSE +++ b/node_modules/@octokit/auth-token/LICENSE @@ -1,6 +1,6 @@ -The MIT License (MIT) +The MIT License -Copyright (c) 2014 Mathias Buus +Copyright (c) 2019 Octokit contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. \ No newline at end of file +THE SOFTWARE. diff --git a/node_modules/@octokit/auth-token/README.md b/node_modules/@octokit/auth-token/README.md new file mode 100644 index 0000000..4afeb95 --- /dev/null +++ b/node_modules/@octokit/auth-token/README.md @@ -0,0 +1,271 @@ +# auth-token.js + +> GitHub API token authentication for browsers and Node.js + +[![@latest](https://img.shields.io/npm/v/@octokit/auth-token.svg)](https://www.npmjs.com/package/@octokit/auth-token) +[![Build Status](https://github.com/octokit/auth-token.js/workflows/Test/badge.svg)](https://github.com/octokit/auth-token.js/actions?query=workflow%3ATest) + +`@octokit/auth-token` is the simplest of [GitHub’s authentication strategies](https://github.com/octokit/auth.js). + +It is useful if you want to support multiple authentication strategies, as it’s API is compatible with its sibling packages for [basic](https://github.com/octokit/auth-basic.js), [GitHub App](https://github.com/octokit/auth-app.js) and [OAuth app](https://github.com/octokit/auth.js) authentication. + + + +- [Usage](#usage) +- [`createTokenAuth(token) options`](#createtokenauthtoken-options) +- [`auth()`](#auth) +- [Authentication object](#authentication-object) +- [`auth.hook(request, route, options)` or `auth.hook(request, options)`](#authhookrequest-route-options-or-authhookrequest-options) +- [Find more information](#find-more-information) + - [Find out what scopes are enabled for oauth tokens](#find-out-what-scopes-are-enabled-for-oauth-tokens) + - [Find out if token is a personal access token or if it belongs to an OAuth app](#find-out-if-token-is-a-personal-access-token-or-if-it-belongs-to-an-oauth-app) + - [Find out what permissions are enabled for a repository](#find-out-what-permissions-are-enabled-for-a-repository) + - [Use token for git operations](#use-token-for-git-operations) +- [License](#license) + + + +## Usage + + + + + + +
+Browsers + + +Load `@octokit/auth-token` directly from [cdn.skypack.dev](https://cdn.skypack.dev) + +```html + +``` + +
+Node + + +Install with npm install @octokit/auth-token + +```js +const { createTokenAuth } = require("@octokit/auth-token"); +// or: import { createTokenAuth } from "@octokit/auth-token"; +``` + +
+ +```js +const auth = createTokenAuth("1234567890abcdef1234567890abcdef12345678"); +const authentication = await auth(); +// { +// type: 'token', +// token: '1234567890abcdef1234567890abcdef12345678', +// tokenType: 'oauth' +// } +``` + +## `createTokenAuth(token) options` + +The `createTokenAuth` method accepts a single argument of type string, which is the token. The passed token can be one of the following: + +- [Personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) +- [OAuth access token](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/) +- Installation access token ([GitHub App Installation](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)) +- [GITHUB_TOKEN provided to GitHub Actions](https://developer.github.com/actions/creating-github-actions/accessing-the-runtime-environment/#environment-variables) + +Examples + +```js +// Personal access token or OAuth access token +createTokenAuth("1234567890abcdef1234567890abcdef12345678"); + +// Installation access token or GitHub Action token +createTokenAuth("v1.d3d433526f780fbcc3129004e2731b3904ad0b86"); +``` + +## `auth()` + +The `auth()` method has no options. It returns a promise which resolves with the the authentication object. + +## Authentication object + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ name + + type + + description +
+ type + + string + + "token" +
+ token + + string + + The provided token. +
+ tokenType + + string + + Can be either "oauth" for personal access tokens and OAuth tokens, or "installation" for installation access tokens (includes GITHUB_TOKEN provided to GitHub Actions) +
+ +## `auth.hook(request, route, options)` or `auth.hook(request, options)` + +`auth.hook()` hooks directly into the request life cycle. It authenticates the request using the provided token. + +The `request` option is an instance of [`@octokit/request`](https://github.com/octokit/request.js#readme). The `route`/`options` parameters are the same as for the [`request()` method](https://github.com/octokit/request.js#request). + +`auth.hook()` can be called directly to send an authenticated request + +```js +const { data: authorizations } = await auth.hook( + request, + "GET /authorizations" +); +``` + +Or it can be passed as option to [`request()`](https://github.com/octokit/request.js#request). + +```js +const requestWithAuth = request.defaults({ + request: { + hook: auth.hook, + }, +}); + +const { data: authorizations } = await requestWithAuth("GET /authorizations"); +``` + +## Find more information + +`auth()` does not send any requests, it only transforms the provided token string into an authentication object. + +Here is a list of things you can do to retrieve further information + +### Find out what scopes are enabled for oauth tokens + +Note that this does not work for installations. There is no way to retrieve permissions based on an installation access tokens. + +```js +const TOKEN = "1234567890abcdef1234567890abcdef12345678"; + +const auth = createTokenAuth(TOKEN); +const authentication = await auth(); + +const response = await request("HEAD /", { + headers: authentication.headers, +}); +const scopes = response.headers["x-oauth-scopes"].split(/,\s+/); + +if (scopes.length) { + console.log( + `"${TOKEN}" has ${scopes.length} scopes enabled: ${scopes.join(", ")}` + ); +} else { + console.log(`"${TOKEN}" has no scopes enabled`); +} +``` + +### Find out if token is a personal access token or if it belongs to an OAuth app + +```js +const TOKEN = "1234567890abcdef1234567890abcdef12345678"; + +const auth = createTokenAuth(TOKEN); +const authentication = await auth(); + +const response = await request("HEAD /", { + headers: authentication.headers, +}); +const clientId = response.headers["x-oauth-client-id"]; + +if (clientId) { + console.log( + `"${token}" is an OAuth token, its app’s client_id is ${clientId}.` + ); +} else { + console.log(`"${token}" is a personal access token`); +} +``` + +### Find out what permissions are enabled for a repository + +Note that the `permissions` key is not set when authenticated using an installation access token. + +```js +const TOKEN = "1234567890abcdef1234567890abcdef12345678"; + +const auth = createTokenAuth(TOKEN); +const authentication = await auth(); + +const response = await request("GET /repos/:owner/:repo", { + owner: 'octocat', + repo: 'hello-world' + headers: authentication.headers +}); + +console.log(response.data.permissions) +// { +// admin: true, +// push: true, +// pull: true +// } +``` + +### Use token for git operations + +Both OAuth and installation access tokens can be used for git operations. However, when using with an installation, [the token must be prefixed with `x-access-token`](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#http-based-git-access-by-an-installation). + +This example is using the [`execa`](https://github.com/sindresorhus/execa) package to run a `git push` command. + +```js +const TOKEN = "1234567890abcdef1234567890abcdef12345678"; + +const auth = createTokenAuth(TOKEN); +const { token, tokenType } = await auth(); +const tokenWithPrefix = + tokenType === "installation" ? `x-access-token:${token}` : token; + +const repositoryUrl = `https://${tokenWithPrefix}@github.com/octocat/hello-world.git`; + +const { stdout } = await execa("git", ["push", repositoryUrl]); +console.log(stdout); +``` + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/auth-token/dist-node/index.js b/node_modules/@octokit/auth-token/dist-node/index.js new file mode 100644 index 0000000..1394a5d --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-node/index.js @@ -0,0 +1,49 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +async function auth(token) { + const tokenType = token.split(/\./).length === 3 ? "app" : /^v\d+\./.test(token) ? "installation" : "oauth"; + return { + type: "token", + token: token, + tokenType + }; +} + +/** + * Prefix token for usage in the Authorization header + * + * @param token OAuth token or JSON Web Token + */ +function withAuthorizationPrefix(token) { + if (token.split(/\./).length === 3) { + return `bearer ${token}`; + } + + return `token ${token}`; +} + +async function hook(token, request, route, parameters) { + const endpoint = request.endpoint.merge(route, parameters); + endpoint.headers.authorization = withAuthorizationPrefix(token); + return request(endpoint); +} + +const createTokenAuth = function createTokenAuth(token) { + if (!token) { + throw new Error("[@octokit/auth-token] No token passed to createTokenAuth"); + } + + if (typeof token !== "string") { + throw new Error("[@octokit/auth-token] Token passed to createTokenAuth is not a string"); + } + + token = token.replace(/^(token|bearer) +/i, ""); + return Object.assign(auth.bind(null, token), { + hook: hook.bind(null, token) + }); +}; + +exports.createTokenAuth = createTokenAuth; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/auth-token/dist-node/index.js.map b/node_modules/@octokit/auth-token/dist-node/index.js.map new file mode 100644 index 0000000..8a92b69 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/auth.js","../dist-src/with-authorization-prefix.js","../dist-src/hook.js","../dist-src/index.js"],"sourcesContent":["export async function auth(token) {\n const tokenType = token.split(/\\./).length === 3\n ? \"app\"\n : /^v\\d+\\./.test(token)\n ? \"installation\"\n : \"oauth\";\n return {\n type: \"token\",\n token: token,\n tokenType\n };\n}\n","/**\n * Prefix token for usage in the Authorization header\n *\n * @param token OAuth token or JSON Web Token\n */\nexport function withAuthorizationPrefix(token) {\n if (token.split(/\\./).length === 3) {\n return `bearer ${token}`;\n }\n return `token ${token}`;\n}\n","import { withAuthorizationPrefix } from \"./with-authorization-prefix\";\nexport async function hook(token, request, route, parameters) {\n const endpoint = request.endpoint.merge(route, parameters);\n endpoint.headers.authorization = withAuthorizationPrefix(token);\n return request(endpoint);\n}\n","import { auth } from \"./auth\";\nimport { hook } from \"./hook\";\nexport const createTokenAuth = function createTokenAuth(token) {\n if (!token) {\n throw new Error(\"[@octokit/auth-token] No token passed to createTokenAuth\");\n }\n if (typeof token !== \"string\") {\n throw new Error(\"[@octokit/auth-token] Token passed to createTokenAuth is not a string\");\n }\n token = token.replace(/^(token|bearer) +/i, \"\");\n return Object.assign(auth.bind(null, token), {\n hook: hook.bind(null, token)\n });\n};\n"],"names":["auth","token","tokenType","split","length","test","type","withAuthorizationPrefix","hook","request","route","parameters","endpoint","merge","headers","authorization","createTokenAuth","Error","replace","Object","assign","bind"],"mappings":";;;;AAAO,eAAeA,IAAf,CAAoBC,KAApB,EAA2B;AAC9B,QAAMC,SAAS,GAAGD,KAAK,CAACE,KAAN,CAAY,IAAZ,EAAkBC,MAAlB,KAA6B,CAA7B,GACZ,KADY,GAEZ,UAAUC,IAAV,CAAeJ,KAAf,IACI,cADJ,GAEI,OAJV;AAKA,SAAO;AACHK,IAAAA,IAAI,EAAE,OADH;AAEHL,IAAAA,KAAK,EAAEA,KAFJ;AAGHC,IAAAA;AAHG,GAAP;AAKH;;ACXD;;;;;AAKA,AAAO,SAASK,uBAAT,CAAiCN,KAAjC,EAAwC;AAC3C,MAAIA,KAAK,CAACE,KAAN,CAAY,IAAZ,EAAkBC,MAAlB,KAA6B,CAAjC,EAAoC;AAChC,WAAQ,UAASH,KAAM,EAAvB;AACH;;AACD,SAAQ,SAAQA,KAAM,EAAtB;AACH;;ACTM,eAAeO,IAAf,CAAoBP,KAApB,EAA2BQ,OAA3B,EAAoCC,KAApC,EAA2CC,UAA3C,EAAuD;AAC1D,QAAMC,QAAQ,GAAGH,OAAO,CAACG,QAAR,CAAiBC,KAAjB,CAAuBH,KAAvB,EAA8BC,UAA9B,CAAjB;AACAC,EAAAA,QAAQ,CAACE,OAAT,CAAiBC,aAAjB,GAAiCR,uBAAuB,CAACN,KAAD,CAAxD;AACA,SAAOQ,OAAO,CAACG,QAAD,CAAd;AACH;;MCHYI,eAAe,GAAG,SAASA,eAAT,CAAyBf,KAAzB,EAAgC;AAC3D,MAAI,CAACA,KAAL,EAAY;AACR,UAAM,IAAIgB,KAAJ,CAAU,0DAAV,CAAN;AACH;;AACD,MAAI,OAAOhB,KAAP,KAAiB,QAArB,EAA+B;AAC3B,UAAM,IAAIgB,KAAJ,CAAU,uEAAV,CAAN;AACH;;AACDhB,EAAAA,KAAK,GAAGA,KAAK,CAACiB,OAAN,CAAc,oBAAd,EAAoC,EAApC,CAAR;AACA,SAAOC,MAAM,CAACC,MAAP,CAAcpB,IAAI,CAACqB,IAAL,CAAU,IAAV,EAAgBpB,KAAhB,CAAd,EAAsC;AACzCO,IAAAA,IAAI,EAAEA,IAAI,CAACa,IAAL,CAAU,IAAV,EAAgBpB,KAAhB;AADmC,GAAtC,CAAP;AAGH,CAXM;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/auth-token/dist-src/auth.js b/node_modules/@octokit/auth-token/dist-src/auth.js new file mode 100644 index 0000000..2d5005c --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-src/auth.js @@ -0,0 +1,12 @@ +export async function auth(token) { + const tokenType = token.split(/\./).length === 3 + ? "app" + : /^v\d+\./.test(token) + ? "installation" + : "oauth"; + return { + type: "token", + token: token, + tokenType + }; +} diff --git a/node_modules/@octokit/auth-token/dist-src/hook.js b/node_modules/@octokit/auth-token/dist-src/hook.js new file mode 100644 index 0000000..f8e47f0 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-src/hook.js @@ -0,0 +1,6 @@ +import { withAuthorizationPrefix } from "./with-authorization-prefix"; +export async function hook(token, request, route, parameters) { + const endpoint = request.endpoint.merge(route, parameters); + endpoint.headers.authorization = withAuthorizationPrefix(token); + return request(endpoint); +} diff --git a/node_modules/@octokit/auth-token/dist-src/index.js b/node_modules/@octokit/auth-token/dist-src/index.js new file mode 100644 index 0000000..114fd45 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-src/index.js @@ -0,0 +1,14 @@ +import { auth } from "./auth"; +import { hook } from "./hook"; +export const createTokenAuth = function createTokenAuth(token) { + if (!token) { + throw new Error("[@octokit/auth-token] No token passed to createTokenAuth"); + } + if (typeof token !== "string") { + throw new Error("[@octokit/auth-token] Token passed to createTokenAuth is not a string"); + } + token = token.replace(/^(token|bearer) +/i, ""); + return Object.assign(auth.bind(null, token), { + hook: hook.bind(null, token) + }); +}; diff --git a/node_modules/@octokit/auth-token/dist-src/types.js b/node_modules/@octokit/auth-token/dist-src/types.js new file mode 100644 index 0000000..e69de29 diff --git a/node_modules/@octokit/auth-token/dist-src/with-authorization-prefix.js b/node_modules/@octokit/auth-token/dist-src/with-authorization-prefix.js new file mode 100644 index 0000000..9035813 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-src/with-authorization-prefix.js @@ -0,0 +1,11 @@ +/** + * Prefix token for usage in the Authorization header + * + * @param token OAuth token or JSON Web Token + */ +export function withAuthorizationPrefix(token) { + if (token.split(/\./).length === 3) { + return `bearer ${token}`; + } + return `token ${token}`; +} diff --git a/node_modules/@octokit/auth-token/dist-types/auth.d.ts b/node_modules/@octokit/auth-token/dist-types/auth.d.ts new file mode 100644 index 0000000..dc41835 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-types/auth.d.ts @@ -0,0 +1,2 @@ +import { Token, Authentication } from "./types"; +export declare function auth(token: Token): Promise; diff --git a/node_modules/@octokit/auth-token/dist-types/hook.d.ts b/node_modules/@octokit/auth-token/dist-types/hook.d.ts new file mode 100644 index 0000000..21e4b6f --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-types/hook.d.ts @@ -0,0 +1,2 @@ +import { AnyResponse, EndpointOptions, RequestInterface, RequestParameters, Route, Token } from "./types"; +export declare function hook(token: Token, request: RequestInterface, route: Route | EndpointOptions, parameters?: RequestParameters): Promise; diff --git a/node_modules/@octokit/auth-token/dist-types/index.d.ts b/node_modules/@octokit/auth-token/dist-types/index.d.ts new file mode 100644 index 0000000..5999429 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-types/index.d.ts @@ -0,0 +1,7 @@ +import { StrategyInterface, Token, Authentication } from "./types"; +export declare type Types = { + StrategyOptions: Token; + AuthOptions: never; + Authentication: Authentication; +}; +export declare const createTokenAuth: StrategyInterface; diff --git a/node_modules/@octokit/auth-token/dist-types/types.d.ts b/node_modules/@octokit/auth-token/dist-types/types.d.ts new file mode 100644 index 0000000..53a4ab1 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-types/types.d.ts @@ -0,0 +1,25 @@ +import * as OctokitTypes from "@octokit/types"; +export declare type AnyResponse = OctokitTypes.OctokitResponse; +export declare type StrategyInterface = OctokitTypes.StrategyInterface<[Token], [], Authentication>; +export declare type EndpointDefaults = OctokitTypes.EndpointDefaults; +export declare type EndpointOptions = OctokitTypes.EndpointOptions; +export declare type RequestParameters = OctokitTypes.RequestParameters; +export declare type RequestInterface = OctokitTypes.RequestInterface; +export declare type Route = OctokitTypes.Route; +export declare type Token = string; +export declare type OAuthTokenAuthentication = { + type: "token"; + tokenType: "oauth"; + token: Token; +}; +export declare type InstallationTokenAuthentication = { + type: "token"; + tokenType: "installation"; + token: Token; +}; +export declare type AppAuthentication = { + type: "token"; + tokenType: "app"; + token: Token; +}; +export declare type Authentication = OAuthTokenAuthentication | InstallationTokenAuthentication | AppAuthentication; diff --git a/node_modules/@octokit/auth-token/dist-types/with-authorization-prefix.d.ts b/node_modules/@octokit/auth-token/dist-types/with-authorization-prefix.d.ts new file mode 100644 index 0000000..2e52c31 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-types/with-authorization-prefix.d.ts @@ -0,0 +1,6 @@ +/** + * Prefix token for usage in the Authorization header + * + * @param token OAuth token or JSON Web Token + */ +export declare function withAuthorizationPrefix(token: string): string; diff --git a/node_modules/@octokit/auth-token/dist-web/index.js b/node_modules/@octokit/auth-token/dist-web/index.js new file mode 100644 index 0000000..c15ca12 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-web/index.js @@ -0,0 +1,46 @@ +async function auth(token) { + const tokenType = token.split(/\./).length === 3 + ? "app" + : /^v\d+\./.test(token) + ? "installation" + : "oauth"; + return { + type: "token", + token: token, + tokenType + }; +} + +/** + * Prefix token for usage in the Authorization header + * + * @param token OAuth token or JSON Web Token + */ +function withAuthorizationPrefix(token) { + if (token.split(/\./).length === 3) { + return `bearer ${token}`; + } + return `token ${token}`; +} + +async function hook(token, request, route, parameters) { + const endpoint = request.endpoint.merge(route, parameters); + endpoint.headers.authorization = withAuthorizationPrefix(token); + return request(endpoint); +} + +const createTokenAuth = function createTokenAuth(token) { + if (!token) { + throw new Error("[@octokit/auth-token] No token passed to createTokenAuth"); + } + if (typeof token !== "string") { + throw new Error("[@octokit/auth-token] Token passed to createTokenAuth is not a string"); + } + token = token.replace(/^(token|bearer) +/i, ""); + return Object.assign(auth.bind(null, token), { + hook: hook.bind(null, token) + }); +}; + +export { createTokenAuth }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/auth-token/dist-web/index.js.map b/node_modules/@octokit/auth-token/dist-web/index.js.map new file mode 100644 index 0000000..60de4a6 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/auth.js","../dist-src/with-authorization-prefix.js","../dist-src/hook.js","../dist-src/index.js"],"sourcesContent":["export async function auth(token) {\n const tokenType = token.split(/\\./).length === 3\n ? \"app\"\n : /^v\\d+\\./.test(token)\n ? \"installation\"\n : \"oauth\";\n return {\n type: \"token\",\n token: token,\n tokenType\n };\n}\n","/**\n * Prefix token for usage in the Authorization header\n *\n * @param token OAuth token or JSON Web Token\n */\nexport function withAuthorizationPrefix(token) {\n if (token.split(/\\./).length === 3) {\n return `bearer ${token}`;\n }\n return `token ${token}`;\n}\n","import { withAuthorizationPrefix } from \"./with-authorization-prefix\";\nexport async function hook(token, request, route, parameters) {\n const endpoint = request.endpoint.merge(route, parameters);\n endpoint.headers.authorization = withAuthorizationPrefix(token);\n return request(endpoint);\n}\n","import { auth } from \"./auth\";\nimport { hook } from \"./hook\";\nexport const createTokenAuth = function createTokenAuth(token) {\n if (!token) {\n throw new Error(\"[@octokit/auth-token] No token passed to createTokenAuth\");\n }\n if (typeof token !== \"string\") {\n throw new Error(\"[@octokit/auth-token] Token passed to createTokenAuth is not a string\");\n }\n token = token.replace(/^(token|bearer) +/i, \"\");\n return Object.assign(auth.bind(null, token), {\n hook: hook.bind(null, token)\n });\n};\n"],"names":[],"mappings":"AAAO,eAAe,IAAI,CAAC,KAAK,EAAE;AAClC,IAAI,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;AACpD,UAAU,KAAK;AACf,UAAU,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;AAC/B,cAAc,cAAc;AAC5B,cAAc,OAAO,CAAC;AACtB,IAAI,OAAO;AACX,QAAQ,IAAI,EAAE,OAAO;AACrB,QAAQ,KAAK,EAAE,KAAK;AACpB,QAAQ,SAAS;AACjB,KAAK,CAAC;AACN;;ACXA;AACA;AACA;AACA;AACA;AACA,AAAO,SAAS,uBAAuB,CAAC,KAAK,EAAE;AAC/C,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;AACxC,QAAQ,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;AACjC,KAAK;AACL,IAAI,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AAC5B,CAAC;;ACTM,eAAe,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE;AAC9D,IAAI,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AAC/D,IAAI,QAAQ,CAAC,OAAO,CAAC,aAAa,GAAG,uBAAuB,CAAC,KAAK,CAAC,CAAC;AACpE,IAAI,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC7B,CAAC;;ACHW,MAAC,eAAe,GAAG,SAAS,eAAe,CAAC,KAAK,EAAE;AAC/D,IAAI,IAAI,CAAC,KAAK,EAAE;AAChB,QAAQ,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;AACpF,KAAK;AACL,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AACnC,QAAQ,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;AACjG,KAAK;AACL,IAAI,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;AACpD,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;AACjD,QAAQ,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC;AACpC,KAAK,CAAC,CAAC;AACP,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/auth-token/package.json b/node_modules/@octokit/auth-token/package.json new file mode 100644 index 0000000..abb8b3f --- /dev/null +++ b/node_modules/@octokit/auth-token/package.json @@ -0,0 +1,80 @@ +{ + "_args": [ + [ + "@octokit/auth-token@2.4.4", + "." + ] + ], + "_from": "@octokit/auth-token@2.4.4", + "_id": "@octokit/auth-token@2.4.4", + "_inBundle": false, + "_integrity": "sha512-LNfGu3Ro9uFAYh10MUZVaT7X2CnNm2C8IDQmabx+3DygYIQjs9FwzFAHN/0t6mu5HEPhxcb1XOuxdpY82vCg2Q==", + "_location": "/@octokit/auth-token", + "_phantomChildren": {}, + "_requested": { + "type": "version", + "registry": true, + "raw": "@octokit/auth-token@2.4.4", + "name": "@octokit/auth-token", + "escapedName": "@octokit%2fauth-token", + "scope": "@octokit", + "rawSpec": "2.4.4", + "saveSpec": null, + "fetchSpec": "2.4.4" + }, + "_requiredBy": [ + "/@octokit/core" + ], + "_resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.4.tgz", + "_spec": "2.4.4", + "_where": ".", + "bugs": { + "url": "https://github.com/octokit/auth-token.js/issues" + }, + "dependencies": { + "@octokit/types": "^6.0.0" + }, + "description": "GitHub API token authentication for browsers and Node.js", + "devDependencies": { + "@octokit/core": "^3.0.0", + "@octokit/request": "^5.3.0", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/fetch-mock": "^7.3.1", + "@types/jest": "^26.0.0", + "fetch-mock": "^9.0.0", + "jest": "^25.1.0", + "semantic-release": "^17.0.0", + "ts-jest": "^25.1.0", + "typescript": "^3.7.2" + }, + "files": [ + "dist-*/", + "bin/" + ], + "homepage": "https://github.com/octokit/auth-token.js#readme", + "keywords": [ + "github", + "octokit", + "authentication", + "api" + ], + "license": "MIT", + "main": "dist-node/index.js", + "module": "dist-web/index.js", + "name": "@octokit/auth-token", + "pika": true, + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/octokit/auth-token.js.git" + }, + "sideEffects": false, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "version": "2.4.4" +} diff --git a/node_modules/end-of-stream/LICENSE b/node_modules/@octokit/core/LICENSE similarity index 93% rename from node_modules/end-of-stream/LICENSE rename to node_modules/@octokit/core/LICENSE index 757562e..ef2c18e 100644 --- a/node_modules/end-of-stream/LICENSE +++ b/node_modules/@octokit/core/LICENSE @@ -1,6 +1,6 @@ -The MIT License (MIT) +The MIT License -Copyright (c) 2014 Mathias Buus +Copyright (c) 2019 Octokit contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. \ No newline at end of file +THE SOFTWARE. diff --git a/node_modules/@octokit/core/README.md b/node_modules/@octokit/core/README.md new file mode 100644 index 0000000..80804b7 --- /dev/null +++ b/node_modules/@octokit/core/README.md @@ -0,0 +1,438 @@ +# core.js + +> Extendable client for GitHub's REST & GraphQL APIs + +[![@latest](https://img.shields.io/npm/v/@octokit/core.svg)](https://www.npmjs.com/package/@octokit/core) +[![Build Status](https://github.com/octokit/core.js/workflows/Test/badge.svg)](https://github.com/octokit/core.js/actions?query=workflow%3ATest+branch%3Amaster) + + + +- [Usage](#usage) + - [REST API example](#rest-api-example) + - [GraphQL example](#graphql-example) +- [Options](#options) +- [Defaults](#defaults) +- [Authentication](#authentication) +- [Logging](#logging) +- [Hooks](#hooks) +- [Plugins](#plugins) +- [Build your own Octokit with Plugins and Defaults](#build-your-own-octokit-with-plugins-and-defaults) +- [LICENSE](#license) + + + +If you need a minimalistic library to utilize GitHub's [REST API](https://developer.github.com/v3/) and [GraphQL API](https://developer.github.com/v4/) which you can extend with plugins as needed, then `@octokit/core` is a great starting point. + +If you don't need the Plugin API then using [`@octokit/request`](https://github.com/octokit/request.js/) or [`@octokit/graphql`](https://github.com/octokit/graphql.js/) directly is a good alternative. + +## Usage + + + + + + +
+Browsers + +Load @octokit/core directly from cdn.skypack.dev + +```html + +``` + +
+Node + + +Install with npm install @octokit/core + +```js +const { Octokit } = require("@octokit/core"); +// or: import { Octokit } from "@octokit/core"; +``` + +
+ +### REST API example + +```js +// Create a personal access token at https://github.com/settings/tokens/new?scopes=repo +const octokit = new Octokit({ auth: `personal-access-token123` }); + +const response = await octokit.request("GET /orgs/{org}/repos", { + org: "octokit", + type: "private", +}); +``` + +See [`@octokit/request`](https://github.com/octokit/request.js) for full documentation of the `.request` method. + +### GraphQL example + +```js +const octokit = new Octokit({ auth: `secret123` }); + +const response = await octokit.graphql( + `query ($login: String!) { + organization(login: $login) { + repositories(privacy: PRIVATE) { + totalCount + } + } + }`, + { login: "octokit" } +); +``` + +See [`@octokit/graphql`](https://github.com/octokit/graphql.js) for full documentation of the `.graphql` method. + +## Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ name + + type + + description +
+ options.authStrategy + + Function + + Defaults to @octokit/auth-token. See Authentication below for examples. +
+ options.auth + + String or Object + + See Authentication below for examples. +
+ options.baseUrl + + String + + +When using with GitHub Enterprise Server, set `options.baseUrl` to the root URL of the API. For example, if your GitHub Enterprise Server's hostname is `github.acme-inc.com`, then set `options.baseUrl` to `https://github.acme-inc.com/api/v3`. Example + +```js +const octokit = new Octokit({ + baseUrl: "https://github.acme-inc.com/api/v3", +}); +``` + +
+ options.previews + + Array of Strings + + +Some REST API endpoints require preview headers to be set, or enable +additional features. Preview headers can be set on a per-request basis, e.g. + +```js +octokit.request("POST /repos/{owner}/{repo}/pulls", { + mediaType: { + previews: ["shadow-cat"], + }, + owner, + repo, + title: "My pull request", + base: "master", + head: "my-feature", + draft: true, +}); +``` + +You can also set previews globally, by setting the `options.previews` option on the constructor. Example: + +```js +const octokit = new Octokit({ + previews: ["shadow-cat"], +}); +``` + +
+ options.request + + Object + + +Set a default request timeout (`options.request.timeout`) or an [`http(s).Agent`](https://nodejs.org/api/http.html#http_class_http_agent) e.g. for proxy usage (Node only, `options.request.agent`). + +There are more `options.request.*` options, see [`@octokit/request` options](https://github.com/octokit/request.js#request). `options.request` can also be set on a per-request basis. + +
+ options.timeZone + + String + + +Sets the `Time-Zone` header which defines a timezone according to the [list of names from the Olson database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + +```js +const octokit = new Octokit({ + timeZone: "America/Los_Angeles", +}); +``` + +The time zone header will determine the timezone used for generating the timestamp when creating commits. See [GitHub's Timezones documentation](https://developer.github.com/v3/#timezones). + +
+ options.userAgent + + String + + +A custom user agent string for your app or library. Example + +```js +const octokit = new Octokit({ + userAgent: "my-app/v1.2.3", +}); +``` + +
+ +## Defaults + +You can create a new Octokit class with customized default options. + +```js +const MyOctokit = Octokit.defaults({ + auth: "personal-access-token123", + baseUrl: "https://github.acme-inc.com/api/v3", + userAgent: "my-app/v1.2.3", +}); +const octokit1 = new MyOctokit(); +const octokit2 = new MyOctokit(); +``` + +If you pass additional options to your new constructor, the options will be merged shallowly. + +```js +const MyOctokit = Octokit.defaults({ + foo: { + opt1: 1, + }, +}); +const octokit = new MyOctokit({ + foo: { + opt2: 1, + }, +}); +// options will be { foo: { opt2: 1 }} +``` + +If you need a deep or conditional merge, you can pass a function instead. + +```js +const MyOctokit = Octokit.defaults((options) => { + return { + foo: Object.assign({}, options.foo, { opt2: 1 }), + }; +}); +const octokit = new MyOctokit({ + foo: { opt2: 1 }, +}); +// options will be { foo: { opt1: 1, opt2: 1 }} +``` + +Be careful about mutating the `options` object in the `Octokit.defaults` callback, as it can have unforeseen consequences. + +## Authentication + +Authentication is optional for some REST API endpoints accessing public data, but is required for GraphQL queries. Using authentication also increases your [API rate limit](https://developer.github.com/v3/#rate-limiting). + +By default, Octokit authenticates using the [token authentication strategy](https://github.com/octokit/auth-token.js). Pass in a token using `options.auth`. It can be a personal access token, an OAuth token, an installation access token or a JSON Web Token for GitHub App authentication. The `Authorization` header will be set according to the type of token. + +```js +import { Octokit } from "@octokit/core"; + +const octokit = new Octokit({ + auth: "mypersonalaccesstoken123", +}); + +const { data } = await octokit.request("/user"); +``` + +To use a different authentication strategy, set `options.authStrategy`. A set of officially supported authentication strategies can be retrieved from [`@octokit/auth`](https://github.com/octokit/auth-app.js#readme). Example + +```js +import { Octokit } from "@octokit/core"; +import { createAppAuth } from "@octokit/auth-app"; + +const appOctokit = new Octokit({ + authStrategy: createAppAuth, + auth: { + appId: 123, + privateKey: process.env.PRIVATE_KEY, + }, +}); + +const { data } = await appOctokit.request("/app"); +``` + +The `.auth()` method returned by the current authentication strategy can be accessed at `octokit.auth()`. Example + +```js +const { token } = await appOctokit.auth({ + type: "installation", + installationId: 123, +}); +``` + +## Logging + +There are four built-in log methods + +1. `octokit.log.debug(message[, additionalInfo])` +1. `octokit.log.info(message[, additionalInfo])` +1. `octokit.log.warn(message[, additionalInfo])` +1. `octokit.log.error(message[, additionalInfo])` + +They can be configured using the [`log` client option](client-options). By default, `octokit.log.debug()` and `octokit.log.info()` are no-ops, while the other two call `console.warn()` and `console.error()` respectively. + +This is useful if you build reusable [plugins](#plugins). + +If you would like to make the log level configurable using an environment variable or external option, we recommend the [console-log-level](https://github.com/watson/console-log-level) package. Example + +```js +const octokit = new Octokit({ + log: require("console-log-level")({ level: "info" }), +}); +``` + +## Hooks + +You can customize Octokit's request lifecycle with hooks. + +```js +octokit.hook.before("request", async (options) => { + validate(options); +}); +octokit.hook.after("request", async (response, options) => { + console.log(`${options.method} ${options.url}: ${response.status}`); +}); +octokit.hook.error("request", async (error, options) => { + if (error.status === 304) { + return findInCache(error.headers.etag); + } + + throw error; +}); +octokit.hook.wrap("request", async (request, options) => { + // add logic before, after, catch errors or replace the request altogether + return request(options); +}); +``` + +See [before-after-hook](https://github.com/gr2m/before-after-hook#readme) for more documentation on hooks. + +## Plugins + +Octokit’s functionality can be extended using plugins. The `Octokit.plugin()` method accepts a plugin (or many) and returns a new constructor. + +A plugin is a function which gets two arguments: + +1. the current instance +2. the options passed to the constructor. + +In order to extend `octokit`'s API, the plugin must return an object with the new methods. + +```js +// index.js +const { Octokit } = require("@octokit/core") +const MyOctokit = Octokit.plugin( + require("./lib/my-plugin"), + require("octokit-plugin-example") +); + +const octokit = new MyOctokit({ greeting: "Moin moin" }); +octokit.helloWorld(); // logs "Moin moin, world!" +octokit.request("GET /"); // logs "GET / - 200 in 123ms" + +// lib/my-plugin.js +module.exports = (octokit, options = { greeting: "Hello" }) => { + // hook into the request lifecycle + octokit.hook.wrap("request", async (request, options) => { + const time = Date.now(); + const response = await request(options); + console.log( + `${options.method} ${options.url} – ${response.status} in ${Date.now() - + time}ms` + ); + return response; + }); + + // add a custom method + return { + helloWorld: () => console.log(`${options.greeting}, world!`); + } +}; +``` + +## Build your own Octokit with Plugins and Defaults + +You can build your own Octokit class with preset default options and plugins. In fact, this is mostly how the `@octokit/` modules work, such as [`@octokit/action`](https://github.com/octokit/action.js): + +```js +const { Octokit } = require("@octokit/core"); +const MyActionOctokit = Octokit.plugin( + require("@octokit/plugin-paginate-rest"), + require("@octokit/plugin-throttling"), + require("@octokit/plugin-retry") +).defaults({ + authStrategy: require("@octokit/auth-action"), + userAgent: `my-octokit-action/v1.2.3`, +}); + +const octokit = new MyActionOctokit(); +const installations = await octokit.paginate("GET /app/installations"); +``` + +## LICENSE + +[MIT](LICENSE) diff --git a/node_modules/@octokit/core/dist-node/index.js b/node_modules/@octokit/core/dist-node/index.js new file mode 100644 index 0000000..ad20c99 --- /dev/null +++ b/node_modules/@octokit/core/dist-node/index.js @@ -0,0 +1,174 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +var universalUserAgent = require('universal-user-agent'); +var beforeAfterHook = require('before-after-hook'); +var request = require('@octokit/request'); +var graphql = require('@octokit/graphql'); +var authToken = require('@octokit/auth-token'); + +function _objectWithoutPropertiesLoose(source, excluded) { + if (source == null) return {}; + var target = {}; + var sourceKeys = Object.keys(source); + var key, i; + + for (i = 0; i < sourceKeys.length; i++) { + key = sourceKeys[i]; + if (excluded.indexOf(key) >= 0) continue; + target[key] = source[key]; + } + + return target; +} + +function _objectWithoutProperties(source, excluded) { + if (source == null) return {}; + + var target = _objectWithoutPropertiesLoose(source, excluded); + + var key, i; + + if (Object.getOwnPropertySymbols) { + var sourceSymbolKeys = Object.getOwnPropertySymbols(source); + + for (i = 0; i < sourceSymbolKeys.length; i++) { + key = sourceSymbolKeys[i]; + if (excluded.indexOf(key) >= 0) continue; + if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; + target[key] = source[key]; + } + } + + return target; +} + +const VERSION = "3.2.4"; + +class Octokit { + constructor(options = {}) { + const hook = new beforeAfterHook.Collection(); + const requestDefaults = { + baseUrl: request.request.endpoint.DEFAULTS.baseUrl, + headers: {}, + request: Object.assign({}, options.request, { + hook: hook.bind(null, "request") + }), + mediaType: { + previews: [], + format: "" + } + }; // prepend default user agent with `options.userAgent` if set + + requestDefaults.headers["user-agent"] = [options.userAgent, `octokit-core.js/${VERSION} ${universalUserAgent.getUserAgent()}`].filter(Boolean).join(" "); + + if (options.baseUrl) { + requestDefaults.baseUrl = options.baseUrl; + } + + if (options.previews) { + requestDefaults.mediaType.previews = options.previews; + } + + if (options.timeZone) { + requestDefaults.headers["time-zone"] = options.timeZone; + } + + this.request = request.request.defaults(requestDefaults); + this.graphql = graphql.withCustomRequest(this.request).defaults(requestDefaults); + this.log = Object.assign({ + debug: () => {}, + info: () => {}, + warn: console.warn.bind(console), + error: console.error.bind(console) + }, options.log); + this.hook = hook; // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance + // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered. + // (2) If only `options.auth` is set, use the default token authentication strategy. + // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance. + // TODO: type `options.auth` based on `options.authStrategy`. + + if (!options.authStrategy) { + if (!options.auth) { + // (1) + this.auth = async () => ({ + type: "unauthenticated" + }); + } else { + // (2) + const auth = authToken.createTokenAuth(options.auth); // @ts-ignore ¯\_(ツ)_/¯ + + hook.wrap("request", auth.hook); + this.auth = auth; + } + } else { + const { + authStrategy + } = options, + otherOptions = _objectWithoutProperties(options, ["authStrategy"]); + + const auth = authStrategy(Object.assign({ + request: this.request, + log: this.log, + // we pass the current octokit instance as well as its constructor options + // to allow for authentication strategies that return a new octokit instance + // that shares the same internal state as the current one. The original + // requirement for this was the "event-octokit" authentication strategy + // of https://github.com/probot/octokit-auth-probot. + octokit: this, + octokitOptions: otherOptions + }, options.auth)); // @ts-ignore ¯\_(ツ)_/¯ + + hook.wrap("request", auth.hook); + this.auth = auth; + } // apply plugins + // https://stackoverflow.com/a/16345172 + + + const classConstructor = this.constructor; + classConstructor.plugins.forEach(plugin => { + Object.assign(this, plugin(this, options)); + }); + } + + static defaults(defaults) { + const OctokitWithDefaults = class extends this { + constructor(...args) { + const options = args[0] || {}; + + if (typeof defaults === "function") { + super(defaults(options)); + return; + } + + super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent ? { + userAgent: `${options.userAgent} ${defaults.userAgent}` + } : null)); + } + + }; + return OctokitWithDefaults; + } + /** + * Attach a plugin (or many) to your Octokit instance. + * + * @example + * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...) + */ + + + static plugin(...newPlugins) { + var _a; + + const currentPlugins = this.plugins; + const NewOctokit = (_a = class extends this {}, _a.plugins = currentPlugins.concat(newPlugins.filter(plugin => !currentPlugins.includes(plugin))), _a); + return NewOctokit; + } + +} +Octokit.VERSION = VERSION; +Octokit.plugins = []; + +exports.Octokit = Octokit; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/core/dist-node/index.js.map b/node_modules/@octokit/core/dist-node/index.js.map new file mode 100644 index 0000000..5cc887b --- /dev/null +++ b/node_modules/@octokit/core/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"3.2.4\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { Collection } from \"before-after-hook\";\nimport { request } from \"@octokit/request\";\nimport { withCustomRequest } from \"@octokit/graphql\";\nimport { createTokenAuth } from \"@octokit/auth-token\";\nimport { VERSION } from \"./version\";\nexport class Octokit {\n constructor(options = {}) {\n const hook = new Collection();\n const requestDefaults = {\n baseUrl: request.endpoint.DEFAULTS.baseUrl,\n headers: {},\n request: Object.assign({}, options.request, {\n hook: hook.bind(null, \"request\"),\n }),\n mediaType: {\n previews: [],\n format: \"\",\n },\n };\n // prepend default user agent with `options.userAgent` if set\n requestDefaults.headers[\"user-agent\"] = [\n options.userAgent,\n `octokit-core.js/${VERSION} ${getUserAgent()}`,\n ]\n .filter(Boolean)\n .join(\" \");\n if (options.baseUrl) {\n requestDefaults.baseUrl = options.baseUrl;\n }\n if (options.previews) {\n requestDefaults.mediaType.previews = options.previews;\n }\n if (options.timeZone) {\n requestDefaults.headers[\"time-zone\"] = options.timeZone;\n }\n this.request = request.defaults(requestDefaults);\n this.graphql = withCustomRequest(this.request).defaults(requestDefaults);\n this.log = Object.assign({\n debug: () => { },\n info: () => { },\n warn: console.warn.bind(console),\n error: console.error.bind(console),\n }, options.log);\n this.hook = hook;\n // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance\n // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered.\n // (2) If only `options.auth` is set, use the default token authentication strategy.\n // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance.\n // TODO: type `options.auth` based on `options.authStrategy`.\n if (!options.authStrategy) {\n if (!options.auth) {\n // (1)\n this.auth = async () => ({\n type: \"unauthenticated\",\n });\n }\n else {\n // (2)\n const auth = createTokenAuth(options.auth);\n // @ts-ignore ¯\\_(ツ)_/¯\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n }\n else {\n const { authStrategy, ...otherOptions } = options;\n const auth = authStrategy(Object.assign({\n request: this.request,\n log: this.log,\n // we pass the current octokit instance as well as its constructor options\n // to allow for authentication strategies that return a new octokit instance\n // that shares the same internal state as the current one. The original\n // requirement for this was the \"event-octokit\" authentication strategy\n // of https://github.com/probot/octokit-auth-probot.\n octokit: this,\n octokitOptions: otherOptions,\n }, options.auth));\n // @ts-ignore ¯\\_(ツ)_/¯\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n // apply plugins\n // https://stackoverflow.com/a/16345172\n const classConstructor = this.constructor;\n classConstructor.plugins.forEach((plugin) => {\n Object.assign(this, plugin(this, options));\n });\n }\n static defaults(defaults) {\n const OctokitWithDefaults = class extends this {\n constructor(...args) {\n const options = args[0] || {};\n if (typeof defaults === \"function\") {\n super(defaults(options));\n return;\n }\n super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent\n ? {\n userAgent: `${options.userAgent} ${defaults.userAgent}`,\n }\n : null));\n }\n };\n return OctokitWithDefaults;\n }\n /**\n * Attach a plugin (or many) to your Octokit instance.\n *\n * @example\n * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)\n */\n static plugin(...newPlugins) {\n var _a;\n const currentPlugins = this.plugins;\n const NewOctokit = (_a = class extends this {\n },\n _a.plugins = currentPlugins.concat(newPlugins.filter((plugin) => !currentPlugins.includes(plugin))),\n _a);\n return NewOctokit;\n }\n}\nOctokit.VERSION = VERSION;\nOctokit.plugins = [];\n"],"names":["VERSION","Octokit","constructor","options","hook","Collection","requestDefaults","baseUrl","request","endpoint","DEFAULTS","headers","Object","assign","bind","mediaType","previews","format","userAgent","getUserAgent","filter","Boolean","join","timeZone","defaults","graphql","withCustomRequest","log","debug","info","warn","console","error","authStrategy","auth","type","createTokenAuth","wrap","otherOptions","octokit","octokitOptions","classConstructor","plugins","forEach","plugin","OctokitWithDefaults","args","newPlugins","_a","currentPlugins","NewOctokit","concat","includes"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACMA,MAAMC,OAAN,CAAc;AACjBC,EAAAA,WAAW,CAACC,OAAO,GAAG,EAAX,EAAe;AACtB,UAAMC,IAAI,GAAG,IAAIC,0BAAJ,EAAb;AACA,UAAMC,eAAe,GAAG;AACpBC,MAAAA,OAAO,EAAEC,eAAO,CAACC,QAAR,CAAiBC,QAAjB,CAA0BH,OADf;AAEpBI,MAAAA,OAAO,EAAE,EAFW;AAGpBH,MAAAA,OAAO,EAAEI,MAAM,CAACC,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACK,OAA1B,EAAmC;AACxCJ,QAAAA,IAAI,EAAEA,IAAI,CAACU,IAAL,CAAU,IAAV,EAAgB,SAAhB;AADkC,OAAnC,CAHW;AAMpBC,MAAAA,SAAS,EAAE;AACPC,QAAAA,QAAQ,EAAE,EADH;AAEPC,QAAAA,MAAM,EAAE;AAFD;AANS,KAAxB,CAFsB;;AActBX,IAAAA,eAAe,CAACK,OAAhB,CAAwB,YAAxB,IAAwC,CACpCR,OAAO,CAACe,SAD4B,EAEnC,mBAAkBlB,OAAQ,IAAGmB,+BAAY,EAAG,EAFT,EAInCC,MAJmC,CAI5BC,OAJ4B,EAKnCC,IALmC,CAK9B,GAL8B,CAAxC;;AAMA,QAAInB,OAAO,CAACI,OAAZ,EAAqB;AACjBD,MAAAA,eAAe,CAACC,OAAhB,GAA0BJ,OAAO,CAACI,OAAlC;AACH;;AACD,QAAIJ,OAAO,CAACa,QAAZ,EAAsB;AAClBV,MAAAA,eAAe,CAACS,SAAhB,CAA0BC,QAA1B,GAAqCb,OAAO,CAACa,QAA7C;AACH;;AACD,QAAIb,OAAO,CAACoB,QAAZ,EAAsB;AAClBjB,MAAAA,eAAe,CAACK,OAAhB,CAAwB,WAAxB,IAAuCR,OAAO,CAACoB,QAA/C;AACH;;AACD,SAAKf,OAAL,GAAeA,eAAO,CAACgB,QAAR,CAAiBlB,eAAjB,CAAf;AACA,SAAKmB,OAAL,GAAeC,yBAAiB,CAAC,KAAKlB,OAAN,CAAjB,CAAgCgB,QAAhC,CAAyClB,eAAzC,CAAf;AACA,SAAKqB,GAAL,GAAWf,MAAM,CAACC,MAAP,CAAc;AACrBe,MAAAA,KAAK,EAAE,MAAM,EADQ;AAErBC,MAAAA,IAAI,EAAE,MAAM,EAFS;AAGrBC,MAAAA,IAAI,EAAEC,OAAO,CAACD,IAAR,CAAahB,IAAb,CAAkBiB,OAAlB,CAHe;AAIrBC,MAAAA,KAAK,EAAED,OAAO,CAACC,KAAR,CAAclB,IAAd,CAAmBiB,OAAnB;AAJc,KAAd,EAKR5B,OAAO,CAACwB,GALA,CAAX;AAMA,SAAKvB,IAAL,GAAYA,IAAZ,CArCsB;AAuCtB;AACA;AACA;AACA;;AACA,QAAI,CAACD,OAAO,CAAC8B,YAAb,EAA2B;AACvB,UAAI,CAAC9B,OAAO,CAAC+B,IAAb,EAAmB;AACf;AACA,aAAKA,IAAL,GAAY,aAAa;AACrBC,UAAAA,IAAI,EAAE;AADe,SAAb,CAAZ;AAGH,OALD,MAMK;AACD;AACA,cAAMD,IAAI,GAAGE,yBAAe,CAACjC,OAAO,CAAC+B,IAAT,CAA5B,CAFC;;AAID9B,QAAAA,IAAI,CAACiC,IAAL,CAAU,SAAV,EAAqBH,IAAI,CAAC9B,IAA1B;AACA,aAAK8B,IAAL,GAAYA,IAAZ;AACH;AACJ,KAdD,MAeK;AACD,YAAM;AAAED,QAAAA;AAAF,UAAoC9B,OAA1C;AAAA,YAAyBmC,YAAzB,4BAA0CnC,OAA1C;;AACA,YAAM+B,IAAI,GAAGD,YAAY,CAACrB,MAAM,CAACC,MAAP,CAAc;AACpCL,QAAAA,OAAO,EAAE,KAAKA,OADsB;AAEpCmB,QAAAA,GAAG,EAAE,KAAKA,GAF0B;AAGpC;AACA;AACA;AACA;AACA;AACAY,QAAAA,OAAO,EAAE,IAR2B;AASpCC,QAAAA,cAAc,EAAEF;AAToB,OAAd,EAUvBnC,OAAO,CAAC+B,IAVe,CAAD,CAAzB,CAFC;;AAcD9B,MAAAA,IAAI,CAACiC,IAAL,CAAU,SAAV,EAAqBH,IAAI,CAAC9B,IAA1B;AACA,WAAK8B,IAAL,GAAYA,IAAZ;AACH,KA1EqB;AA4EtB;;;AACA,UAAMO,gBAAgB,GAAG,KAAKvC,WAA9B;AACAuC,IAAAA,gBAAgB,CAACC,OAAjB,CAAyBC,OAAzB,CAAkCC,MAAD,IAAY;AACzChC,MAAAA,MAAM,CAACC,MAAP,CAAc,IAAd,EAAoB+B,MAAM,CAAC,IAAD,EAAOzC,OAAP,CAA1B;AACH,KAFD;AAGH;;AACD,SAAOqB,QAAP,CAAgBA,QAAhB,EAA0B;AACtB,UAAMqB,mBAAmB,GAAG,cAAc,IAAd,CAAmB;AAC3C3C,MAAAA,WAAW,CAAC,GAAG4C,IAAJ,EAAU;AACjB,cAAM3C,OAAO,GAAG2C,IAAI,CAAC,CAAD,CAAJ,IAAW,EAA3B;;AACA,YAAI,OAAOtB,QAAP,KAAoB,UAAxB,EAAoC;AAChC,gBAAMA,QAAQ,CAACrB,OAAD,CAAd;AACA;AACH;;AACD,cAAMS,MAAM,CAACC,MAAP,CAAc,EAAd,EAAkBW,QAAlB,EAA4BrB,OAA5B,EAAqCA,OAAO,CAACe,SAAR,IAAqBM,QAAQ,CAACN,SAA9B,GACrC;AACEA,UAAAA,SAAS,EAAG,GAAEf,OAAO,CAACe,SAAU,IAAGM,QAAQ,CAACN,SAAU;AADxD,SADqC,GAIrC,IAJA,CAAN;AAKH;;AAZ0C,KAA/C;AAcA,WAAO2B,mBAAP;AACH;AACD;AACJ;AACA;AACA;AACA;AACA;;;AACI,SAAOD,MAAP,CAAc,GAAGG,UAAjB,EAA6B;AACzB,QAAIC,EAAJ;;AACA,UAAMC,cAAc,GAAG,KAAKP,OAA5B;AACA,UAAMQ,UAAU,IAAIF,EAAE,GAAG,cAAc,IAAd,CAAmB,EAAxB,EAEhBA,EAAE,CAACN,OAAH,GAAaO,cAAc,CAACE,MAAf,CAAsBJ,UAAU,CAAC3B,MAAX,CAAmBwB,MAAD,IAAY,CAACK,cAAc,CAACG,QAAf,CAAwBR,MAAxB,CAA/B,CAAtB,CAFG,EAGhBI,EAHY,CAAhB;AAIA,WAAOE,UAAP;AACH;;AAlHgB;AAoHrBjD,OAAO,CAACD,OAAR,GAAkBA,OAAlB;AACAC,OAAO,CAACyC,OAAR,GAAkB,EAAlB;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/core/dist-src/index.js b/node_modules/@octokit/core/dist-src/index.js new file mode 100644 index 0000000..75fd2ff --- /dev/null +++ b/node_modules/@octokit/core/dist-src/index.js @@ -0,0 +1,124 @@ +import { getUserAgent } from "universal-user-agent"; +import { Collection } from "before-after-hook"; +import { request } from "@octokit/request"; +import { withCustomRequest } from "@octokit/graphql"; +import { createTokenAuth } from "@octokit/auth-token"; +import { VERSION } from "./version"; +export class Octokit { + constructor(options = {}) { + const hook = new Collection(); + const requestDefaults = { + baseUrl: request.endpoint.DEFAULTS.baseUrl, + headers: {}, + request: Object.assign({}, options.request, { + hook: hook.bind(null, "request"), + }), + mediaType: { + previews: [], + format: "", + }, + }; + // prepend default user agent with `options.userAgent` if set + requestDefaults.headers["user-agent"] = [ + options.userAgent, + `octokit-core.js/${VERSION} ${getUserAgent()}`, + ] + .filter(Boolean) + .join(" "); + if (options.baseUrl) { + requestDefaults.baseUrl = options.baseUrl; + } + if (options.previews) { + requestDefaults.mediaType.previews = options.previews; + } + if (options.timeZone) { + requestDefaults.headers["time-zone"] = options.timeZone; + } + this.request = request.defaults(requestDefaults); + this.graphql = withCustomRequest(this.request).defaults(requestDefaults); + this.log = Object.assign({ + debug: () => { }, + info: () => { }, + warn: console.warn.bind(console), + error: console.error.bind(console), + }, options.log); + this.hook = hook; + // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance + // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered. + // (2) If only `options.auth` is set, use the default token authentication strategy. + // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance. + // TODO: type `options.auth` based on `options.authStrategy`. + if (!options.authStrategy) { + if (!options.auth) { + // (1) + this.auth = async () => ({ + type: "unauthenticated", + }); + } + else { + // (2) + const auth = createTokenAuth(options.auth); + // @ts-ignore ¯\_(ツ)_/¯ + hook.wrap("request", auth.hook); + this.auth = auth; + } + } + else { + const { authStrategy, ...otherOptions } = options; + const auth = authStrategy(Object.assign({ + request: this.request, + log: this.log, + // we pass the current octokit instance as well as its constructor options + // to allow for authentication strategies that return a new octokit instance + // that shares the same internal state as the current one. The original + // requirement for this was the "event-octokit" authentication strategy + // of https://github.com/probot/octokit-auth-probot. + octokit: this, + octokitOptions: otherOptions, + }, options.auth)); + // @ts-ignore ¯\_(ツ)_/¯ + hook.wrap("request", auth.hook); + this.auth = auth; + } + // apply plugins + // https://stackoverflow.com/a/16345172 + const classConstructor = this.constructor; + classConstructor.plugins.forEach((plugin) => { + Object.assign(this, plugin(this, options)); + }); + } + static defaults(defaults) { + const OctokitWithDefaults = class extends this { + constructor(...args) { + const options = args[0] || {}; + if (typeof defaults === "function") { + super(defaults(options)); + return; + } + super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent + ? { + userAgent: `${options.userAgent} ${defaults.userAgent}`, + } + : null)); + } + }; + return OctokitWithDefaults; + } + /** + * Attach a plugin (or many) to your Octokit instance. + * + * @example + * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...) + */ + static plugin(...newPlugins) { + var _a; + const currentPlugins = this.plugins; + const NewOctokit = (_a = class extends this { + }, + _a.plugins = currentPlugins.concat(newPlugins.filter((plugin) => !currentPlugins.includes(plugin))), + _a); + return NewOctokit; + } +} +Octokit.VERSION = VERSION; +Octokit.plugins = []; diff --git a/node_modules/@octokit/core/dist-src/types.js b/node_modules/@octokit/core/dist-src/types.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/core/dist-src/types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/core/dist-src/version.js b/node_modules/@octokit/core/dist-src/version.js new file mode 100644 index 0000000..a02a767 --- /dev/null +++ b/node_modules/@octokit/core/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "3.2.4"; diff --git a/node_modules/@octokit/core/dist-types/index.d.ts b/node_modules/@octokit/core/dist-types/index.d.ts new file mode 100644 index 0000000..1033622 --- /dev/null +++ b/node_modules/@octokit/core/dist-types/index.d.ts @@ -0,0 +1,40 @@ +import { HookCollection } from "before-after-hook"; +import { request } from "@octokit/request"; +import { graphql } from "@octokit/graphql"; +import { Constructor, OctokitOptions, OctokitPlugin, ReturnTypeOf, UnionToIntersection } from "./types"; +export declare class Octokit { + static VERSION: string; + static defaults>(this: S, defaults: OctokitOptions | Function): { + new (...args: any[]): { + [x: string]: any; + }; + } & S; + static plugins: OctokitPlugin[]; + /** + * Attach a plugin (or many) to your Octokit instance. + * + * @example + * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...) + */ + static plugin & { + plugins: any[]; + }, T extends OctokitPlugin[]>(this: S, ...newPlugins: T): { + new (...args: any[]): { + [x: string]: any; + }; + plugins: any[]; + } & S & Constructor>>; + constructor(options?: OctokitOptions); + request: typeof request; + graphql: typeof graphql; + log: { + debug: (message: string, additionalInfo?: object) => any; + info: (message: string, additionalInfo?: object) => any; + warn: (message: string, additionalInfo?: object) => any; + error: (message: string, additionalInfo?: object) => any; + [key: string]: any; + }; + hook: HookCollection; + auth: (...args: unknown[]) => Promise; + [key: string]: any; +} diff --git a/node_modules/@octokit/core/dist-types/types.d.ts b/node_modules/@octokit/core/dist-types/types.d.ts new file mode 100644 index 0000000..59b284e --- /dev/null +++ b/node_modules/@octokit/core/dist-types/types.d.ts @@ -0,0 +1,31 @@ +import * as OctokitTypes from "@octokit/types"; +import { Octokit } from "."; +export declare type RequestParameters = OctokitTypes.RequestParameters; +export declare type OctokitOptions = { + authStrategy?: any; + auth?: any; + userAgent?: string; + previews?: string[]; + baseUrl?: string; + log?: { + debug: (message: string) => unknown; + info: (message: string) => unknown; + warn: (message: string) => unknown; + error: (message: string) => unknown; + }; + request?: OctokitTypes.RequestRequestOptions; + timeZone?: string; + [option: string]: any; +}; +export declare type Constructor = new (...args: any[]) => T; +export declare type ReturnTypeOf = T extends AnyFunction ? ReturnType : T extends AnyFunction[] ? UnionToIntersection> : never; +/** + * @author https://stackoverflow.com/users/2887218/jcalz + * @see https://stackoverflow.com/a/50375286/10325032 + */ +export declare type UnionToIntersection = (Union extends any ? (argument: Union) => void : never) extends (argument: infer Intersection) => void ? Intersection : never; +declare type AnyFunction = (...args: any) => any; +export declare type OctokitPlugin = (octokit: Octokit, options: OctokitOptions) => { + [key: string]: any; +} | void; +export {}; diff --git a/node_modules/@octokit/core/dist-types/version.d.ts b/node_modules/@octokit/core/dist-types/version.d.ts new file mode 100644 index 0000000..11e8fb4 --- /dev/null +++ b/node_modules/@octokit/core/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "3.2.4"; diff --git a/node_modules/@octokit/core/dist-web/index.js b/node_modules/@octokit/core/dist-web/index.js new file mode 100644 index 0000000..2a85823 --- /dev/null +++ b/node_modules/@octokit/core/dist-web/index.js @@ -0,0 +1,129 @@ +import { getUserAgent } from 'universal-user-agent'; +import { Collection } from 'before-after-hook'; +import { request } from '@octokit/request'; +import { withCustomRequest } from '@octokit/graphql'; +import { createTokenAuth } from '@octokit/auth-token'; + +const VERSION = "3.2.4"; + +class Octokit { + constructor(options = {}) { + const hook = new Collection(); + const requestDefaults = { + baseUrl: request.endpoint.DEFAULTS.baseUrl, + headers: {}, + request: Object.assign({}, options.request, { + hook: hook.bind(null, "request"), + }), + mediaType: { + previews: [], + format: "", + }, + }; + // prepend default user agent with `options.userAgent` if set + requestDefaults.headers["user-agent"] = [ + options.userAgent, + `octokit-core.js/${VERSION} ${getUserAgent()}`, + ] + .filter(Boolean) + .join(" "); + if (options.baseUrl) { + requestDefaults.baseUrl = options.baseUrl; + } + if (options.previews) { + requestDefaults.mediaType.previews = options.previews; + } + if (options.timeZone) { + requestDefaults.headers["time-zone"] = options.timeZone; + } + this.request = request.defaults(requestDefaults); + this.graphql = withCustomRequest(this.request).defaults(requestDefaults); + this.log = Object.assign({ + debug: () => { }, + info: () => { }, + warn: console.warn.bind(console), + error: console.error.bind(console), + }, options.log); + this.hook = hook; + // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance + // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered. + // (2) If only `options.auth` is set, use the default token authentication strategy. + // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance. + // TODO: type `options.auth` based on `options.authStrategy`. + if (!options.authStrategy) { + if (!options.auth) { + // (1) + this.auth = async () => ({ + type: "unauthenticated", + }); + } + else { + // (2) + const auth = createTokenAuth(options.auth); + // @ts-ignore ¯\_(ツ)_/¯ + hook.wrap("request", auth.hook); + this.auth = auth; + } + } + else { + const { authStrategy, ...otherOptions } = options; + const auth = authStrategy(Object.assign({ + request: this.request, + log: this.log, + // we pass the current octokit instance as well as its constructor options + // to allow for authentication strategies that return a new octokit instance + // that shares the same internal state as the current one. The original + // requirement for this was the "event-octokit" authentication strategy + // of https://github.com/probot/octokit-auth-probot. + octokit: this, + octokitOptions: otherOptions, + }, options.auth)); + // @ts-ignore ¯\_(ツ)_/¯ + hook.wrap("request", auth.hook); + this.auth = auth; + } + // apply plugins + // https://stackoverflow.com/a/16345172 + const classConstructor = this.constructor; + classConstructor.plugins.forEach((plugin) => { + Object.assign(this, plugin(this, options)); + }); + } + static defaults(defaults) { + const OctokitWithDefaults = class extends this { + constructor(...args) { + const options = args[0] || {}; + if (typeof defaults === "function") { + super(defaults(options)); + return; + } + super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent + ? { + userAgent: `${options.userAgent} ${defaults.userAgent}`, + } + : null)); + } + }; + return OctokitWithDefaults; + } + /** + * Attach a plugin (or many) to your Octokit instance. + * + * @example + * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...) + */ + static plugin(...newPlugins) { + var _a; + const currentPlugins = this.plugins; + const NewOctokit = (_a = class extends this { + }, + _a.plugins = currentPlugins.concat(newPlugins.filter((plugin) => !currentPlugins.includes(plugin))), + _a); + return NewOctokit; + } +} +Octokit.VERSION = VERSION; +Octokit.plugins = []; + +export { Octokit }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/core/dist-web/index.js.map b/node_modules/@octokit/core/dist-web/index.js.map new file mode 100644 index 0000000..ba6abac --- /dev/null +++ b/node_modules/@octokit/core/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"3.2.4\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { Collection } from \"before-after-hook\";\nimport { request } from \"@octokit/request\";\nimport { withCustomRequest } from \"@octokit/graphql\";\nimport { createTokenAuth } from \"@octokit/auth-token\";\nimport { VERSION } from \"./version\";\nexport class Octokit {\n constructor(options = {}) {\n const hook = new Collection();\n const requestDefaults = {\n baseUrl: request.endpoint.DEFAULTS.baseUrl,\n headers: {},\n request: Object.assign({}, options.request, {\n hook: hook.bind(null, \"request\"),\n }),\n mediaType: {\n previews: [],\n format: \"\",\n },\n };\n // prepend default user agent with `options.userAgent` if set\n requestDefaults.headers[\"user-agent\"] = [\n options.userAgent,\n `octokit-core.js/${VERSION} ${getUserAgent()}`,\n ]\n .filter(Boolean)\n .join(\" \");\n if (options.baseUrl) {\n requestDefaults.baseUrl = options.baseUrl;\n }\n if (options.previews) {\n requestDefaults.mediaType.previews = options.previews;\n }\n if (options.timeZone) {\n requestDefaults.headers[\"time-zone\"] = options.timeZone;\n }\n this.request = request.defaults(requestDefaults);\n this.graphql = withCustomRequest(this.request).defaults(requestDefaults);\n this.log = Object.assign({\n debug: () => { },\n info: () => { },\n warn: console.warn.bind(console),\n error: console.error.bind(console),\n }, options.log);\n this.hook = hook;\n // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance\n // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered.\n // (2) If only `options.auth` is set, use the default token authentication strategy.\n // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance.\n // TODO: type `options.auth` based on `options.authStrategy`.\n if (!options.authStrategy) {\n if (!options.auth) {\n // (1)\n this.auth = async () => ({\n type: \"unauthenticated\",\n });\n }\n else {\n // (2)\n const auth = createTokenAuth(options.auth);\n // @ts-ignore ¯\\_(ツ)_/¯\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n }\n else {\n const { authStrategy, ...otherOptions } = options;\n const auth = authStrategy(Object.assign({\n request: this.request,\n log: this.log,\n // we pass the current octokit instance as well as its constructor options\n // to allow for authentication strategies that return a new octokit instance\n // that shares the same internal state as the current one. The original\n // requirement for this was the \"event-octokit\" authentication strategy\n // of https://github.com/probot/octokit-auth-probot.\n octokit: this,\n octokitOptions: otherOptions,\n }, options.auth));\n // @ts-ignore ¯\\_(ツ)_/¯\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n // apply plugins\n // https://stackoverflow.com/a/16345172\n const classConstructor = this.constructor;\n classConstructor.plugins.forEach((plugin) => {\n Object.assign(this, plugin(this, options));\n });\n }\n static defaults(defaults) {\n const OctokitWithDefaults = class extends this {\n constructor(...args) {\n const options = args[0] || {};\n if (typeof defaults === \"function\") {\n super(defaults(options));\n return;\n }\n super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent\n ? {\n userAgent: `${options.userAgent} ${defaults.userAgent}`,\n }\n : null));\n }\n };\n return OctokitWithDefaults;\n }\n /**\n * Attach a plugin (or many) to your Octokit instance.\n *\n * @example\n * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)\n */\n static plugin(...newPlugins) {\n var _a;\n const currentPlugins = this.plugins;\n const NewOctokit = (_a = class extends this {\n },\n _a.plugins = currentPlugins.concat(newPlugins.filter((plugin) => !currentPlugins.includes(plugin))),\n _a);\n return NewOctokit;\n }\n}\nOctokit.VERSION = VERSION;\nOctokit.plugins = [];\n"],"names":[],"mappings":";;;;;;AAAO,MAAM,OAAO,GAAG,mBAAmB;;ACMnC,MAAM,OAAO,CAAC;AACrB,IAAI,WAAW,CAAC,OAAO,GAAG,EAAE,EAAE;AAC9B,QAAQ,MAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;AACtC,QAAQ,MAAM,eAAe,GAAG;AAChC,YAAY,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO;AACtD,YAAY,OAAO,EAAE,EAAE;AACvB,YAAY,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,EAAE;AACxD,gBAAgB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC;AAChD,aAAa,CAAC;AACd,YAAY,SAAS,EAAE;AACvB,gBAAgB,QAAQ,EAAE,EAAE;AAC5B,gBAAgB,MAAM,EAAE,EAAE;AAC1B,aAAa;AACb,SAAS,CAAC;AACV;AACA,QAAQ,eAAe,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG;AAChD,YAAY,OAAO,CAAC,SAAS;AAC7B,YAAY,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AAC1D,SAAS;AACT,aAAa,MAAM,CAAC,OAAO,CAAC;AAC5B,aAAa,IAAI,CAAC,GAAG,CAAC,CAAC;AACvB,QAAQ,IAAI,OAAO,CAAC,OAAO,EAAE;AAC7B,YAAY,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;AACtD,SAAS;AACT,QAAQ,IAAI,OAAO,CAAC,QAAQ,EAAE;AAC9B,YAAY,eAAe,CAAC,SAAS,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;AAClE,SAAS;AACT,QAAQ,IAAI,OAAO,CAAC,QAAQ,EAAE;AAC9B,YAAY,eAAe,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;AACpE,SAAS;AACT,QAAQ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;AACzD,QAAQ,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;AACjF,QAAQ,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC;AACjC,YAAY,KAAK,EAAE,MAAM,GAAG;AAC5B,YAAY,IAAI,EAAE,MAAM,GAAG;AAC3B,YAAY,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;AAC5C,YAAY,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;AAC9C,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;AACxB,QAAQ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AACzB;AACA;AACA;AACA;AACA;AACA,QAAQ,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;AACnC,YAAY,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;AAC/B;AACA,gBAAgB,IAAI,CAAC,IAAI,GAAG,aAAa;AACzC,oBAAoB,IAAI,EAAE,iBAAiB;AAC3C,iBAAiB,CAAC,CAAC;AACnB,aAAa;AACb,iBAAiB;AACjB;AACA,gBAAgB,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC3D;AACA,gBAAgB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;AAChD,gBAAgB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AACjC,aAAa;AACb,SAAS;AACT,aAAa;AACb,YAAY,MAAM,EAAE,YAAY,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC;AAC9D,YAAY,MAAM,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC;AACpD,gBAAgB,OAAO,EAAE,IAAI,CAAC,OAAO;AACrC,gBAAgB,GAAG,EAAE,IAAI,CAAC,GAAG;AAC7B;AACA;AACA;AACA;AACA;AACA,gBAAgB,OAAO,EAAE,IAAI;AAC7B,gBAAgB,cAAc,EAAE,YAAY;AAC5C,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9B;AACA,YAAY,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5C,YAAY,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AAC7B,SAAS;AACT;AACA;AACA,QAAQ,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC;AAClD,QAAQ,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK;AACrD,YAAY,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;AACvD,SAAS,CAAC,CAAC;AACX,KAAK;AACL,IAAI,OAAO,QAAQ,CAAC,QAAQ,EAAE;AAC9B,QAAQ,MAAM,mBAAmB,GAAG,cAAc,IAAI,CAAC;AACvD,YAAY,WAAW,CAAC,GAAG,IAAI,EAAE;AACjC,gBAAgB,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAC9C,gBAAgB,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;AACpD,oBAAoB,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;AAC7C,oBAAoB,OAAO;AAC3B,iBAAiB;AACjB,gBAAgB,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,SAAS,IAAI,QAAQ,CAAC,SAAS;AAClG,sBAAsB;AACtB,wBAAwB,SAAS,EAAE,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;AAC/E,qBAAqB;AACrB,sBAAsB,IAAI,CAAC,CAAC,CAAC;AAC7B,aAAa;AACb,SAAS,CAAC;AACV,QAAQ,OAAO,mBAAmB,CAAC;AACnC,KAAK;AACL;AACA;AACA;AACA;AACA;AACA;AACA,IAAI,OAAO,MAAM,CAAC,GAAG,UAAU,EAAE;AACjC,QAAQ,IAAI,EAAE,CAAC;AACf,QAAQ,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC;AAC5C,QAAQ,MAAM,UAAU,IAAI,EAAE,GAAG,cAAc,IAAI,CAAC;AACpD,aAAa;AACb,YAAY,EAAE,CAAC,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAC/G,YAAY,EAAE,CAAC,CAAC;AAChB,QAAQ,OAAO,UAAU,CAAC;AAC1B,KAAK;AACL,CAAC;AACD,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;AAC1B,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/core/package.json b/node_modules/@octokit/core/package.json new file mode 100644 index 0000000..32ac17f --- /dev/null +++ b/node_modules/@octokit/core/package.json @@ -0,0 +1,93 @@ +{ + "_args": [ + [ + "@octokit/core@3.2.4", + "." + ] + ], + "_from": "@octokit/core@3.2.4", + "_id": "@octokit/core@3.2.4", + "_inBundle": false, + "_integrity": "sha512-d9dTsqdePBqOn7aGkyRFe7pQpCXdibSJ5SFnrTr0axevObZrpz3qkWm7t/NjYv5a66z6vhfteriaq4FRz3e0Qg==", + "_location": "/@octokit/core", + "_phantomChildren": {}, + "_requested": { + "type": "version", + "registry": true, + "raw": "@octokit/core@3.2.4", + "name": "@octokit/core", + "escapedName": "@octokit%2fcore", + "scope": "@octokit", + "rawSpec": "3.2.4", + "saveSpec": null, + "fetchSpec": "3.2.4" + }, + "_requiredBy": [ + "/@actions/github" + ], + "_resolved": "https://registry.npmjs.org/@octokit/core/-/core-3.2.4.tgz", + "_spec": "3.2.4", + "_where": ".", + "bugs": { + "url": "https://github.com/octokit/core.js/issues" + }, + "dependencies": { + "@octokit/auth-token": "^2.4.4", + "@octokit/graphql": "^4.5.8", + "@octokit/request": "^5.4.12", + "@octokit/types": "^6.0.3", + "before-after-hook": "^2.1.0", + "universal-user-agent": "^6.0.0" + }, + "description": "Extendable client for GitHub's REST & GraphQL APIs", + "devDependencies": { + "@octokit/auth": "^2.0.0", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/fetch-mock": "^7.3.1", + "@types/jest": "^26.0.0", + "@types/lolex": "^5.1.0", + "@types/node": "^14.0.4", + "@types/node-fetch": "^2.5.0", + "fetch-mock": "^9.0.0", + "http-proxy-agent": "^4.0.1", + "jest": "^26.1.0", + "lolex": "^6.0.0", + "prettier": "^2.0.4", + "proxy": "^1.0.1", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "ts-jest": "^26.1.3", + "typescript": "^4.0.2" + }, + "files": [ + "dist-*/", + "bin/" + ], + "homepage": "https://github.com/octokit/core.js#readme", + "keywords": [ + "octokit", + "github", + "api", + "sdk", + "toolkit" + ], + "license": "MIT", + "main": "dist-node/index.js", + "module": "dist-web/index.js", + "name": "@octokit/core", + "pika": true, + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/octokit/core.js.git" + }, + "sideEffects": false, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "version": "3.2.4" +} diff --git a/node_modules/@octokit/endpoint/README.md b/node_modules/@octokit/endpoint/README.md index 5ac8429..818c100 100644 --- a/node_modules/@octokit/endpoint/README.md +++ b/node_modules/@octokit/endpoint/README.md @@ -4,22 +4,22 @@ [![@latest](https://img.shields.io/npm/v/@octokit/endpoint.svg)](https://www.npmjs.com/package/@octokit/endpoint) ![Build Status](https://github.com/octokit/endpoint.js/workflows/Test/badge.svg) -[![Greenkeeper](https://badges.greenkeeper.io/octokit/endpoint.js.svg)](https://greenkeeper.io/) `@octokit/endpoint` combines [GitHub REST API routes](https://developer.github.com/v3/) with your parameters and turns them into generic request options that can be used in any request library. + - [Usage](#usage) - [API](#api) - - [endpoint()](#endpointroute-options-or-endpointoptions) - - [endpoint.defaults()](#endpointdefaults) - - [endpoint.DEFAULTS](#endpointdefaults-1) - - [endpoint.merge()](#endpointmergeroute-options-or-endpointmergeoptions) - - [endpoint.parse()](#endpointparse) + - [`endpoint(route, options)` or `endpoint(options)`](#endpointroute-options-or-endpointoptions) + - [`endpoint.defaults()`](#endpointdefaults) + - [`endpoint.DEFAULTS`](#endpointdefaults) + - [`endpoint.merge(route, options)` or `endpoint.merge(options)`](#endpointmergeroute-options-or-endpointmergeoptions) + - [`endpoint.parse()`](#endpointparse) - [Special cases](#special-cases) - - [The `data` parameter – set request body directly](#the-data-parameter--set-request-body-directly) + - [The `data` parameter – set request body directly](#the-data-parameter-%E2%80%93-set-request-body-directly) - [Set parameters for both the URL/query and the request body](#set-parameters-for-both-the-urlquery-and-the-request-body) - [LICENSE](#license) @@ -32,11 +32,11 @@ Browsers -Load @octokit/endpoint directly from cdn.pika.dev +Load @octokit/endpoint directly from cdn.skypack.dev ```html ``` @@ -61,10 +61,10 @@ Example for [List organization repositories](https://developer.github.com/v3/rep ```js const requestOptions = endpoint("GET /orgs/:org/repos", { headers: { - authorization: "token 0000000000000000000000000000000000000001" + authorization: "token 0000000000000000000000000000000000000001", }, org: "octokit", - type: "private" + type: "private", }); ``` @@ -283,10 +283,10 @@ const myEndpoint = require("@octokit/endpoint").defaults({ baseUrl: "https://github-enterprise.acme-inc.com/api/v3", headers: { "user-agent": "myApp/1.2.3", - authorization: `token 0000000000000000000000000000000000000001` + authorization: `token 0000000000000000000000000000000000000001`, }, org: "my-project", - per_page: 100 + per_page: 100, }); request(myEndpoint(`GET /orgs/:org/repos`)); @@ -298,14 +298,14 @@ You can call `.defaults()` again on the returned method, the defaults will casca const myProjectEndpoint = endpoint.defaults({ baseUrl: "https://github-enterprise.acme-inc.com/api/v3", headers: { - "user-agent": "myApp/1.2.3" + "user-agent": "myApp/1.2.3", }, - org: "my-project" + org: "my-project", }); const myProjectEndpointWithAuth = myProjectEndpoint.defaults({ headers: { - authorization: `token 0000000000000000000000000000000000000001` - } + authorization: `token 0000000000000000000000000000000000000001`, + }, }); ``` @@ -320,7 +320,7 @@ The current default options. ```js endpoint.DEFAULTS.baseUrl; // https://api.github.com const myEndpoint = endpoint.defaults({ - baseUrl: "https://github-enterprise.acme-inc.com/api/v3" + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", }); myEndpoint.DEFAULTS.baseUrl; // https://github-enterprise.acme-inc.com/api/v3 ``` @@ -333,16 +333,16 @@ Get the defaulted endpoint options, but without parsing them into request option const myProjectEndpoint = endpoint.defaults({ baseUrl: "https://github-enterprise.acme-inc.com/api/v3", headers: { - "user-agent": "myApp/1.2.3" + "user-agent": "myApp/1.2.3", }, - org: "my-project" + org: "my-project", }); myProjectEndpoint.merge("GET /orgs/:org/repos", { headers: { - authorization: `token 0000000000000000000000000000000000000001` + authorization: `token 0000000000000000000000000000000000000001`, }, org: "my-secret-project", - type: "private" + type: "private", }); // { @@ -377,8 +377,8 @@ const options = endpoint("POST /markdown/raw", { data: "Hello world github/linguist#1 **cool**, and #1!", headers: { accept: "text/html;charset=utf-8", - "content-type": "text/plain" - } + "content-type": "text/plain", + }, }); // options is @@ -409,9 +409,9 @@ endpoint( headers: { "content-type": "text/plain", "content-length": 14, - authorization: `token 0000000000000000000000000000000000000001` + authorization: `token 0000000000000000000000000000000000000001`, }, - data: "Hello, world!" + data: "Hello, world!", } ); ``` diff --git a/node_modules/@octokit/endpoint/dist-node/index.js b/node_modules/@octokit/endpoint/dist-node/index.js index 9218ced..8637216 100644 --- a/node_modules/@octokit/endpoint/dist-node/index.js +++ b/node_modules/@octokit/endpoint/dist-node/index.js @@ -2,9 +2,7 @@ Object.defineProperty(exports, '__esModule', { value: true }); -function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } - -var isPlainObject = _interopDefault(require('is-plain-object')); +var isPlainObject = require('is-plain-object'); var universalUserAgent = require('universal-user-agent'); function lowercaseKeys(object) { @@ -21,7 +19,7 @@ function lowercaseKeys(object) { function mergeDeep(defaults, options) { const result = Object.assign({}, defaults); Object.keys(options).forEach(key => { - if (isPlainObject(options[key])) { + if (isPlainObject.isPlainObject(options[key])) { if (!(key in defaults)) Object.assign(result, { [key]: options[key] });else result[key] = mergeDeep(defaults[key], options[key]); @@ -34,6 +32,16 @@ function mergeDeep(defaults, options) { return result; } +function removeUndefinedProperties(obj) { + for (const key in obj) { + if (obj[key] === undefined) { + delete obj[key]; + } + } + + return obj; +} + function merge(defaults, route, options) { if (typeof route === "string") { let [method, url] = route.split(" "); @@ -48,7 +56,10 @@ function merge(defaults, route, options) { } // lowercase header names before merging with defaults to avoid duplicates - options.headers = lowercaseKeys(options.headers); + options.headers = lowercaseKeys(options.headers); // remove properties with undefined values before merging + + removeUndefinedProperties(options); + removeUndefinedProperties(options.headers); const mergedOptions = mergeDeep(defaults || {}, options); // mediaType.previews arrays are merged, instead of overwritten if (defaults && defaults.mediaType.previews.length) { @@ -270,7 +281,7 @@ function parse(options) { // https://fetch.spec.whatwg.org/#methods let method = options.method.toUpperCase(); // replace :varname with {varname} to make it RFC 6570 compatible - let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{+$1}"); + let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{$1}"); let headers = Object.assign({}, options.headers); let body; let parameters = omit(options, ["method", "baseUrl", "url", "headers", "request", "mediaType"]); // extract variable names from URL to calculate remaining variables later @@ -284,9 +295,9 @@ function parse(options) { const omittedParameters = Object.keys(options).filter(option => urlVariableNames.includes(option)).concat("baseUrl"); const remainingParameters = omit(parameters, omittedParameters); - const isBinaryRequset = /application\/octet-stream/i.test(headers.accept); + const isBinaryRequest = /application\/octet-stream/i.test(headers.accept); - if (!isBinaryRequset) { + if (!isBinaryRequest) { if (options.mediaType.format) { // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw headers.accept = headers.accept.split(/,/).map(preview => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)).join(","); @@ -355,7 +366,7 @@ function withDefaults(oldDefaults, newDefaults) { }); } -const VERSION = "5.5.1"; +const VERSION = "6.0.10"; const userAgent = `octokit-endpoint.js/${VERSION} ${universalUserAgent.getUserAgent()}`; // DEFAULTS has all properties set that EndpointOptions has, except url. // So we use RequestParameters and add method as additional required property. diff --git a/node_modules/@octokit/endpoint/dist-node/index.js.map b/node_modules/@octokit/endpoint/dist-node/index.js.map index d84c1b7..04a8b8d 100644 --- a/node_modules/@octokit/endpoint/dist-node/index.js.map +++ b/node_modules/@octokit/endpoint/dist-node/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import isPlainObject from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach(key => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter(preview => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map(name => {\n if (name === \"q\") {\n return (\"q=\" +\n parameters\n .q.split(\"+\")\n .map(encodeURIComponent)\n .join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter(option => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part)\n .replace(/%5B/g, \"[\")\n .replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return (\"%\" +\n c\n .charCodeAt(0)\n .toString(16)\n .toUpperCase());\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template)\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{+$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\"\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter(option => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequset = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequset) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map(preview => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map(preview => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n else {\n headers[\"content-length\"] = 0;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse\n });\n}\n","export const VERSION = \"5.5.1\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent\n },\n mediaType: {\n format: \"\",\n previews: []\n }\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":["lowercaseKeys","object","Object","keys","reduce","newObj","key","toLowerCase","mergeDeep","defaults","options","result","assign","forEach","isPlainObject","merge","route","method","url","split","headers","mergedOptions","mediaType","previews","length","filter","preview","includes","concat","map","replace","addQueryParameters","parameters","separator","test","names","name","q","encodeURIComponent","join","urlVariableRegex","removeNonChars","variableName","extractUrlVariableNames","matches","match","a","b","omit","keysToOmit","option","obj","encodeReserved","str","part","encodeURI","encodeUnreserved","c","charCodeAt","toString","toUpperCase","encodeValue","operator","value","isDefined","undefined","isKeyOperator","getValues","context","modifier","substring","parseInt","push","Array","isArray","k","tmp","parseUrl","template","expand","bind","operators","_","expression","literal","values","indexOf","charAt","substr","variable","exec","parse","body","urlVariableNames","baseUrl","omittedParameters","remainingParameters","isBinaryRequset","accept","format","previewsFromAcceptHeader","data","request","endpointWithDefaults","withDefaults","oldDefaults","newDefaults","DEFAULTS","endpoint","VERSION","userAgent","getUserAgent"],"mappings":";;;;;;;;;AAAO,SAASA,aAAT,CAAuBC,MAAvB,EAA+B;MAC9B,CAACA,MAAL,EAAa;WACF,EAAP;;;SAEGC,MAAM,CAACC,IAAP,CAAYF,MAAZ,EAAoBG,MAApB,CAA2B,CAACC,MAAD,EAASC,GAAT,KAAiB;IAC/CD,MAAM,CAACC,GAAG,CAACC,WAAJ,EAAD,CAAN,GAA4BN,MAAM,CAACK,GAAD,CAAlC;WACOD,MAAP;GAFG,EAGJ,EAHI,CAAP;;;ACHG,SAASG,SAAT,CAAmBC,QAAnB,EAA6BC,OAA7B,EAAsC;QACnCC,MAAM,GAAGT,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBH,QAAlB,CAAf;EACAP,MAAM,CAACC,IAAP,CAAYO,OAAZ,EAAqBG,OAArB,CAA6BP,GAAG,IAAI;QAC5BQ,aAAa,CAACJ,OAAO,CAACJ,GAAD,CAAR,CAAjB,EAAiC;UACzB,EAAEA,GAAG,IAAIG,QAAT,CAAJ,EACIP,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;SAAGL,GAAD,GAAOI,OAAO,CAACJ,GAAD;OAAtC,EADJ,KAGIK,MAAM,CAACL,GAAD,CAAN,GAAcE,SAAS,CAACC,QAAQ,CAACH,GAAD,CAAT,EAAgBI,OAAO,CAACJ,GAAD,CAAvB,CAAvB;KAJR,MAMK;MACDJ,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;SAAGL,GAAD,GAAOI,OAAO,CAACJ,GAAD;OAAtC;;GARR;SAWOK,MAAP;;;ACZG,SAASI,KAAT,CAAeN,QAAf,EAAyBO,KAAzB,EAAgCN,OAAhC,EAAyC;MACxC,OAAOM,KAAP,KAAiB,QAArB,EAA+B;QACvB,CAACC,MAAD,EAASC,GAAT,IAAgBF,KAAK,CAACG,KAAN,CAAY,GAAZ,CAApB;IACAT,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAcM,GAAG,GAAG;MAAED,MAAF;MAAUC;KAAb,GAAqB;MAAEA,GAAG,EAAED;KAA7C,EAAuDP,OAAvD,CAAV;GAFJ,MAIK;IACDA,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBI,KAAlB,CAAV;GANwC;;;EAS5CN,OAAO,CAACU,OAAR,GAAkBpB,aAAa,CAACU,OAAO,CAACU,OAAT,CAA/B;QACMC,aAAa,GAAGb,SAAS,CAACC,QAAQ,IAAI,EAAb,EAAiBC,OAAjB,CAA/B,CAV4C;;MAYxCD,QAAQ,IAAIA,QAAQ,CAACa,SAAT,CAAmBC,QAAnB,CAA4BC,MAA5C,EAAoD;IAChDH,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCd,QAAQ,CAACa,SAAT,CAAmBC,QAAnB,CAC9BE,MAD8B,CACvBC,OAAO,IAAI,CAACL,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCI,QAAjC,CAA0CD,OAA1C,CADW,EAE9BE,MAF8B,CAEvBP,aAAa,CAACC,SAAd,CAAwBC,QAFD,CAAnC;;;EAIJF,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCF,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCM,GAAjC,CAAsCH,OAAD,IAAaA,OAAO,CAACI,OAAR,CAAgB,UAAhB,EAA4B,EAA5B,CAAlD,CAAnC;SACOT,aAAP;;;ACpBG,SAASU,kBAAT,CAA4Bb,GAA5B,EAAiCc,UAAjC,EAA6C;QAC1CC,SAAS,GAAG,KAAKC,IAAL,CAAUhB,GAAV,IAAiB,GAAjB,GAAuB,GAAzC;QACMiB,KAAK,GAAGjC,MAAM,CAACC,IAAP,CAAY6B,UAAZ,CAAd;;MACIG,KAAK,CAACX,MAAN,KAAiB,CAArB,EAAwB;WACbN,GAAP;;;SAEIA,GAAG,GACPe,SADI,GAEJE,KAAK,CACAN,GADL,CACSO,IAAI,IAAI;QACTA,IAAI,KAAK,GAAb,EAAkB;aACN,OACJJ,UAAU,CACLK,CADL,CACOlB,KADP,CACa,GADb,EAEKU,GAFL,CAESS,kBAFT,EAGKC,IAHL,CAGU,GAHV,CADJ;;;WAMI,GAAEH,IAAK,IAAGE,kBAAkB,CAACN,UAAU,CAACI,IAAD,CAAX,CAAmB,EAAvD;GATJ,EAWKG,IAXL,CAWU,GAXV,CAFJ;;;ACNJ,MAAMC,gBAAgB,GAAG,YAAzB;;AACA,SAASC,cAAT,CAAwBC,YAAxB,EAAsC;SAC3BA,YAAY,CAACZ,OAAb,CAAqB,YAArB,EAAmC,EAAnC,EAAuCX,KAAvC,CAA6C,GAA7C,CAAP;;;AAEJ,AAAO,SAASwB,uBAAT,CAAiCzB,GAAjC,EAAsC;QACnC0B,OAAO,GAAG1B,GAAG,CAAC2B,KAAJ,CAAUL,gBAAV,CAAhB;;MACI,CAACI,OAAL,EAAc;WACH,EAAP;;;SAEGA,OAAO,CAACf,GAAR,CAAYY,cAAZ,EAA4BrC,MAA5B,CAAmC,CAAC0C,CAAD,EAAIC,CAAJ,KAAUD,CAAC,CAAClB,MAAF,CAASmB,CAAT,CAA7C,EAA0D,EAA1D,CAAP;;;ACTG,SAASC,IAAT,CAAc/C,MAAd,EAAsBgD,UAAtB,EAAkC;SAC9B/C,MAAM,CAACC,IAAP,CAAYF,MAAZ,EACFwB,MADE,CACKyB,MAAM,IAAI,CAACD,UAAU,CAACtB,QAAX,CAAoBuB,MAApB,CADhB,EAEF9C,MAFE,CAEK,CAAC+C,GAAD,EAAM7C,GAAN,KAAc;IACtB6C,GAAG,CAAC7C,GAAD,CAAH,GAAWL,MAAM,CAACK,GAAD,CAAjB;WACO6C,GAAP;GAJG,EAKJ,EALI,CAAP;;;ACDJ;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,SAASC,cAAT,CAAwBC,GAAxB,EAA6B;SAClBA,GAAG,CACLlC,KADE,CACI,oBADJ,EAEFU,GAFE,CAEE,UAAUyB,IAAV,EAAgB;QACjB,CAAC,eAAepB,IAAf,CAAoBoB,IAApB,CAAL,EAAgC;MAC5BA,IAAI,GAAGC,SAAS,CAACD,IAAD,CAAT,CACFxB,OADE,CACM,MADN,EACc,GADd,EAEFA,OAFE,CAEM,MAFN,EAEc,GAFd,CAAP;;;WAIGwB,IAAP;GARG,EAUFf,IAVE,CAUG,EAVH,CAAP;;;AAYJ,SAASiB,gBAAT,CAA0BH,GAA1B,EAA+B;SACpBf,kBAAkB,CAACe,GAAD,CAAlB,CAAwBvB,OAAxB,CAAgC,UAAhC,EAA4C,UAAU2B,CAAV,EAAa;WACpD,MACJA,CAAC,CACIC,UADL,CACgB,CADhB,EAEKC,QAFL,CAEc,EAFd,EAGKC,WAHL,EADJ;GADG,CAAP;;;AAQJ,SAASC,WAAT,CAAqBC,QAArB,EAA+BC,KAA/B,EAAsCzD,GAAtC,EAA2C;EACvCyD,KAAK,GACDD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,GACMV,cAAc,CAACW,KAAD,CADpB,GAEMP,gBAAgB,CAACO,KAAD,CAH1B;;MAIIzD,GAAJ,EAAS;WACEkD,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAAxB,GAA8ByD,KAArC;GADJ,MAGK;WACMA,KAAP;;;;AAGR,SAASC,SAAT,CAAmBD,KAAnB,EAA0B;SACfA,KAAK,KAAKE,SAAV,IAAuBF,KAAK,KAAK,IAAxC;;;AAEJ,SAASG,aAAT,CAAuBJ,QAAvB,EAAiC;SACtBA,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,IAAwCA,QAAQ,KAAK,GAA5D;;;AAEJ,SAASK,SAAT,CAAmBC,OAAnB,EAA4BN,QAA5B,EAAsCxD,GAAtC,EAA2C+D,QAA3C,EAAqD;MAC7CN,KAAK,GAAGK,OAAO,CAAC9D,GAAD,CAAnB;MAA0BK,MAAM,GAAG,EAAnC;;MACIqD,SAAS,CAACD,KAAD,CAAT,IAAoBA,KAAK,KAAK,EAAlC,EAAsC;QAC9B,OAAOA,KAAP,KAAiB,QAAjB,IACA,OAAOA,KAAP,KAAiB,QADjB,IAEA,OAAOA,KAAP,KAAiB,SAFrB,EAEgC;MAC5BA,KAAK,GAAGA,KAAK,CAACJ,QAAN,EAAR;;UACIU,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;QAC9BN,KAAK,GAAGA,KAAK,CAACO,SAAN,CAAgB,CAAhB,EAAmBC,QAAQ,CAACF,QAAD,EAAW,EAAX,CAA3B,CAAR;;;MAEJ1D,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBG,aAAa,CAACJ,QAAD,CAAb,GAA0BxD,GAA1B,GAAgC,EAAlD,CAAvB;KAPJ,MASK;UACG+D,QAAQ,KAAK,GAAjB,EAAsB;YACdI,KAAK,CAACC,OAAN,CAAcX,KAAd,CAAJ,EAA0B;UACtBA,KAAK,CAACtC,MAAN,CAAauC,SAAb,EAAwBnD,OAAxB,CAAgC,UAAUkD,KAAV,EAAiB;YAC7CpD,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBG,aAAa,CAACJ,QAAD,CAAb,GAA0BxD,GAA1B,GAAgC,EAAlD,CAAvB;WADJ;SADJ,MAKK;UACDJ,MAAM,CAACC,IAAP,CAAY4D,KAAZ,EAAmBlD,OAAnB,CAA2B,UAAU8D,CAAV,EAAa;gBAChCX,SAAS,CAACD,KAAK,CAACY,CAAD,CAAN,CAAb,EAAyB;cACrBhE,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACY,CAAD,CAAhB,EAAqBA,CAArB,CAAvB;;WAFR;;OAPR,MAcK;cACKC,GAAG,GAAG,EAAZ;;YACIH,KAAK,CAACC,OAAN,CAAcX,KAAd,CAAJ,EAA0B;UACtBA,KAAK,CAACtC,MAAN,CAAauC,SAAb,EAAwBnD,OAAxB,CAAgC,UAAUkD,KAAV,EAAiB;YAC7Ca,GAAG,CAACJ,IAAJ,CAASX,WAAW,CAACC,QAAD,EAAWC,KAAX,CAApB;WADJ;SADJ,MAKK;UACD7D,MAAM,CAACC,IAAP,CAAY4D,KAAZ,EAAmBlD,OAAnB,CAA2B,UAAU8D,CAAV,EAAa;gBAChCX,SAAS,CAACD,KAAK,CAACY,CAAD,CAAN,CAAb,EAAyB;cACrBC,GAAG,CAACJ,IAAJ,CAAShB,gBAAgB,CAACmB,CAAD,CAAzB;cACAC,GAAG,CAACJ,IAAJ,CAASX,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACY,CAAD,CAAL,CAAShB,QAAT,EAAX,CAApB;;WAHR;;;YAOAO,aAAa,CAACJ,QAAD,CAAjB,EAA6B;UACzBnD,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAAxB,GAA8BsE,GAAG,CAACrC,IAAJ,CAAS,GAAT,CAA1C;SADJ,MAGK,IAAIqC,GAAG,CAACpD,MAAJ,KAAe,CAAnB,EAAsB;UACvBb,MAAM,CAAC6D,IAAP,CAAYI,GAAG,CAACrC,IAAJ,CAAS,GAAT,CAAZ;;;;GA5ChB,MAiDK;QACGuB,QAAQ,KAAK,GAAjB,EAAsB;UACdE,SAAS,CAACD,KAAD,CAAb,EAAsB;QAClBpD,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAA5B;;KAFR,MAKK,IAAIyD,KAAK,KAAK,EAAV,KAAiBD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAlD,CAAJ,EAA4D;MAC7DnD,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAApC;KADC,MAGA,IAAIyD,KAAK,KAAK,EAAd,EAAkB;MACnBpD,MAAM,CAAC6D,IAAP,CAAY,EAAZ;;;;SAGD7D,MAAP;;;AAEJ,AAAO,SAASkE,QAAT,CAAkBC,QAAlB,EAA4B;SACxB;IACHC,MAAM,EAAEA,MAAM,CAACC,IAAP,CAAY,IAAZ,EAAkBF,QAAlB;GADZ;;;AAIJ,SAASC,MAAT,CAAgBD,QAAhB,EAA0BV,OAA1B,EAAmC;MAC3Ba,SAAS,GAAG,CAAC,GAAD,EAAM,GAAN,EAAW,GAAX,EAAgB,GAAhB,EAAqB,GAArB,EAA0B,GAA1B,EAA+B,GAA/B,CAAhB;SACOH,QAAQ,CAAChD,OAAT,CAAiB,4BAAjB,EAA+C,UAAUoD,CAAV,EAAaC,UAAb,EAAyBC,OAAzB,EAAkC;QAChFD,UAAJ,EAAgB;UACRrB,QAAQ,GAAG,EAAf;YACMuB,MAAM,GAAG,EAAf;;UACIJ,SAAS,CAACK,OAAV,CAAkBH,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAlB,MAA4C,CAAC,CAAjD,EAAoD;QAChDzB,QAAQ,GAAGqB,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAX;QACAJ,UAAU,GAAGA,UAAU,CAACK,MAAX,CAAkB,CAAlB,CAAb;;;MAEJL,UAAU,CAAChE,KAAX,CAAiB,IAAjB,EAAuBN,OAAvB,CAA+B,UAAU4E,QAAV,EAAoB;YAC3Cb,GAAG,GAAG,4BAA4Bc,IAA5B,CAAiCD,QAAjC,CAAV;QACAJ,MAAM,CAACb,IAAP,CAAYL,SAAS,CAACC,OAAD,EAAUN,QAAV,EAAoBc,GAAG,CAAC,CAAD,CAAvB,EAA4BA,GAAG,CAAC,CAAD,CAAH,IAAUA,GAAG,CAAC,CAAD,CAAzC,CAArB;OAFJ;;UAIId,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;YAC1B7B,SAAS,GAAG,GAAhB;;YACI6B,QAAQ,KAAK,GAAjB,EAAsB;UAClB7B,SAAS,GAAG,GAAZ;SADJ,MAGK,IAAI6B,QAAQ,KAAK,GAAjB,EAAsB;UACvB7B,SAAS,GAAG6B,QAAZ;;;eAEG,CAACuB,MAAM,CAAC7D,MAAP,KAAkB,CAAlB,GAAsBsC,QAAtB,GAAiC,EAAlC,IAAwCuB,MAAM,CAAC9C,IAAP,CAAYN,SAAZ,CAA/C;OARJ,MAUK;eACMoD,MAAM,CAAC9C,IAAP,CAAY,GAAZ,CAAP;;KAtBR,MAyBK;aACMa,cAAc,CAACgC,OAAD,CAArB;;GA3BD,CAAP;;;ACvIG,SAASO,KAAT,CAAejF,OAAf,EAAwB;;MAEvBO,MAAM,GAAGP,OAAO,CAACO,MAAR,CAAe2C,WAAf,EAAb,CAF2B;;MAIvB1C,GAAG,GAAG,CAACR,OAAO,CAACQ,GAAR,IAAe,GAAhB,EAAqBY,OAArB,CAA6B,cAA7B,EAA6C,OAA7C,CAAV;MACIV,OAAO,GAAGlB,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBF,OAAO,CAACU,OAA1B,CAAd;MACIwE,IAAJ;MACI5D,UAAU,GAAGgB,IAAI,CAACtC,OAAD,EAAU,CAC3B,QAD2B,EAE3B,SAF2B,EAG3B,KAH2B,EAI3B,SAJ2B,EAK3B,SAL2B,EAM3B,WAN2B,CAAV,CAArB,CAP2B;;QAgBrBmF,gBAAgB,GAAGlD,uBAAuB,CAACzB,GAAD,CAAhD;EACAA,GAAG,GAAG2D,QAAQ,CAAC3D,GAAD,CAAR,CAAc6D,MAAd,CAAqB/C,UAArB,CAAN;;MACI,CAAC,QAAQE,IAAR,CAAahB,GAAb,CAAL,EAAwB;IACpBA,GAAG,GAAGR,OAAO,CAACoF,OAAR,GAAkB5E,GAAxB;;;QAEE6E,iBAAiB,GAAG7F,MAAM,CAACC,IAAP,CAAYO,OAAZ,EACrBe,MADqB,CACdyB,MAAM,IAAI2C,gBAAgB,CAAClE,QAAjB,CAA0BuB,MAA1B,CADI,EAErBtB,MAFqB,CAEd,SAFc,CAA1B;QAGMoE,mBAAmB,GAAGhD,IAAI,CAAChB,UAAD,EAAa+D,iBAAb,CAAhC;QACME,eAAe,GAAG,6BAA6B/D,IAA7B,CAAkCd,OAAO,CAAC8E,MAA1C,CAAxB;;MACI,CAACD,eAAL,EAAsB;QACdvF,OAAO,CAACY,SAAR,CAAkB6E,MAAtB,EAA8B;;MAE1B/E,OAAO,CAAC8E,MAAR,GAAiB9E,OAAO,CAAC8E,MAAR,CACZ/E,KADY,CACN,GADM,EAEZU,GAFY,CAERH,OAAO,IAAIA,OAAO,CAACI,OAAR,CAAgB,kDAAhB,EAAqE,uBAAsBpB,OAAO,CAACY,SAAR,CAAkB6E,MAAO,EAApH,CAFH,EAGZ5D,IAHY,CAGP,GAHO,CAAjB;;;QAKA7B,OAAO,CAACY,SAAR,CAAkBC,QAAlB,CAA2BC,MAA/B,EAAuC;YAC7B4E,wBAAwB,GAAGhF,OAAO,CAAC8E,MAAR,CAAerD,KAAf,CAAqB,qBAArB,KAA+C,EAAhF;MACAzB,OAAO,CAAC8E,MAAR,GAAiBE,wBAAwB,CACpCxE,MADY,CACLlB,OAAO,CAACY,SAAR,CAAkBC,QADb,EAEZM,GAFY,CAERH,OAAO,IAAI;cACVyE,MAAM,GAAGzF,OAAO,CAACY,SAAR,CAAkB6E,MAAlB,GACR,IAAGzF,OAAO,CAACY,SAAR,CAAkB6E,MAAO,EADpB,GAET,OAFN;eAGQ,0BAAyBzE,OAAQ,WAAUyE,MAAO,EAA1D;OANa,EAQZ5D,IARY,CAQP,GARO,CAAjB;;GApCmB;;;;MAiDvB,CAAC,KAAD,EAAQ,MAAR,EAAgBZ,QAAhB,CAAyBV,MAAzB,CAAJ,EAAsC;IAClCC,GAAG,GAAGa,kBAAkB,CAACb,GAAD,EAAM8E,mBAAN,CAAxB;GADJ,MAGK;QACG,UAAUA,mBAAd,EAAmC;MAC/BJ,IAAI,GAAGI,mBAAmB,CAACK,IAA3B;KADJ,MAGK;UACGnG,MAAM,CAACC,IAAP,CAAY6F,mBAAZ,EAAiCxE,MAArC,EAA6C;QACzCoE,IAAI,GAAGI,mBAAP;OADJ,MAGK;QACD5E,OAAO,CAAC,gBAAD,CAAP,GAA4B,CAA5B;;;GA7De;;;MAkEvB,CAACA,OAAO,CAAC,cAAD,CAAR,IAA4B,OAAOwE,IAAP,KAAgB,WAAhD,EAA6D;IACzDxE,OAAO,CAAC,cAAD,CAAP,GAA0B,iCAA1B;GAnEuB;;;;MAuEvB,CAAC,OAAD,EAAU,KAAV,EAAiBO,QAAjB,CAA0BV,MAA1B,KAAqC,OAAO2E,IAAP,KAAgB,WAAzD,EAAsE;IAClEA,IAAI,GAAG,EAAP;GAxEuB;;;SA2EpB1F,MAAM,CAACU,MAAP,CAAc;IAAEK,MAAF;IAAUC,GAAV;IAAeE;GAA7B,EAAwC,OAAOwE,IAAP,KAAgB,WAAhB,GAA8B;IAAEA;GAAhC,GAAyC,IAAjF,EAAuFlF,OAAO,CAAC4F,OAAR,GAAkB;IAAEA,OAAO,EAAE5F,OAAO,CAAC4F;GAArC,GAAiD,IAAxI,CAAP;;;AC7EG,SAASC,oBAAT,CAA8B9F,QAA9B,EAAwCO,KAAxC,EAA+CN,OAA/C,EAAwD;SACpDiF,KAAK,CAAC5E,KAAK,CAACN,QAAD,EAAWO,KAAX,EAAkBN,OAAlB,CAAN,CAAZ;;;ACAG,SAAS8F,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;QAC7CC,QAAQ,GAAG5F,KAAK,CAAC0F,WAAD,EAAcC,WAAd,CAAtB;QACME,QAAQ,GAAGL,oBAAoB,CAACvB,IAArB,CAA0B,IAA1B,EAAgC2B,QAAhC,CAAjB;SACOzG,MAAM,CAACU,MAAP,CAAcgG,QAAd,EAAwB;IAC3BD,QAD2B;IAE3BlG,QAAQ,EAAE+F,YAAY,CAACxB,IAAb,CAAkB,IAAlB,EAAwB2B,QAAxB,CAFiB;IAG3B5F,KAAK,EAAEA,KAAK,CAACiE,IAAN,CAAW,IAAX,EAAiB2B,QAAjB,CAHoB;IAI3BhB;GAJG,CAAP;;;ACNG,MAAMkB,OAAO,GAAG,mBAAhB;;ACEP,MAAMC,SAAS,GAAI,uBAAsBD,OAAQ,IAAGE,+BAAY,EAAG,EAAnE;;;AAGA,AAAO,MAAMJ,QAAQ,GAAG;EACpB1F,MAAM,EAAE,KADY;EAEpB6E,OAAO,EAAE,wBAFW;EAGpB1E,OAAO,EAAE;IACL8E,MAAM,EAAE,gCADH;kBAESY;GALE;EAOpBxF,SAAS,EAAE;IACP6E,MAAM,EAAE,EADD;IAEP5E,QAAQ,EAAE;;CATX;;MCHMqF,QAAQ,GAAGJ,YAAY,CAAC,IAAD,EAAOG,QAAP,CAA7B;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/util/remove-undefined-properties.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import { isPlainObject } from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach((key) => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","export function removeUndefinedProperties(obj) {\n for (const key in obj) {\n if (obj[key] === undefined) {\n delete obj[key];\n }\n }\n return obj;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nimport { removeUndefinedProperties } from \"./util/remove-undefined-properties\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n // remove properties with undefined values before merging\n removeUndefinedProperties(options);\n removeUndefinedProperties(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter((preview) => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map((name) => {\n if (name === \"q\") {\n return (\"q=\" + parameters.q.split(\"+\").map(encodeURIComponent).join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter((option) => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part).replace(/%5B/g, \"[\").replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return \"%\" + c.charCodeAt(0).toString(16).toUpperCase();\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template),\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\",\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter((option) => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequest = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequest) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map((preview) => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map((preview) => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n else {\n headers[\"content-length\"] = 0;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse,\n });\n}\n","export const VERSION = \"6.0.10\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent,\n },\n mediaType: {\n format: \"\",\n previews: [],\n },\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":["lowercaseKeys","object","Object","keys","reduce","newObj","key","toLowerCase","mergeDeep","defaults","options","result","assign","forEach","isPlainObject","removeUndefinedProperties","obj","undefined","merge","route","method","url","split","headers","mergedOptions","mediaType","previews","length","filter","preview","includes","concat","map","replace","addQueryParameters","parameters","separator","test","names","name","q","encodeURIComponent","join","urlVariableRegex","removeNonChars","variableName","extractUrlVariableNames","matches","match","a","b","omit","keysToOmit","option","encodeReserved","str","part","encodeURI","encodeUnreserved","c","charCodeAt","toString","toUpperCase","encodeValue","operator","value","isDefined","isKeyOperator","getValues","context","modifier","substring","parseInt","push","Array","isArray","k","tmp","parseUrl","template","expand","bind","operators","_","expression","literal","values","indexOf","charAt","substr","variable","exec","parse","body","urlVariableNames","baseUrl","omittedParameters","remainingParameters","isBinaryRequest","accept","format","previewsFromAcceptHeader","data","request","endpointWithDefaults","withDefaults","oldDefaults","newDefaults","DEFAULTS","endpoint","VERSION","userAgent","getUserAgent"],"mappings":";;;;;;;AAAO,SAASA,aAAT,CAAuBC,MAAvB,EAA+B;AAClC,MAAI,CAACA,MAAL,EAAa;AACT,WAAO,EAAP;AACH;;AACD,SAAOC,MAAM,CAACC,IAAP,CAAYF,MAAZ,EAAoBG,MAApB,CAA2B,CAACC,MAAD,EAASC,GAAT,KAAiB;AAC/CD,IAAAA,MAAM,CAACC,GAAG,CAACC,WAAJ,EAAD,CAAN,GAA4BN,MAAM,CAACK,GAAD,CAAlC;AACA,WAAOD,MAAP;AACH,GAHM,EAGJ,EAHI,CAAP;AAIH;;ACPM,SAASG,SAAT,CAAmBC,QAAnB,EAA6BC,OAA7B,EAAsC;AACzC,QAAMC,MAAM,GAAGT,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBH,QAAlB,CAAf;AACAP,EAAAA,MAAM,CAACC,IAAP,CAAYO,OAAZ,EAAqBG,OAArB,CAA8BP,GAAD,IAAS;AAClC,QAAIQ,2BAAa,CAACJ,OAAO,CAACJ,GAAD,CAAR,CAAjB,EAAiC;AAC7B,UAAI,EAAEA,GAAG,IAAIG,QAAT,CAAJ,EACIP,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;AAAE,SAACL,GAAD,GAAOI,OAAO,CAACJ,GAAD;AAAhB,OAAtB,EADJ,KAGIK,MAAM,CAACL,GAAD,CAAN,GAAcE,SAAS,CAACC,QAAQ,CAACH,GAAD,CAAT,EAAgBI,OAAO,CAACJ,GAAD,CAAvB,CAAvB;AACP,KALD,MAMK;AACDJ,MAAAA,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;AAAE,SAACL,GAAD,GAAOI,OAAO,CAACJ,GAAD;AAAhB,OAAtB;AACH;AACJ,GAVD;AAWA,SAAOK,MAAP;AACH;;ACfM,SAASI,yBAAT,CAAmCC,GAAnC,EAAwC;AAC3C,OAAK,MAAMV,GAAX,IAAkBU,GAAlB,EAAuB;AACnB,QAAIA,GAAG,CAACV,GAAD,CAAH,KAAaW,SAAjB,EAA4B;AACxB,aAAOD,GAAG,CAACV,GAAD,CAAV;AACH;AACJ;;AACD,SAAOU,GAAP;AACH;;ACJM,SAASE,KAAT,CAAeT,QAAf,EAAyBU,KAAzB,EAAgCT,OAAhC,EAAyC;AAC5C,MAAI,OAAOS,KAAP,KAAiB,QAArB,EAA+B;AAC3B,QAAI,CAACC,MAAD,EAASC,GAAT,IAAgBF,KAAK,CAACG,KAAN,CAAY,GAAZ,CAApB;AACAZ,IAAAA,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAcS,GAAG,GAAG;AAAED,MAAAA,MAAF;AAAUC,MAAAA;AAAV,KAAH,GAAqB;AAAEA,MAAAA,GAAG,EAAED;AAAP,KAAtC,EAAuDV,OAAvD,CAAV;AACH,GAHD,MAIK;AACDA,IAAAA,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBO,KAAlB,CAAV;AACH,GAP2C;;;AAS5CT,EAAAA,OAAO,CAACa,OAAR,GAAkBvB,aAAa,CAACU,OAAO,CAACa,OAAT,CAA/B,CAT4C;;AAW5CR,EAAAA,yBAAyB,CAACL,OAAD,CAAzB;AACAK,EAAAA,yBAAyB,CAACL,OAAO,CAACa,OAAT,CAAzB;AACA,QAAMC,aAAa,GAAGhB,SAAS,CAACC,QAAQ,IAAI,EAAb,EAAiBC,OAAjB,CAA/B,CAb4C;;AAe5C,MAAID,QAAQ,IAAIA,QAAQ,CAACgB,SAAT,CAAmBC,QAAnB,CAA4BC,MAA5C,EAAoD;AAChDH,IAAAA,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCjB,QAAQ,CAACgB,SAAT,CAAmBC,QAAnB,CAC9BE,MAD8B,CACtBC,OAAD,IAAa,CAACL,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCI,QAAjC,CAA0CD,OAA1C,CADS,EAE9BE,MAF8B,CAEvBP,aAAa,CAACC,SAAd,CAAwBC,QAFD,CAAnC;AAGH;;AACDF,EAAAA,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCF,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCM,GAAjC,CAAsCH,OAAD,IAAaA,OAAO,CAACI,OAAR,CAAgB,UAAhB,EAA4B,EAA5B,CAAlD,CAAnC;AACA,SAAOT,aAAP;AACH;;ACzBM,SAASU,kBAAT,CAA4Bb,GAA5B,EAAiCc,UAAjC,EAA6C;AAChD,QAAMC,SAAS,GAAG,KAAKC,IAAL,CAAUhB,GAAV,IAAiB,GAAjB,GAAuB,GAAzC;AACA,QAAMiB,KAAK,GAAGpC,MAAM,CAACC,IAAP,CAAYgC,UAAZ,CAAd;;AACA,MAAIG,KAAK,CAACX,MAAN,KAAiB,CAArB,EAAwB;AACpB,WAAON,GAAP;AACH;;AACD,SAAQA,GAAG,GACPe,SADI,GAEJE,KAAK,CACAN,GADL,CACUO,IAAD,IAAU;AACf,QAAIA,IAAI,KAAK,GAAb,EAAkB;AACd,aAAQ,OAAOJ,UAAU,CAACK,CAAX,CAAalB,KAAb,CAAmB,GAAnB,EAAwBU,GAAxB,CAA4BS,kBAA5B,EAAgDC,IAAhD,CAAqD,GAArD,CAAf;AACH;;AACD,WAAQ,GAAEH,IAAK,IAAGE,kBAAkB,CAACN,UAAU,CAACI,IAAD,CAAX,CAAmB,EAAvD;AACH,GAND,EAOKG,IAPL,CAOU,GAPV,CAFJ;AAUH;;AChBD,MAAMC,gBAAgB,GAAG,YAAzB;;AACA,SAASC,cAAT,CAAwBC,YAAxB,EAAsC;AAClC,SAAOA,YAAY,CAACZ,OAAb,CAAqB,YAArB,EAAmC,EAAnC,EAAuCX,KAAvC,CAA6C,GAA7C,CAAP;AACH;;AACD,AAAO,SAASwB,uBAAT,CAAiCzB,GAAjC,EAAsC;AACzC,QAAM0B,OAAO,GAAG1B,GAAG,CAAC2B,KAAJ,CAAUL,gBAAV,CAAhB;;AACA,MAAI,CAACI,OAAL,EAAc;AACV,WAAO,EAAP;AACH;;AACD,SAAOA,OAAO,CAACf,GAAR,CAAYY,cAAZ,EAA4BxC,MAA5B,CAAmC,CAAC6C,CAAD,EAAIC,CAAJ,KAAUD,CAAC,CAAClB,MAAF,CAASmB,CAAT,CAA7C,EAA0D,EAA1D,CAAP;AACH;;ACVM,SAASC,IAAT,CAAclD,MAAd,EAAsBmD,UAAtB,EAAkC;AACrC,SAAOlD,MAAM,CAACC,IAAP,CAAYF,MAAZ,EACF2B,MADE,CACMyB,MAAD,IAAY,CAACD,UAAU,CAACtB,QAAX,CAAoBuB,MAApB,CADlB,EAEFjD,MAFE,CAEK,CAACY,GAAD,EAAMV,GAAN,KAAc;AACtBU,IAAAA,GAAG,CAACV,GAAD,CAAH,GAAWL,MAAM,CAACK,GAAD,CAAjB;AACA,WAAOU,GAAP;AACH,GALM,EAKJ,EALI,CAAP;AAMH;;ACPD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA;AACA,SAASsC,cAAT,CAAwBC,GAAxB,EAA6B;AACzB,SAAOA,GAAG,CACLjC,KADE,CACI,oBADJ,EAEFU,GAFE,CAEE,UAAUwB,IAAV,EAAgB;AACrB,QAAI,CAAC,eAAenB,IAAf,CAAoBmB,IAApB,CAAL,EAAgC;AAC5BA,MAAAA,IAAI,GAAGC,SAAS,CAACD,IAAD,CAAT,CAAgBvB,OAAhB,CAAwB,MAAxB,EAAgC,GAAhC,EAAqCA,OAArC,CAA6C,MAA7C,EAAqD,GAArD,CAAP;AACH;;AACD,WAAOuB,IAAP;AACH,GAPM,EAQFd,IARE,CAQG,EARH,CAAP;AASH;;AACD,SAASgB,gBAAT,CAA0BH,GAA1B,EAA+B;AAC3B,SAAOd,kBAAkB,CAACc,GAAD,CAAlB,CAAwBtB,OAAxB,CAAgC,UAAhC,EAA4C,UAAU0B,CAAV,EAAa;AAC5D,WAAO,MAAMA,CAAC,CAACC,UAAF,CAAa,CAAb,EAAgBC,QAAhB,CAAyB,EAAzB,EAA6BC,WAA7B,EAAb;AACH,GAFM,CAAP;AAGH;;AACD,SAASC,WAAT,CAAqBC,QAArB,EAA+BC,KAA/B,EAAsC3D,GAAtC,EAA2C;AACvC2D,EAAAA,KAAK,GACDD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,GACMV,cAAc,CAACW,KAAD,CADpB,GAEMP,gBAAgB,CAACO,KAAD,CAH1B;;AAIA,MAAI3D,GAAJ,EAAS;AACL,WAAOoD,gBAAgB,CAACpD,GAAD,CAAhB,GAAwB,GAAxB,GAA8B2D,KAArC;AACH,GAFD,MAGK;AACD,WAAOA,KAAP;AACH;AACJ;;AACD,SAASC,SAAT,CAAmBD,KAAnB,EAA0B;AACtB,SAAOA,KAAK,KAAKhD,SAAV,IAAuBgD,KAAK,KAAK,IAAxC;AACH;;AACD,SAASE,aAAT,CAAuBH,QAAvB,EAAiC;AAC7B,SAAOA,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,IAAwCA,QAAQ,KAAK,GAA5D;AACH;;AACD,SAASI,SAAT,CAAmBC,OAAnB,EAA4BL,QAA5B,EAAsC1D,GAAtC,EAA2CgE,QAA3C,EAAqD;AACjD,MAAIL,KAAK,GAAGI,OAAO,CAAC/D,GAAD,CAAnB;AAAA,MAA0BK,MAAM,GAAG,EAAnC;;AACA,MAAIuD,SAAS,CAACD,KAAD,CAAT,IAAoBA,KAAK,KAAK,EAAlC,EAAsC;AAClC,QAAI,OAAOA,KAAP,KAAiB,QAAjB,IACA,OAAOA,KAAP,KAAiB,QADjB,IAEA,OAAOA,KAAP,KAAiB,SAFrB,EAEgC;AAC5BA,MAAAA,KAAK,GAAGA,KAAK,CAACJ,QAAN,EAAR;;AACA,UAAIS,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;AAC9BL,QAAAA,KAAK,GAAGA,KAAK,CAACM,SAAN,CAAgB,CAAhB,EAAmBC,QAAQ,CAACF,QAAD,EAAW,EAAX,CAA3B,CAAR;AACH;;AACD3D,MAAAA,MAAM,CAAC8D,IAAP,CAAYV,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBE,aAAa,CAACH,QAAD,CAAb,GAA0B1D,GAA1B,GAAgC,EAAlD,CAAvB;AACH,KARD,MASK;AACD,UAAIgE,QAAQ,KAAK,GAAjB,EAAsB;AAClB,YAAII,KAAK,CAACC,OAAN,CAAcV,KAAd,CAAJ,EAA0B;AACtBA,UAAAA,KAAK,CAACrC,MAAN,CAAasC,SAAb,EAAwBrD,OAAxB,CAAgC,UAAUoD,KAAV,EAAiB;AAC7CtD,YAAAA,MAAM,CAAC8D,IAAP,CAAYV,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBE,aAAa,CAACH,QAAD,CAAb,GAA0B1D,GAA1B,GAAgC,EAAlD,CAAvB;AACH,WAFD;AAGH,SAJD,MAKK;AACDJ,UAAAA,MAAM,CAACC,IAAP,CAAY8D,KAAZ,EAAmBpD,OAAnB,CAA2B,UAAU+D,CAAV,EAAa;AACpC,gBAAIV,SAAS,CAACD,KAAK,CAACW,CAAD,CAAN,CAAb,EAAyB;AACrBjE,cAAAA,MAAM,CAAC8D,IAAP,CAAYV,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACW,CAAD,CAAhB,EAAqBA,CAArB,CAAvB;AACH;AACJ,WAJD;AAKH;AACJ,OAbD,MAcK;AACD,cAAMC,GAAG,GAAG,EAAZ;;AACA,YAAIH,KAAK,CAACC,OAAN,CAAcV,KAAd,CAAJ,EAA0B;AACtBA,UAAAA,KAAK,CAACrC,MAAN,CAAasC,SAAb,EAAwBrD,OAAxB,CAAgC,UAAUoD,KAAV,EAAiB;AAC7CY,YAAAA,GAAG,CAACJ,IAAJ,CAASV,WAAW,CAACC,QAAD,EAAWC,KAAX,CAApB;AACH,WAFD;AAGH,SAJD,MAKK;AACD/D,UAAAA,MAAM,CAACC,IAAP,CAAY8D,KAAZ,EAAmBpD,OAAnB,CAA2B,UAAU+D,CAAV,EAAa;AACpC,gBAAIV,SAAS,CAACD,KAAK,CAACW,CAAD,CAAN,CAAb,EAAyB;AACrBC,cAAAA,GAAG,CAACJ,IAAJ,CAASf,gBAAgB,CAACkB,CAAD,CAAzB;AACAC,cAAAA,GAAG,CAACJ,IAAJ,CAASV,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACW,CAAD,CAAL,CAASf,QAAT,EAAX,CAApB;AACH;AACJ,WALD;AAMH;;AACD,YAAIM,aAAa,CAACH,QAAD,CAAjB,EAA6B;AACzBrD,UAAAA,MAAM,CAAC8D,IAAP,CAAYf,gBAAgB,CAACpD,GAAD,CAAhB,GAAwB,GAAxB,GAA8BuE,GAAG,CAACnC,IAAJ,CAAS,GAAT,CAA1C;AACH,SAFD,MAGK,IAAImC,GAAG,CAAClD,MAAJ,KAAe,CAAnB,EAAsB;AACvBhB,UAAAA,MAAM,CAAC8D,IAAP,CAAYI,GAAG,CAACnC,IAAJ,CAAS,GAAT,CAAZ;AACH;AACJ;AACJ;AACJ,GAhDD,MAiDK;AACD,QAAIsB,QAAQ,KAAK,GAAjB,EAAsB;AAClB,UAAIE,SAAS,CAACD,KAAD,CAAb,EAAsB;AAClBtD,QAAAA,MAAM,CAAC8D,IAAP,CAAYf,gBAAgB,CAACpD,GAAD,CAA5B;AACH;AACJ,KAJD,MAKK,IAAI2D,KAAK,KAAK,EAAV,KAAiBD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAlD,CAAJ,EAA4D;AAC7DrD,MAAAA,MAAM,CAAC8D,IAAP,CAAYf,gBAAgB,CAACpD,GAAD,CAAhB,GAAwB,GAApC;AACH,KAFI,MAGA,IAAI2D,KAAK,KAAK,EAAd,EAAkB;AACnBtD,MAAAA,MAAM,CAAC8D,IAAP,CAAY,EAAZ;AACH;AACJ;;AACD,SAAO9D,MAAP;AACH;;AACD,AAAO,SAASmE,QAAT,CAAkBC,QAAlB,EAA4B;AAC/B,SAAO;AACHC,IAAAA,MAAM,EAAEA,MAAM,CAACC,IAAP,CAAY,IAAZ,EAAkBF,QAAlB;AADL,GAAP;AAGH;;AACD,SAASC,MAAT,CAAgBD,QAAhB,EAA0BV,OAA1B,EAAmC;AAC/B,MAAIa,SAAS,GAAG,CAAC,GAAD,EAAM,GAAN,EAAW,GAAX,EAAgB,GAAhB,EAAqB,GAArB,EAA0B,GAA1B,EAA+B,GAA/B,CAAhB;AACA,SAAOH,QAAQ,CAAC9C,OAAT,CAAiB,4BAAjB,EAA+C,UAAUkD,CAAV,EAAaC,UAAb,EAAyBC,OAAzB,EAAkC;AACpF,QAAID,UAAJ,EAAgB;AACZ,UAAIpB,QAAQ,GAAG,EAAf;AACA,YAAMsB,MAAM,GAAG,EAAf;;AACA,UAAIJ,SAAS,CAACK,OAAV,CAAkBH,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAlB,MAA4C,CAAC,CAAjD,EAAoD;AAChDxB,QAAAA,QAAQ,GAAGoB,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAX;AACAJ,QAAAA,UAAU,GAAGA,UAAU,CAACK,MAAX,CAAkB,CAAlB,CAAb;AACH;;AACDL,MAAAA,UAAU,CAAC9D,KAAX,CAAiB,IAAjB,EAAuBT,OAAvB,CAA+B,UAAU6E,QAAV,EAAoB;AAC/C,YAAIb,GAAG,GAAG,4BAA4Bc,IAA5B,CAAiCD,QAAjC,CAAV;AACAJ,QAAAA,MAAM,CAACb,IAAP,CAAYL,SAAS,CAACC,OAAD,EAAUL,QAAV,EAAoBa,GAAG,CAAC,CAAD,CAAvB,EAA4BA,GAAG,CAAC,CAAD,CAAH,IAAUA,GAAG,CAAC,CAAD,CAAzC,CAArB;AACH,OAHD;;AAIA,UAAIb,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;AAC9B,YAAI5B,SAAS,GAAG,GAAhB;;AACA,YAAI4B,QAAQ,KAAK,GAAjB,EAAsB;AAClB5B,UAAAA,SAAS,GAAG,GAAZ;AACH,SAFD,MAGK,IAAI4B,QAAQ,KAAK,GAAjB,EAAsB;AACvB5B,UAAAA,SAAS,GAAG4B,QAAZ;AACH;;AACD,eAAO,CAACsB,MAAM,CAAC3D,MAAP,KAAkB,CAAlB,GAAsBqC,QAAtB,GAAiC,EAAlC,IAAwCsB,MAAM,CAAC5C,IAAP,CAAYN,SAAZ,CAA/C;AACH,OATD,MAUK;AACD,eAAOkD,MAAM,CAAC5C,IAAP,CAAY,GAAZ,CAAP;AACH;AACJ,KAxBD,MAyBK;AACD,aAAOY,cAAc,CAAC+B,OAAD,CAArB;AACH;AACJ,GA7BM,CAAP;AA8BH;;AC/JM,SAASO,KAAT,CAAelF,OAAf,EAAwB;AAC3B;AACA,MAAIU,MAAM,GAAGV,OAAO,CAACU,MAAR,CAAe0C,WAAf,EAAb,CAF2B;;AAI3B,MAAIzC,GAAG,GAAG,CAACX,OAAO,CAACW,GAAR,IAAe,GAAhB,EAAqBY,OAArB,CAA6B,cAA7B,EAA6C,MAA7C,CAAV;AACA,MAAIV,OAAO,GAAGrB,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBF,OAAO,CAACa,OAA1B,CAAd;AACA,MAAIsE,IAAJ;AACA,MAAI1D,UAAU,GAAGgB,IAAI,CAACzC,OAAD,EAAU,CAC3B,QAD2B,EAE3B,SAF2B,EAG3B,KAH2B,EAI3B,SAJ2B,EAK3B,SAL2B,EAM3B,WAN2B,CAAV,CAArB,CAP2B;;AAgB3B,QAAMoF,gBAAgB,GAAGhD,uBAAuB,CAACzB,GAAD,CAAhD;AACAA,EAAAA,GAAG,GAAGyD,QAAQ,CAACzD,GAAD,CAAR,CAAc2D,MAAd,CAAqB7C,UAArB,CAAN;;AACA,MAAI,CAAC,QAAQE,IAAR,CAAahB,GAAb,CAAL,EAAwB;AACpBA,IAAAA,GAAG,GAAGX,OAAO,CAACqF,OAAR,GAAkB1E,GAAxB;AACH;;AACD,QAAM2E,iBAAiB,GAAG9F,MAAM,CAACC,IAAP,CAAYO,OAAZ,EACrBkB,MADqB,CACbyB,MAAD,IAAYyC,gBAAgB,CAAChE,QAAjB,CAA0BuB,MAA1B,CADE,EAErBtB,MAFqB,CAEd,SAFc,CAA1B;AAGA,QAAMkE,mBAAmB,GAAG9C,IAAI,CAAChB,UAAD,EAAa6D,iBAAb,CAAhC;AACA,QAAME,eAAe,GAAG,6BAA6B7D,IAA7B,CAAkCd,OAAO,CAAC4E,MAA1C,CAAxB;;AACA,MAAI,CAACD,eAAL,EAAsB;AAClB,QAAIxF,OAAO,CAACe,SAAR,CAAkB2E,MAAtB,EAA8B;AAC1B;AACA7E,MAAAA,OAAO,CAAC4E,MAAR,GAAiB5E,OAAO,CAAC4E,MAAR,CACZ7E,KADY,CACN,GADM,EAEZU,GAFY,CAEPH,OAAD,IAAaA,OAAO,CAACI,OAAR,CAAgB,kDAAhB,EAAqE,uBAAsBvB,OAAO,CAACe,SAAR,CAAkB2E,MAAO,EAApH,CAFL,EAGZ1D,IAHY,CAGP,GAHO,CAAjB;AAIH;;AACD,QAAIhC,OAAO,CAACe,SAAR,CAAkBC,QAAlB,CAA2BC,MAA/B,EAAuC;AACnC,YAAM0E,wBAAwB,GAAG9E,OAAO,CAAC4E,MAAR,CAAenD,KAAf,CAAqB,qBAArB,KAA+C,EAAhF;AACAzB,MAAAA,OAAO,CAAC4E,MAAR,GAAiBE,wBAAwB,CACpCtE,MADY,CACLrB,OAAO,CAACe,SAAR,CAAkBC,QADb,EAEZM,GAFY,CAEPH,OAAD,IAAa;AAClB,cAAMuE,MAAM,GAAG1F,OAAO,CAACe,SAAR,CAAkB2E,MAAlB,GACR,IAAG1F,OAAO,CAACe,SAAR,CAAkB2E,MAAO,EADpB,GAET,OAFN;AAGA,eAAQ,0BAAyBvE,OAAQ,WAAUuE,MAAO,EAA1D;AACH,OAPgB,EAQZ1D,IARY,CAQP,GARO,CAAjB;AASH;AACJ,GA9C0B;AAgD3B;;;AACA,MAAI,CAAC,KAAD,EAAQ,MAAR,EAAgBZ,QAAhB,CAAyBV,MAAzB,CAAJ,EAAsC;AAClCC,IAAAA,GAAG,GAAGa,kBAAkB,CAACb,GAAD,EAAM4E,mBAAN,CAAxB;AACH,GAFD,MAGK;AACD,QAAI,UAAUA,mBAAd,EAAmC;AAC/BJ,MAAAA,IAAI,GAAGI,mBAAmB,CAACK,IAA3B;AACH,KAFD,MAGK;AACD,UAAIpG,MAAM,CAACC,IAAP,CAAY8F,mBAAZ,EAAiCtE,MAArC,EAA6C;AACzCkE,QAAAA,IAAI,GAAGI,mBAAP;AACH,OAFD,MAGK;AACD1E,QAAAA,OAAO,CAAC,gBAAD,CAAP,GAA4B,CAA5B;AACH;AACJ;AACJ,GAhE0B;;;AAkE3B,MAAI,CAACA,OAAO,CAAC,cAAD,CAAR,IAA4B,OAAOsE,IAAP,KAAgB,WAAhD,EAA6D;AACzDtE,IAAAA,OAAO,CAAC,cAAD,CAAP,GAA0B,iCAA1B;AACH,GApE0B;AAsE3B;;;AACA,MAAI,CAAC,OAAD,EAAU,KAAV,EAAiBO,QAAjB,CAA0BV,MAA1B,KAAqC,OAAOyE,IAAP,KAAgB,WAAzD,EAAsE;AAClEA,IAAAA,IAAI,GAAG,EAAP;AACH,GAzE0B;;;AA2E3B,SAAO3F,MAAM,CAACU,MAAP,CAAc;AAAEQ,IAAAA,MAAF;AAAUC,IAAAA,GAAV;AAAeE,IAAAA;AAAf,GAAd,EAAwC,OAAOsE,IAAP,KAAgB,WAAhB,GAA8B;AAAEA,IAAAA;AAAF,GAA9B,GAAyC,IAAjF,EAAuFnF,OAAO,CAAC6F,OAAR,GAAkB;AAAEA,IAAAA,OAAO,EAAE7F,OAAO,CAAC6F;AAAnB,GAAlB,GAAiD,IAAxI,CAAP;AACH;;AC9EM,SAASC,oBAAT,CAA8B/F,QAA9B,EAAwCU,KAAxC,EAA+CT,OAA/C,EAAwD;AAC3D,SAAOkF,KAAK,CAAC1E,KAAK,CAACT,QAAD,EAAWU,KAAX,EAAkBT,OAAlB,CAAN,CAAZ;AACH;;ACDM,SAAS+F,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;AACnD,QAAMC,QAAQ,GAAG1F,KAAK,CAACwF,WAAD,EAAcC,WAAd,CAAtB;AACA,QAAME,QAAQ,GAAGL,oBAAoB,CAACvB,IAArB,CAA0B,IAA1B,EAAgC2B,QAAhC,CAAjB;AACA,SAAO1G,MAAM,CAACU,MAAP,CAAciG,QAAd,EAAwB;AAC3BD,IAAAA,QAD2B;AAE3BnG,IAAAA,QAAQ,EAAEgG,YAAY,CAACxB,IAAb,CAAkB,IAAlB,EAAwB2B,QAAxB,CAFiB;AAG3B1F,IAAAA,KAAK,EAAEA,KAAK,CAAC+D,IAAN,CAAW,IAAX,EAAiB2B,QAAjB,CAHoB;AAI3BhB,IAAAA;AAJ2B,GAAxB,CAAP;AAMH;;ACZM,MAAMkB,OAAO,GAAG,mBAAhB;;ACEP,MAAMC,SAAS,GAAI,uBAAsBD,OAAQ,IAAGE,+BAAY,EAAG,EAAnE;AAEA;;AACA,AAAO,MAAMJ,QAAQ,GAAG;AACpBxF,EAAAA,MAAM,EAAE,KADY;AAEpB2E,EAAAA,OAAO,EAAE,wBAFW;AAGpBxE,EAAAA,OAAO,EAAE;AACL4E,IAAAA,MAAM,EAAE,gCADH;AAEL,kBAAcY;AAFT,GAHW;AAOpBtF,EAAAA,SAAS,EAAE;AACP2E,IAAAA,MAAM,EAAE,EADD;AAEP1E,IAAAA,QAAQ,EAAE;AAFH;AAPS,CAAjB;;MCHMmF,QAAQ,GAAGJ,YAAY,CAAC,IAAD,EAAOG,QAAP,CAA7B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/dist-src/defaults.js b/node_modules/@octokit/endpoint/dist-src/defaults.js index e1e53fb..456e586 100644 --- a/node_modules/@octokit/endpoint/dist-src/defaults.js +++ b/node_modules/@octokit/endpoint/dist-src/defaults.js @@ -8,10 +8,10 @@ export const DEFAULTS = { baseUrl: "https://api.github.com", headers: { accept: "application/vnd.github.v3+json", - "user-agent": userAgent + "user-agent": userAgent, }, mediaType: { format: "", - previews: [] - } + previews: [], + }, }; diff --git a/node_modules/@octokit/endpoint/dist-src/merge.js b/node_modules/@octokit/endpoint/dist-src/merge.js index a209ffa..1abcecf 100644 --- a/node_modules/@octokit/endpoint/dist-src/merge.js +++ b/node_modules/@octokit/endpoint/dist-src/merge.js @@ -1,5 +1,6 @@ import { lowercaseKeys } from "./util/lowercase-keys"; import { mergeDeep } from "./util/merge-deep"; +import { removeUndefinedProperties } from "./util/remove-undefined-properties"; export function merge(defaults, route, options) { if (typeof route === "string") { let [method, url] = route.split(" "); @@ -10,11 +11,14 @@ export function merge(defaults, route, options) { } // lowercase header names before merging with defaults to avoid duplicates options.headers = lowercaseKeys(options.headers); + // remove properties with undefined values before merging + removeUndefinedProperties(options); + removeUndefinedProperties(options.headers); const mergedOptions = mergeDeep(defaults || {}, options); // mediaType.previews arrays are merged, instead of overwritten if (defaults && defaults.mediaType.previews.length) { mergedOptions.mediaType.previews = defaults.mediaType.previews - .filter(preview => !mergedOptions.mediaType.previews.includes(preview)) + .filter((preview) => !mergedOptions.mediaType.previews.includes(preview)) .concat(mergedOptions.mediaType.previews); } mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, "")); diff --git a/node_modules/@octokit/endpoint/dist-src/parse.js b/node_modules/@octokit/endpoint/dist-src/parse.js index ca68ca9..6bdd1bf 100644 --- a/node_modules/@octokit/endpoint/dist-src/parse.js +++ b/node_modules/@octokit/endpoint/dist-src/parse.js @@ -6,7 +6,7 @@ export function parse(options) { // https://fetch.spec.whatwg.org/#methods let method = options.method.toUpperCase(); // replace :varname with {varname} to make it RFC 6570 compatible - let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{+$1}"); + let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{$1}"); let headers = Object.assign({}, options.headers); let body; let parameters = omit(options, [ @@ -15,7 +15,7 @@ export function parse(options) { "url", "headers", "request", - "mediaType" + "mediaType", ]); // extract variable names from URL to calculate remaining variables later const urlVariableNames = extractUrlVariableNames(url); @@ -24,23 +24,23 @@ export function parse(options) { url = options.baseUrl + url; } const omittedParameters = Object.keys(options) - .filter(option => urlVariableNames.includes(option)) + .filter((option) => urlVariableNames.includes(option)) .concat("baseUrl"); const remainingParameters = omit(parameters, omittedParameters); - const isBinaryRequset = /application\/octet-stream/i.test(headers.accept); - if (!isBinaryRequset) { + const isBinaryRequest = /application\/octet-stream/i.test(headers.accept); + if (!isBinaryRequest) { if (options.mediaType.format) { // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw headers.accept = headers.accept .split(/,/) - .map(preview => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)) + .map((preview) => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)) .join(","); } if (options.mediaType.previews.length) { const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || []; headers.accept = previewsFromAcceptHeader .concat(options.mediaType.previews) - .map(preview => { + .map((preview) => { const format = options.mediaType.format ? `.${options.mediaType.format}` : "+json"; diff --git a/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js b/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js index a78812f..d26be31 100644 --- a/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js +++ b/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js @@ -7,13 +7,9 @@ export function addQueryParameters(url, parameters) { return (url + separator + names - .map(name => { + .map((name) => { if (name === "q") { - return ("q=" + - parameters - .q.split("+") - .map(encodeURIComponent) - .join("+")); + return ("q=" + parameters.q.split("+").map(encodeURIComponent).join("+")); } return `${name}=${encodeURIComponent(parameters[name])}`; }) diff --git a/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js b/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js index d1c5402..d92aca3 100644 --- a/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js +++ b/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js @@ -1,7 +1,7 @@ -import isPlainObject from "is-plain-object"; +import { isPlainObject } from "is-plain-object"; export function mergeDeep(defaults, options) { const result = Object.assign({}, defaults); - Object.keys(options).forEach(key => { + Object.keys(options).forEach((key) => { if (isPlainObject(options[key])) { if (!(key in defaults)) Object.assign(result, { [key]: options[key] }); diff --git a/node_modules/@octokit/endpoint/dist-src/util/omit.js b/node_modules/@octokit/endpoint/dist-src/util/omit.js index 7e1aa6b..6245031 100644 --- a/node_modules/@octokit/endpoint/dist-src/util/omit.js +++ b/node_modules/@octokit/endpoint/dist-src/util/omit.js @@ -1,6 +1,6 @@ export function omit(object, keysToOmit) { return Object.keys(object) - .filter(option => !keysToOmit.includes(option)) + .filter((option) => !keysToOmit.includes(option)) .reduce((obj, key) => { obj[key] = object[key]; return obj; diff --git a/node_modules/@octokit/endpoint/dist-src/util/remove-undefined-properties.js b/node_modules/@octokit/endpoint/dist-src/util/remove-undefined-properties.js new file mode 100644 index 0000000..6b5ee5f --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/util/remove-undefined-properties.js @@ -0,0 +1,8 @@ +export function removeUndefinedProperties(obj) { + for (const key in obj) { + if (obj[key] === undefined) { + delete obj[key]; + } + } + return obj; +} diff --git a/node_modules/@octokit/endpoint/dist-src/util/url-template.js b/node_modules/@octokit/endpoint/dist-src/util/url-template.js index f6d9885..439b3fe 100644 --- a/node_modules/@octokit/endpoint/dist-src/util/url-template.js +++ b/node_modules/@octokit/endpoint/dist-src/util/url-template.js @@ -29,9 +29,7 @@ function encodeReserved(str) { .split(/(%[0-9A-Fa-f]{2})/g) .map(function (part) { if (!/%[0-9A-Fa-f]/.test(part)) { - part = encodeURI(part) - .replace(/%5B/g, "[") - .replace(/%5D/g, "]"); + part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]"); } return part; }) @@ -39,11 +37,7 @@ function encodeReserved(str) { } function encodeUnreserved(str) { return encodeURIComponent(str).replace(/[!'()*]/g, function (c) { - return ("%" + - c - .charCodeAt(0) - .toString(16) - .toUpperCase()); + return "%" + c.charCodeAt(0).toString(16).toUpperCase(); }); } function encodeValue(operator, value, key) { @@ -132,7 +126,7 @@ function getValues(context, operator, key, modifier) { } export function parseUrl(template) { return { - expand: expand.bind(null, template) + expand: expand.bind(null, template), }; } function expand(template, context) { diff --git a/node_modules/@octokit/endpoint/dist-src/version.js b/node_modules/@octokit/endpoint/dist-src/version.js index ef91397..3753577 100644 --- a/node_modules/@octokit/endpoint/dist-src/version.js +++ b/node_modules/@octokit/endpoint/dist-src/version.js @@ -1 +1 @@ -export const VERSION = "5.5.1"; +export const VERSION = "6.0.10"; diff --git a/node_modules/@octokit/endpoint/dist-src/with-defaults.js b/node_modules/@octokit/endpoint/dist-src/with-defaults.js index 9a1c886..81baf6c 100644 --- a/node_modules/@octokit/endpoint/dist-src/with-defaults.js +++ b/node_modules/@octokit/endpoint/dist-src/with-defaults.js @@ -8,6 +8,6 @@ export function withDefaults(oldDefaults, newDefaults) { DEFAULTS, defaults: withDefaults.bind(null, DEFAULTS), merge: merge.bind(null, DEFAULTS), - parse + parse, }); } diff --git a/node_modules/@octokit/endpoint/dist-types/index.d.ts b/node_modules/@octokit/endpoint/dist-types/index.d.ts index 17be855..1ede136 100644 --- a/node_modules/@octokit/endpoint/dist-types/index.d.ts +++ b/node_modules/@octokit/endpoint/dist-types/index.d.ts @@ -1 +1 @@ -export declare const endpoint: import("@octokit/types").EndpointInterface; +export declare const endpoint: import("@octokit/types").EndpointInterface; diff --git a/node_modules/@octokit/endpoint/dist-types/util/remove-undefined-properties.d.ts b/node_modules/@octokit/endpoint/dist-types/util/remove-undefined-properties.d.ts new file mode 100644 index 0000000..92d8d85 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/util/remove-undefined-properties.d.ts @@ -0,0 +1 @@ +export declare function removeUndefinedProperties(obj: any): any; diff --git a/node_modules/@octokit/endpoint/dist-types/version.d.ts b/node_modules/@octokit/endpoint/dist-types/version.d.ts index 809d28a..633050c 100644 --- a/node_modules/@octokit/endpoint/dist-types/version.d.ts +++ b/node_modules/@octokit/endpoint/dist-types/version.d.ts @@ -1 +1 @@ -export declare const VERSION = "5.5.1"; +export declare const VERSION = "6.0.10"; diff --git a/node_modules/@octokit/endpoint/dist-web/index.js b/node_modules/@octokit/endpoint/dist-web/index.js index a327238..4377ef4 100644 --- a/node_modules/@octokit/endpoint/dist-web/index.js +++ b/node_modules/@octokit/endpoint/dist-web/index.js @@ -1,4 +1,4 @@ -import isPlainObject from 'is-plain-object'; +import { isPlainObject } from 'is-plain-object'; import { getUserAgent } from 'universal-user-agent'; function lowercaseKeys(object) { @@ -13,7 +13,7 @@ function lowercaseKeys(object) { function mergeDeep(defaults, options) { const result = Object.assign({}, defaults); - Object.keys(options).forEach(key => { + Object.keys(options).forEach((key) => { if (isPlainObject(options[key])) { if (!(key in defaults)) Object.assign(result, { [key]: options[key] }); @@ -27,6 +27,15 @@ function mergeDeep(defaults, options) { return result; } +function removeUndefinedProperties(obj) { + for (const key in obj) { + if (obj[key] === undefined) { + delete obj[key]; + } + } + return obj; +} + function merge(defaults, route, options) { if (typeof route === "string") { let [method, url] = route.split(" "); @@ -37,11 +46,14 @@ function merge(defaults, route, options) { } // lowercase header names before merging with defaults to avoid duplicates options.headers = lowercaseKeys(options.headers); + // remove properties with undefined values before merging + removeUndefinedProperties(options); + removeUndefinedProperties(options.headers); const mergedOptions = mergeDeep(defaults || {}, options); // mediaType.previews arrays are merged, instead of overwritten if (defaults && defaults.mediaType.previews.length) { mergedOptions.mediaType.previews = defaults.mediaType.previews - .filter(preview => !mergedOptions.mediaType.previews.includes(preview)) + .filter((preview) => !mergedOptions.mediaType.previews.includes(preview)) .concat(mergedOptions.mediaType.previews); } mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, "")); @@ -57,13 +69,9 @@ function addQueryParameters(url, parameters) { return (url + separator + names - .map(name => { + .map((name) => { if (name === "q") { - return ("q=" + - parameters - .q.split("+") - .map(encodeURIComponent) - .join("+")); + return ("q=" + parameters.q.split("+").map(encodeURIComponent).join("+")); } return `${name}=${encodeURIComponent(parameters[name])}`; }) @@ -84,7 +92,7 @@ function extractUrlVariableNames(url) { function omit(object, keysToOmit) { return Object.keys(object) - .filter(option => !keysToOmit.includes(option)) + .filter((option) => !keysToOmit.includes(option)) .reduce((obj, key) => { obj[key] = object[key]; return obj; @@ -122,9 +130,7 @@ function encodeReserved(str) { .split(/(%[0-9A-Fa-f]{2})/g) .map(function (part) { if (!/%[0-9A-Fa-f]/.test(part)) { - part = encodeURI(part) - .replace(/%5B/g, "[") - .replace(/%5D/g, "]"); + part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]"); } return part; }) @@ -132,11 +138,7 @@ function encodeReserved(str) { } function encodeUnreserved(str) { return encodeURIComponent(str).replace(/[!'()*]/g, function (c) { - return ("%" + - c - .charCodeAt(0) - .toString(16) - .toUpperCase()); + return "%" + c.charCodeAt(0).toString(16).toUpperCase(); }); } function encodeValue(operator, value, key) { @@ -225,7 +227,7 @@ function getValues(context, operator, key, modifier) { } function parseUrl(template) { return { - expand: expand.bind(null, template) + expand: expand.bind(null, template), }; } function expand(template, context) { @@ -266,7 +268,7 @@ function parse(options) { // https://fetch.spec.whatwg.org/#methods let method = options.method.toUpperCase(); // replace :varname with {varname} to make it RFC 6570 compatible - let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{+$1}"); + let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{$1}"); let headers = Object.assign({}, options.headers); let body; let parameters = omit(options, [ @@ -275,7 +277,7 @@ function parse(options) { "url", "headers", "request", - "mediaType" + "mediaType", ]); // extract variable names from URL to calculate remaining variables later const urlVariableNames = extractUrlVariableNames(url); @@ -284,23 +286,23 @@ function parse(options) { url = options.baseUrl + url; } const omittedParameters = Object.keys(options) - .filter(option => urlVariableNames.includes(option)) + .filter((option) => urlVariableNames.includes(option)) .concat("baseUrl"); const remainingParameters = omit(parameters, omittedParameters); - const isBinaryRequset = /application\/octet-stream/i.test(headers.accept); - if (!isBinaryRequset) { + const isBinaryRequest = /application\/octet-stream/i.test(headers.accept); + if (!isBinaryRequest) { if (options.mediaType.format) { // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw headers.accept = headers.accept .split(/,/) - .map(preview => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)) + .map((preview) => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)) .join(","); } if (options.mediaType.previews.length) { const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || []; headers.accept = previewsFromAcceptHeader .concat(options.mediaType.previews) - .map(preview => { + .map((preview) => { const format = options.mediaType.format ? `.${options.mediaType.format}` : "+json"; @@ -351,11 +353,11 @@ function withDefaults(oldDefaults, newDefaults) { DEFAULTS, defaults: withDefaults.bind(null, DEFAULTS), merge: merge.bind(null, DEFAULTS), - parse + parse, }); } -const VERSION = "5.5.1"; +const VERSION = "6.0.10"; const userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`; // DEFAULTS has all properties set that EndpointOptions has, except url. @@ -365,12 +367,12 @@ const DEFAULTS = { baseUrl: "https://api.github.com", headers: { accept: "application/vnd.github.v3+json", - "user-agent": userAgent + "user-agent": userAgent, }, mediaType: { format: "", - previews: [] - } + previews: [], + }, }; const endpoint = withDefaults(null, DEFAULTS); diff --git a/node_modules/@octokit/endpoint/dist-web/index.js.map b/node_modules/@octokit/endpoint/dist-web/index.js.map index 6890009..69cdbcf 100644 --- a/node_modules/@octokit/endpoint/dist-web/index.js.map +++ b/node_modules/@octokit/endpoint/dist-web/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import isPlainObject from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach(key => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter(preview => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map(name => {\n if (name === \"q\") {\n return (\"q=\" +\n parameters\n .q.split(\"+\")\n .map(encodeURIComponent)\n .join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter(option => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part)\n .replace(/%5B/g, \"[\")\n .replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return (\"%\" +\n c\n .charCodeAt(0)\n .toString(16)\n .toUpperCase());\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template)\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{+$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\"\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter(option => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequset = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequset) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map(preview => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map(preview => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n else {\n headers[\"content-length\"] = 0;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse\n });\n}\n","export const VERSION = \"5.5.1\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent\n },\n mediaType: {\n format: \"\",\n previews: []\n }\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":[],"mappings":";;;AAAO,SAAS,aAAa,CAAC,MAAM,EAAE;IAClC,IAAI,CAAC,MAAM,EAAE;QACT,OAAO,EAAE,CAAC;KACb;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK;QAC/C,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACxC,OAAO,MAAM,CAAC;KACjB,EAAE,EAAE,CAAC,CAAC;CACV;;ACPM,SAAS,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE;IACzC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC3C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI;QAChC,IAAI,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE;YAC7B,IAAI,EAAE,GAAG,IAAI,QAAQ,CAAC;gBAClB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;;gBAE/C,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SAC5D;aACI;YACD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SAClD;KACJ,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;CACjB;;ACbM,SAAS,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;IAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC3B,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;KAC7E;SACI;QACD,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;KACtC;;IAED,OAAO,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACjD,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;;IAEzD,IAAI,QAAQ,IAAI,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;QAChD,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ;aACzD,MAAM,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;aACtE,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;KACjD;IACD,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC;IACtH,OAAO,aAAa,CAAC;CACxB;;ACrBM,SAAS,kBAAkB,CAAC,GAAG,EAAE,UAAU,EAAE;IAChD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC;IAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACpB,OAAO,GAAG,CAAC;KACd;IACD,QAAQ,GAAG;QACP,SAAS;QACT,KAAK;aACA,GAAG,CAAC,IAAI,IAAI;YACb,IAAI,IAAI,KAAK,GAAG,EAAE;gBACd,QAAQ,IAAI;oBACR,UAAU;yBACL,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;yBACZ,GAAG,CAAC,kBAAkB,CAAC;yBACvB,IAAI,CAAC,GAAG,CAAC,EAAE;aACvB;YACD,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SAC5D,CAAC;aACG,IAAI,CAAC,GAAG,CAAC,EAAE;CACvB;;ACpBD,MAAM,gBAAgB,GAAG,YAAY,CAAC;AACtC,SAAS,cAAc,CAAC,YAAY,EAAE;IAClC,OAAO,YAAY,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;CAC5D;AACD,AAAO,SAAS,uBAAuB,CAAC,GAAG,EAAE;IACzC,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC5C,IAAI,CAAC,OAAO,EAAE;QACV,OAAO,EAAE,CAAC;KACb;IACD,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CACxE;;ACVM,SAAS,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACrB,MAAM,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC9C,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK;QACtB,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACvB,OAAO,GAAG,CAAC;KACd,EAAE,EAAE,CAAC,CAAC;CACV;;ACPD;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,SAAS,cAAc,CAAC,GAAG,EAAE;IACzB,OAAO,GAAG;SACL,KAAK,CAAC,oBAAoB,CAAC;SAC3B,GAAG,CAAC,UAAU,IAAI,EAAE;QACrB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC5B,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC;iBACjB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;iBACpB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC;KACf,CAAC;SACG,IAAI,CAAC,EAAE,CAAC,CAAC;CACjB;AACD,SAAS,gBAAgB,CAAC,GAAG,EAAE;IAC3B,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE;QAC5D,QAAQ,GAAG;YACP,CAAC;iBACI,UAAU,CAAC,CAAC,CAAC;iBACb,QAAQ,CAAC,EAAE,CAAC;iBACZ,WAAW,EAAE,EAAE;KAC3B,CAAC,CAAC;CACN;AACD,SAAS,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE;IACvC,KAAK;QACD,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG;cAC9B,cAAc,CAAC,KAAK,CAAC;cACrB,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAClC,IAAI,GAAG,EAAE;QACL,OAAO,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC;KAC9C;SACI;QACD,OAAO,KAAK,CAAC;KAChB;CACJ;AACD,SAAS,SAAS,CAAC,KAAK,EAAE;IACtB,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;CAChD;AACD,SAAS,aAAa,CAAC,QAAQ,EAAE;IAC7B,OAAO,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC;CACnE;AACD,SAAS,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE;IACjD,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;IACtC,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE,EAAE;QAClC,IAAI,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,SAAS,EAAE;YAC5B,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YACzB,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;gBAC9B,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;aACtD;YACD,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;SACjF;aACI;YACD,IAAI,QAAQ,KAAK,GAAG,EAAE;gBAClB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBACtB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;wBAC7C,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;qBACjF,CAAC,CAAC;iBACN;qBACI;oBACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;wBACpC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;4BACrB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;yBACnD;qBACJ,CAAC,CAAC;iBACN;aACJ;iBACI;gBACD,MAAM,GAAG,GAAG,EAAE,CAAC;gBACf,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBACtB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;wBAC7C,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;qBAC1C,CAAC,CAAC;iBACN;qBACI;oBACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;wBACpC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;4BACrB,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;4BAC9B,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;yBACxD;qBACJ,CAAC,CAAC;iBACN;gBACD,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE;oBACzB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;iBAC5D;qBACI,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;oBACvB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;iBAC9B;aACJ;SACJ;KACJ;SACI;QACD,IAAI,QAAQ,KAAK,GAAG,EAAE;YAClB,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;gBAClB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;aACtC;SACJ;aACI,IAAI,KAAK,KAAK,EAAE,KAAK,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC,EAAE;YAC7D,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;SAC5C;aACI,IAAI,KAAK,KAAK,EAAE,EAAE;YACnB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACnB;KACJ;IACD,OAAO,MAAM,CAAC;CACjB;AACD,AAAO,SAAS,QAAQ,CAAC,QAAQ,EAAE;IAC/B,OAAO;QACH,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;KACtC,CAAC;CACL;AACD,SAAS,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE;IAC/B,IAAI,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACpD,OAAO,QAAQ,CAAC,OAAO,CAAC,4BAA4B,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE;QACpF,IAAI,UAAU,EAAE;YACZ,IAAI,QAAQ,GAAG,EAAE,CAAC;YAClB,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE;gBAChD,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAChC,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;aACrC;YACD,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,QAAQ,EAAE;gBAC/C,IAAI,GAAG,GAAG,2BAA2B,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACrD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACvE,CAAC,CAAC;YACH,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;gBAC9B,IAAI,SAAS,GAAG,GAAG,CAAC;gBACpB,IAAI,QAAQ,KAAK,GAAG,EAAE;oBAClB,SAAS,GAAG,GAAG,CAAC;iBACnB;qBACI,IAAI,QAAQ,KAAK,GAAG,EAAE;oBACvB,SAAS,GAAG,QAAQ,CAAC;iBACxB;gBACD,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,QAAQ,GAAG,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aACzE;iBACI;gBACD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAC3B;SACJ;aACI;YACD,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC;SAClC;KACJ,CAAC,CAAC;CACN;;ACrKM,SAAS,KAAK,CAAC,OAAO,EAAE;;IAE3B,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;;IAE1C,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,EAAE,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAChE,IAAI,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACjD,IAAI,IAAI,CAAC;IACT,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE;QAC3B,QAAQ;QACR,SAAS;QACT,KAAK;QACL,SAAS;QACT,SAAS;QACT,WAAW;KACd,CAAC,CAAC;;IAEH,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC;IACtD,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACvC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QACpB,GAAG,GAAG,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;KAC/B;IACD,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;SACzC,MAAM,CAAC,MAAM,IAAI,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACnD,MAAM,CAAC,SAAS,CAAC,CAAC;IACvB,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;IAChE,MAAM,eAAe,GAAG,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1E,IAAI,CAAC,eAAe,EAAE;QAClB,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE;;YAE1B,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM;iBAC1B,KAAK,CAAC,GAAG,CAAC;iBACV,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,kDAAkD,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;iBACtI,IAAI,CAAC,GAAG,CAAC,CAAC;SAClB;QACD,IAAI,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;YACnC,MAAM,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;YACnF,OAAO,CAAC,MAAM,GAAG,wBAAwB;iBACpC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC;iBAClC,GAAG,CAAC,OAAO,IAAI;gBAChB,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM;sBACjC,CAAC,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;sBAC9B,OAAO,CAAC;gBACd,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;aAC/D,CAAC;iBACG,IAAI,CAAC,GAAG,CAAC,CAAC;SAClB;KACJ;;;IAGD,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAClC,GAAG,GAAG,kBAAkB,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;KACtD;SACI;QACD,IAAI,MAAM,IAAI,mBAAmB,EAAE;YAC/B,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;SACnC;aACI;YACD,IAAI,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,EAAE;gBACzC,IAAI,GAAG,mBAAmB,CAAC;aAC9B;iBACI;gBACD,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;aACjC;SACJ;KACJ;;IAED,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;QACzD,OAAO,CAAC,cAAc,CAAC,GAAG,iCAAiC,CAAC;KAC/D;;;IAGD,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;QAClE,IAAI,GAAG,EAAE,CAAC;KACb;;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,OAAO,IAAI,KAAK,WAAW,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,OAAO,CAAC,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;CACxJ;;AC9EM,SAAS,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;IAC3D,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;CACjD;;ACDM,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;IACnD,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC3D,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;QAC3B,QAAQ;QACR,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;QAC3C,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;QACjC,KAAK;KACR,CAAC,CAAC;CACN;;ACZM,MAAM,OAAO,GAAG,mBAAmB,CAAC;;ACE3C,MAAM,SAAS,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;;;AAGrE,AAAO,MAAM,QAAQ,GAAG;IACpB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,wBAAwB;IACjC,OAAO,EAAE;QACL,MAAM,EAAE,gCAAgC;QACxC,YAAY,EAAE,SAAS;KAC1B;IACD,SAAS,EAAE;QACP,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE,EAAE;KACf;CACJ,CAAC;;ACdU,MAAC,QAAQ,GAAG,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/util/remove-undefined-properties.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import { isPlainObject } from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach((key) => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","export function removeUndefinedProperties(obj) {\n for (const key in obj) {\n if (obj[key] === undefined) {\n delete obj[key];\n }\n }\n return obj;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nimport { removeUndefinedProperties } from \"./util/remove-undefined-properties\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n // remove properties with undefined values before merging\n removeUndefinedProperties(options);\n removeUndefinedProperties(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter((preview) => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map((name) => {\n if (name === \"q\") {\n return (\"q=\" + parameters.q.split(\"+\").map(encodeURIComponent).join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter((option) => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part).replace(/%5B/g, \"[\").replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return \"%\" + c.charCodeAt(0).toString(16).toUpperCase();\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template),\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\",\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter((option) => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequest = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequest) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map((preview) => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map((preview) => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n else {\n headers[\"content-length\"] = 0;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse,\n });\n}\n","export const VERSION = \"6.0.10\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent,\n },\n mediaType: {\n format: \"\",\n previews: [],\n },\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":[],"mappings":";;;AAAO,SAAS,aAAa,CAAC,MAAM,EAAE;AACtC,IAAI,IAAI,CAAC,MAAM,EAAE;AACjB,QAAQ,OAAO,EAAE,CAAC;AAClB,KAAK;AACL,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK;AACvD,QAAQ,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAChD,QAAQ,OAAO,MAAM,CAAC;AACtB,KAAK,EAAE,EAAE,CAAC,CAAC;AACX;;ACPO,SAAS,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE;AAC7C,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;AAC/C,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,KAAK;AAC1C,QAAQ,IAAI,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE;AACzC,YAAY,IAAI,EAAE,GAAG,IAAI,QAAQ,CAAC;AAClC,gBAAgB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAC/D;AACA,gBAAgB,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,SAAS;AACT,aAAa;AACb,YAAY,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAC3D,SAAS;AACT,KAAK,CAAC,CAAC;AACP,IAAI,OAAO,MAAM,CAAC;AAClB,CAAC;;ACfM,SAAS,yBAAyB,CAAC,GAAG,EAAE;AAC/C,IAAI,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE;AAC3B,QAAQ,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;AACpC,YAAY,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;AAC5B,SAAS;AACT,KAAK;AACL,IAAI,OAAO,GAAG,CAAC;AACf,CAAC;;ACJM,SAAS,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;AAChD,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AACnC,QAAQ,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC7C,QAAQ,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;AAClF,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AAC3C,KAAK;AACL;AACA,IAAI,OAAO,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACrD;AACA,IAAI,yBAAyB,CAAC,OAAO,CAAC,CAAC;AACvC,IAAI,yBAAyB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAC/C,IAAI,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;AAC7D;AACA,IAAI,IAAI,QAAQ,IAAI,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;AACxD,QAAQ,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ;AACtE,aAAa,MAAM,CAAC,CAAC,OAAO,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACrF,aAAa,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AACtD,KAAK;AACL,IAAI,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC;AAC1H,IAAI,OAAO,aAAa,CAAC;AACzB,CAAC;;ACzBM,SAAS,kBAAkB,CAAC,GAAG,EAAE,UAAU,EAAE;AACpD,IAAI,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC;AACjD,IAAI,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AAC1C,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;AAC5B,QAAQ,OAAO,GAAG,CAAC;AACnB,KAAK;AACL,IAAI,QAAQ,GAAG;AACf,QAAQ,SAAS;AACjB,QAAQ,KAAK;AACb,aAAa,GAAG,CAAC,CAAC,IAAI,KAAK;AAC3B,YAAY,IAAI,IAAI,KAAK,GAAG,EAAE;AAC9B,gBAAgB,QAAQ,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;AAC1F,aAAa;AACb,YAAY,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACrE,SAAS,CAAC;AACV,aAAa,IAAI,CAAC,GAAG,CAAC,EAAE;AACxB,CAAC;;AChBD,MAAM,gBAAgB,GAAG,YAAY,CAAC;AACtC,SAAS,cAAc,CAAC,YAAY,EAAE;AACtC,IAAI,OAAO,YAAY,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC7D,CAAC;AACD,AAAO,SAAS,uBAAuB,CAAC,GAAG,EAAE;AAC7C,IAAI,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAChD,IAAI,IAAI,CAAC,OAAO,EAAE;AAClB,QAAQ,OAAO,EAAE,CAAC;AAClB,KAAK;AACL,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACzE,CAAC;;ACVM,SAAS,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE;AACzC,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;AAC9B,SAAS,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACzD,SAAS,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK;AAC9B,QAAQ,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAC/B,QAAQ,OAAO,GAAG,CAAC;AACnB,KAAK,EAAE,EAAE,CAAC,CAAC;AACX,CAAC;;ACPD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,cAAc,CAAC,GAAG,EAAE;AAC7B,IAAI,OAAO,GAAG;AACd,SAAS,KAAK,CAAC,oBAAoB,CAAC;AACpC,SAAS,GAAG,CAAC,UAAU,IAAI,EAAE;AAC7B,QAAQ,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;AACxC,YAAY,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC7E,SAAS;AACT,QAAQ,OAAO,IAAI,CAAC;AACpB,KAAK,CAAC;AACN,SAAS,IAAI,CAAC,EAAE,CAAC,CAAC;AAClB,CAAC;AACD,SAAS,gBAAgB,CAAC,GAAG,EAAE;AAC/B,IAAI,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE;AACpE,QAAQ,OAAO,GAAG,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAChE,KAAK,CAAC,CAAC;AACP,CAAC;AACD,SAAS,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE;AAC3C,IAAI,KAAK;AACT,QAAQ,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG;AAC5C,cAAc,cAAc,CAAC,KAAK,CAAC;AACnC,cAAc,gBAAgB,CAAC,KAAK,CAAC,CAAC;AACtC,IAAI,IAAI,GAAG,EAAE;AACb,QAAQ,OAAO,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC;AACnD,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,KAAK,CAAC;AACrB,KAAK;AACL,CAAC;AACD,SAAS,SAAS,CAAC,KAAK,EAAE;AAC1B,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;AACjD,CAAC;AACD,SAAS,aAAa,CAAC,QAAQ,EAAE;AACjC,IAAI,OAAO,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC;AACpE,CAAC;AACD,SAAS,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE;AACrD,IAAI,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;AAC1C,IAAI,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE,EAAE;AAC1C,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ;AACrC,YAAY,OAAO,KAAK,KAAK,QAAQ;AACrC,YAAY,OAAO,KAAK,KAAK,SAAS,EAAE;AACxC,YAAY,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;AACrC,YAAY,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC9C,gBAAgB,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;AACnE,aAAa;AACb,YAAY,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;AAC1F,SAAS;AACT,aAAa;AACb,YAAY,IAAI,QAAQ,KAAK,GAAG,EAAE;AAClC,gBAAgB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AAC1C,oBAAoB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;AACrE,wBAAwB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;AACtG,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,qBAAqB;AACrB,oBAAoB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;AAC5D,wBAAwB,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;AACjD,4BAA4B,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC5E,yBAAyB;AACzB,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,aAAa;AACb,iBAAiB;AACjB,gBAAgB,MAAM,GAAG,GAAG,EAAE,CAAC;AAC/B,gBAAgB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AAC1C,oBAAoB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;AACrE,wBAAwB,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;AAC/D,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,qBAAqB;AACrB,oBAAoB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;AAC5D,wBAAwB,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;AACjD,4BAA4B,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1D,4BAA4B,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;AACjF,yBAAyB;AACzB,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,gBAAgB,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE;AAC7C,oBAAoB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC7E,iBAAiB;AACjB,qBAAqB,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;AAC3C,oBAAoB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/C,iBAAiB;AACjB,aAAa;AACb,SAAS;AACT,KAAK;AACL,SAAS;AACT,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC9B,YAAY,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;AAClC,gBAAgB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;AACnD,aAAa;AACb,SAAS;AACT,aAAa,IAAI,KAAK,KAAK,EAAE,KAAK,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC,EAAE;AACzE,YAAY,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AACrD,SAAS;AACT,aAAa,IAAI,KAAK,KAAK,EAAE,EAAE;AAC/B,YAAY,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC5B,SAAS;AACT,KAAK;AACL,IAAI,OAAO,MAAM,CAAC;AAClB,CAAC;AACD,AAAO,SAAS,QAAQ,CAAC,QAAQ,EAAE;AACnC,IAAI,OAAO;AACX,QAAQ,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AAC3C,KAAK,CAAC;AACN,CAAC;AACD,SAAS,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE;AACnC,IAAI,IAAI,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACxD,IAAI,OAAO,QAAQ,CAAC,OAAO,CAAC,4BAA4B,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE;AAC5F,QAAQ,IAAI,UAAU,EAAE;AACxB,YAAY,IAAI,QAAQ,GAAG,EAAE,CAAC;AAC9B,YAAY,MAAM,MAAM,GAAG,EAAE,CAAC;AAC9B,YAAY,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE;AAChE,gBAAgB,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAChD,gBAAgB,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAClD,aAAa;AACb,YAAY,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,QAAQ,EAAE;AAC/D,gBAAgB,IAAI,GAAG,GAAG,2BAA2B,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACrE,gBAAgB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpF,aAAa,CAAC,CAAC;AACf,YAAY,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC9C,gBAAgB,IAAI,SAAS,GAAG,GAAG,CAAC;AACpC,gBAAgB,IAAI,QAAQ,KAAK,GAAG,EAAE;AACtC,oBAAoB,SAAS,GAAG,GAAG,CAAC;AACpC,iBAAiB;AACjB,qBAAqB,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC3C,oBAAoB,SAAS,GAAG,QAAQ,CAAC;AACzC,iBAAiB;AACjB,gBAAgB,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,QAAQ,GAAG,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACtF,aAAa;AACb,iBAAiB;AACjB,gBAAgB,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACxC,aAAa;AACb,SAAS;AACT,aAAa;AACb,YAAY,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC;AAC3C,SAAS;AACT,KAAK,CAAC,CAAC;AACP,CAAC;;AC/JM,SAAS,KAAK,CAAC,OAAO,EAAE;AAC/B;AACA,IAAI,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;AAC9C;AACA,IAAI,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,EAAE,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;AACnE,IAAI,IAAI,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AACrD,IAAI,IAAI,IAAI,CAAC;AACb,IAAI,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE;AACnC,QAAQ,QAAQ;AAChB,QAAQ,SAAS;AACjB,QAAQ,KAAK;AACb,QAAQ,SAAS;AACjB,QAAQ,SAAS;AACjB,QAAQ,WAAW;AACnB,KAAK,CAAC,CAAC;AACP;AACA,IAAI,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC;AAC1D,IAAI,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AAC3C,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;AAC5B,QAAQ,GAAG,GAAG,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;AACpC,KAAK;AACL,IAAI,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AAClD,SAAS,MAAM,CAAC,CAAC,MAAM,KAAK,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC9D,SAAS,MAAM,CAAC,SAAS,CAAC,CAAC;AAC3B,IAAI,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AACpE,IAAI,MAAM,eAAe,GAAG,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAC9E,IAAI,IAAI,CAAC,eAAe,EAAE;AAC1B,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE;AACtC;AACA,YAAY,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM;AAC3C,iBAAiB,KAAK,CAAC,GAAG,CAAC;AAC3B,iBAAiB,GAAG,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,kDAAkD,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzJ,iBAAiB,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,SAAS;AACT,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;AAC/C,YAAY,MAAM,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;AAC/F,YAAY,OAAO,CAAC,MAAM,GAAG,wBAAwB;AACrD,iBAAiB,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC;AACnD,iBAAiB,GAAG,CAAC,CAAC,OAAO,KAAK;AAClC,gBAAgB,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM;AACvD,sBAAsB,CAAC,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AACpD,sBAAsB,OAAO,CAAC;AAC9B,gBAAgB,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;AAC5E,aAAa,CAAC;AACd,iBAAiB,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,SAAS;AACT,KAAK;AACL;AACA;AACA,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AAC1C,QAAQ,GAAG,GAAG,kBAAkB,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;AAC3D,KAAK;AACL,SAAS;AACT,QAAQ,IAAI,MAAM,IAAI,mBAAmB,EAAE;AAC3C,YAAY,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;AAC5C,SAAS;AACT,aAAa;AACb,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,EAAE;AACzD,gBAAgB,IAAI,GAAG,mBAAmB,CAAC;AAC3C,aAAa;AACb,iBAAiB;AACjB,gBAAgB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;AAC9C,aAAa;AACb,SAAS;AACT,KAAK;AACL;AACA,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;AACjE,QAAQ,OAAO,CAAC,cAAc,CAAC,GAAG,iCAAiC,CAAC;AACpE,KAAK;AACL;AACA;AACA,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;AAC1E,QAAQ,IAAI,GAAG,EAAE,CAAC;AAClB,KAAK;AACL;AACA,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,OAAO,IAAI,KAAK,WAAW,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,OAAO,CAAC,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;AACzJ,CAAC;;AC9EM,SAAS,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;AAC/D,IAAI,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AAClD,CAAC;;ACDM,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;AACvD,IAAI,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AACrD,IAAI,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC/D,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;AACnC,QAAQ,QAAQ;AAChB,QAAQ,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACnD,QAAQ,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACzC,QAAQ,KAAK;AACb,KAAK,CAAC,CAAC;AACP,CAAC;;ACZM,MAAM,OAAO,GAAG,mBAAmB,CAAC;;ACE3C,MAAM,SAAS,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;AACrE;AACA;AACA,AAAO,MAAM,QAAQ,GAAG;AACxB,IAAI,MAAM,EAAE,KAAK;AACjB,IAAI,OAAO,EAAE,wBAAwB;AACrC,IAAI,OAAO,EAAE;AACb,QAAQ,MAAM,EAAE,gCAAgC;AAChD,QAAQ,YAAY,EAAE,SAAS;AAC/B,KAAK;AACL,IAAI,SAAS,EAAE;AACf,QAAQ,MAAM,EAAE,EAAE;AAClB,QAAQ,QAAQ,EAAE,EAAE;AACpB,KAAK;AACL,CAAC,CAAC;;ACdU,MAAC,QAAQ,GAAG,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/LICENSE.md b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/LICENSE.md deleted file mode 100644 index f105ab0..0000000 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/LICENSE.md +++ /dev/null @@ -1,7 +0,0 @@ -# [ISC License](https://spdx.org/licenses/ISC) - -Copyright (c) 2018, Gregor Martynus (https://github.com/gr2m) - -Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/README.md b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/README.md deleted file mode 100644 index d00d14c..0000000 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# universal-user-agent - -> Get a user agent string in both browser and node - -[![@latest](https://img.shields.io/npm/v/universal-user-agent.svg)](https://www.npmjs.com/package/universal-user-agent) -[![Build Status](https://travis-ci.com/gr2m/universal-user-agent.svg?branch=master)](https://travis-ci.com/gr2m/universal-user-agent) -[![Greenkeeper](https://badges.greenkeeper.io/gr2m/universal-user-agent.svg)](https://greenkeeper.io/) - -```js -const { getUserAgent } = require("universal-user-agent"); -// or import { getUserAgent } from "universal-user-agent"; - -const userAgent = getUserAgent(); -// userAgent will look like this -// in browser: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:61.0) Gecko/20100101 Firefox/61.0" -// in node: Node.js/v8.9.4 (macOS High Sierra; x64) -``` - -## Credits - -The Node implementation was originally inspired by [default-user-agent](https://www.npmjs.com/package/default-user-agent). - -## License - -[ISC](LICENSE.md) diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js deleted file mode 100644 index 80a0710..0000000 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js +++ /dev/null @@ -1,22 +0,0 @@ -'use strict'; - -Object.defineProperty(exports, '__esModule', { value: true }); - -function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } - -var osName = _interopDefault(require('os-name')); - -function getUserAgent() { - try { - return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; - } catch (error) { - if (/wmic os get Caption/.test(error.message)) { - return "Windows "; - } - - throw error; - } -} - -exports.getUserAgent = getUserAgent; -//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map deleted file mode 100644 index aff09ec..0000000 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.js","sources":["../dist-src/node.js"],"sourcesContent":["import osName from \"os-name\";\nexport function getUserAgent() {\n try {\n return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`;\n }\n catch (error) {\n if (/wmic os get Caption/.test(error.message)) {\n return \"Windows \";\n }\n throw error;\n }\n}\n"],"names":["getUserAgent","process","version","substr","osName","arch","error","test","message"],"mappings":";;;;;;;;AACO,SAASA,YAAT,GAAwB;MACvB;WACQ,WAAUC,OAAO,CAACC,OAAR,CAAgBC,MAAhB,CAAuB,CAAvB,CAA0B,KAAIC,MAAM,EAAG,KAAIH,OAAO,CAACI,IAAK,GAA1E;GADJ,CAGA,OAAOC,KAAP,EAAc;QACN,sBAAsBC,IAAtB,CAA2BD,KAAK,CAACE,OAAjC,CAAJ,EAA+C;aACpC,gCAAP;;;UAEEF,KAAN;;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js deleted file mode 100644 index 6f52232..0000000 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js +++ /dev/null @@ -1,3 +0,0 @@ -export function getUserAgent() { - return navigator.userAgent; -} diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/index.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/index.js deleted file mode 100644 index c6253f5..0000000 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/index.js +++ /dev/null @@ -1 +0,0 @@ -export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js deleted file mode 100644 index 8b70a03..0000000 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js +++ /dev/null @@ -1,12 +0,0 @@ -import osName from "os-name"; -export function getUserAgent() { - try { - return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; - } - catch (error) { - if (/wmic os get Caption/.test(error.message)) { - return "Windows "; - } - throw error; - } -} diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/index.d.ts b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/index.d.ts deleted file mode 100644 index c6253f5..0000000 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/index.d.ts +++ /dev/null @@ -1 +0,0 @@ -export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/node.d.ts b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/node.d.ts deleted file mode 100644 index a7bb1c4..0000000 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/node.d.ts +++ /dev/null @@ -1 +0,0 @@ -export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js deleted file mode 100644 index 11ec79b..0000000 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js +++ /dev/null @@ -1,6 +0,0 @@ -function getUserAgent() { - return navigator.userAgent; -} - -export { getUserAgent }; -//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map deleted file mode 100644 index 549407e..0000000 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.js","sources":["../dist-src/browser.js"],"sourcesContent":["export function getUserAgent() {\n return navigator.userAgent;\n}\n"],"names":[],"mappings":"AAAO,SAAS,YAAY,GAAG;IAC3B,OAAO,SAAS,CAAC,SAAS,CAAC;CAC9B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json deleted file mode 100644 index 2e3b0e2..0000000 --- a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "_from": "universal-user-agent@^4.0.0", - "_id": "universal-user-agent@4.0.0", - "_inBundle": false, - "_integrity": "sha512-eM8knLpev67iBDizr/YtqkJsF3GK8gzDc6st/WKzrTuPtcsOKW/0IdL4cnMBsU69pOx0otavLWBDGTwg+dB0aA==", - "_location": "/@octokit/endpoint/universal-user-agent", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "universal-user-agent@^4.0.0", - "name": "universal-user-agent", - "escapedName": "universal-user-agent", - "rawSpec": "^4.0.0", - "saveSpec": null, - "fetchSpec": "^4.0.0" - }, - "_requiredBy": [ - "/@octokit/endpoint" - ], - "_resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-4.0.0.tgz", - "_shasum": "27da2ec87e32769619f68a14996465ea1cb9df16", - "_spec": "universal-user-agent@^4.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/endpoint", - "bugs": { - "url": "https://github.com/gr2m/universal-user-agent/issues" - }, - "bundleDependencies": false, - "dependencies": { - "os-name": "^3.1.0" - }, - "deprecated": false, - "description": "Get a user agent string in both browser and node", - "devDependencies": { - "@gr2m/pika-plugin-build-web": "^0.6.0-issue-84.1", - "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.6.0", - "@pika/plugin-ts-standard-pkg": "^0.6.0", - "@types/jest": "^24.0.18", - "jest": "^24.9.0", - "prettier": "^1.18.2", - "semantic-release": "^15.9.15", - "ts-jest": "^24.0.2", - "typescript": "^3.6.2" - }, - "files": [ - "dist-*/", - "bin/" - ], - "homepage": "https://github.com/gr2m/universal-user-agent#readme", - "keywords": [], - "license": "ISC", - "main": "dist-node/index.js", - "module": "dist-web/index.js", - "name": "universal-user-agent", - "pika": true, - "repository": { - "type": "git", - "url": "git+https://github.com/gr2m/universal-user-agent.git" - }, - "sideEffects": false, - "source": "dist-src/index.js", - "types": "dist-types/index.d.ts", - "version": "4.0.0" -} diff --git a/node_modules/@octokit/endpoint/package.json b/node_modules/@octokit/endpoint/package.json index 5e21d95..c4a10b8 100644 --- a/node_modules/@octokit/endpoint/package.json +++ b/node_modules/@octokit/endpoint/package.json @@ -1,54 +1,54 @@ { - "_from": "@octokit/endpoint@^5.5.0", - "_id": "@octokit/endpoint@5.5.1", + "_args": [ + [ + "@octokit/endpoint@6.0.10", + "." + ] + ], + "_from": "@octokit/endpoint@6.0.10", + "_id": "@octokit/endpoint@6.0.10", "_inBundle": false, - "_integrity": "sha512-nBFhRUb5YzVTCX/iAK1MgQ4uWo89Gu0TH00qQHoYRCsE12dWcG1OiLd7v2EIo2+tpUKPMOQ62QFy9hy9Vg2ULg==", + "_integrity": "sha512-9+Xef8nT7OKZglfkOMm7IL6VwxXUQyR7DUSU0LH/F7VNqs8vyd7es5pTfz9E7DwUIx7R3pGscxu1EBhYljyu7Q==", "_location": "/@octokit/endpoint", - "_phantomChildren": { - "os-name": "3.1.0" - }, + "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "@octokit/endpoint@^5.5.0", + "raw": "@octokit/endpoint@6.0.10", "name": "@octokit/endpoint", "escapedName": "@octokit%2fendpoint", "scope": "@octokit", - "rawSpec": "^5.5.0", + "rawSpec": "6.0.10", "saveSpec": null, - "fetchSpec": "^5.5.0" + "fetchSpec": "6.0.10" }, "_requiredBy": [ "/@octokit/request" ], - "_resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-5.5.1.tgz", - "_shasum": "2eea81e110ca754ff2de11c79154ccab4ae16b3f", - "_spec": "@octokit/endpoint@^5.5.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/request", + "_resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.10.tgz", + "_spec": "6.0.10", + "_where": ".", "bugs": { "url": "https://github.com/octokit/endpoint.js/issues" }, - "bundleDependencies": false, - "deno": "dist-web/index.js", "dependencies": { - "@octokit/types": "^2.0.0", - "is-plain-object": "^3.0.0", - "universal-user-agent": "^4.0.0" + "@octokit/types": "^6.0.0", + "is-plain-object": "^5.0.0", + "universal-user-agent": "^6.0.0" }, - "deprecated": false, "description": "Turns REST API endpoints into generic request options", "devDependencies": { "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.7.0", - "@pika/plugin-build-web": "^0.7.0", - "@pika/plugin-ts-standard-pkg": "^0.7.0", - "@types/jest": "^24.0.11", - "jest": "^24.7.1", - "prettier": "1.18.2", - "semantic-release": "^15.13.8", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/jest": "^26.0.0", + "jest": "^26.0.1", + "prettier": "2.2.1", + "semantic-release": "^17.0.0", "semantic-release-plugin-update-version-in-files": "^1.0.0", - "ts-jest": "^24.0.2", - "typescript": "^3.4.5" + "ts-jest": "^26.0.0", + "typescript": "^4.0.2" }, "files": [ "dist-*/", @@ -63,6 +63,7 @@ ], "license": "MIT", "main": "dist-node/index.js", + "module": "dist-web/index.js", "name": "@octokit/endpoint", "pika": true, "publishConfig": { @@ -75,5 +76,5 @@ "sideEffects": false, "source": "dist-src/index.js", "types": "dist-types/index.d.ts", - "version": "5.5.1" + "version": "6.0.10" } diff --git a/node_modules/@octokit/graphql/README.md b/node_modules/@octokit/graphql/README.md index 4e44592..8e6332a 100644 --- a/node_modules/@octokit/graphql/README.md +++ b/node_modules/@octokit/graphql/README.md @@ -3,14 +3,19 @@ > GitHub GraphQL API client for browsers and Node [![@latest](https://img.shields.io/npm/v/@octokit/graphql.svg)](https://www.npmjs.com/package/@octokit/graphql) -[![Build Status](https://travis-ci.com/octokit/graphql.js.svg?branch=master)](https://travis-ci.com/octokit/graphql.js) -[![Coverage Status](https://coveralls.io/repos/github/octokit/graphql.js/badge.svg)](https://coveralls.io/github/octokit/graphql.js) -[![Greenkeeper](https://badges.greenkeeper.io/octokit/graphql.js.svg)](https://greenkeeper.io/) +[![Build Status](https://github.com/octokit/graphql.js/workflows/Test/badge.svg)](https://github.com/octokit/graphql.js/actions?query=workflow%3ATest+branch%3Amaster) - [Usage](#usage) + - [Send a simple query](#send-a-simple-query) + - [Authentication](#authentication) + - [Variables](#variables) + - [Pass query together with headers and variables](#pass-query-together-with-headers-and-variables) + - [Use with GitHub Enterprise](#use-with-github-enterprise) + - [Use custom `@octokit/request` instance](#use-custom-octokitrequest-instance) - [Errors](#errors) +- [Partial responses](#partial-responses) - [Writing tests](#writing-tests) - [License](#license) @@ -18,34 +23,75 @@ ## Usage -Send a simple query + + + + + +
+Browsers + + +Load `@octokit/graphql` directly from [cdn.skypack.dev](https://cdn.skypack.dev) + +```html + +``` + +
+Node + + +Install with npm install @octokit/graphql ```js -const graphql = require('@octokit/graphql') -const { repository } = await graphql(`{ - repository(owner:"octokit", name:"graphql.js") { - issues(last:3) { - edges { - node { - title +const { graphql } = require("@octokit/graphql"); +// or: import { graphql } from "@octokit/graphql"; +``` + +
+ +### Send a simple query + +```js +const { repository } = await graphql( + ` + { + repository(owner: "octokit", name: "graphql.js") { + issues(last: 3) { + edges { + node { + title + } + } } } } + `, + { + headers: { + authorization: `token secret123`, + }, } -}`, { - headers: { - authorization: `token secret123` - } -}) +); ``` -⚠️ Do not use [template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) in the query strings as they make your code vulnerable to query injection attacks (see [#2](https://github.com/octokit/graphql.js/issues/2)). Use variables instead: +### Authentication + +The simplest way to authenticate a request is to set the `Authorization` header, e.g. to a [personal access token](https://github.com/settings/tokens/). ```js -const graphql = require('@octokit/graphql') -const { lastIssues } = await graphql(`query lastIssues($owner: String!, $repo: String!, $num: Int = 3) { - repository(owner:$owner, name:$repo) { - issues(last:$num) { +const graphqlWithAuth = graphql.defaults({ + headers: { + authorization: `token secret123`, + }, +}); +const { repository } = await graphqlWithAuth(` + { + repository(owner: "octokit", name: "graphql.js") { + issues(last: 3) { edges { node { title @@ -53,73 +99,73 @@ const { lastIssues } = await graphql(`query lastIssues($owner: String!, $repo: S } } } - }`, { - owner: 'octokit', - repo: 'graphql.js' - headers: { - authorization: `token secret123` - } } -}) +`); ``` -Create two new clients and set separate default configs for them. +For more complex authentication strategies such as GitHub Apps or Basic, we recommend the according authentication library exported by [`@octokit/auth`](https://github.com/octokit/auth.js). ```js -const graphql1 = require('@octokit/graphql').defaults({ - headers: { - authorization: `token secret123` - } -}) +const { createAppAuth } = require("@octokit/auth-app"); +const auth = createAppAuth({ + id: process.env.APP_ID, + privateKey: process.env.PRIVATE_KEY, + installationId: 123, +}); +const graphqlWithAuth = graphql.defaults({ + request: { + hook: auth.hook, + }, +}); -const graphql2 = require('@octokit/graphql').defaults({ - headers: { - authorization: `token foobar` - } -}) -``` - -Create two clients, the second inherits config from the first. - -```js -const graphql1 = require('@octokit/graphql').defaults({ - headers: { - authorization: `token secret123` - } -}) - -const graphql2 = graphql1.defaults({ - headers: { - 'user-agent': 'my-user-agent/v1.2.3' - } -}) -``` - -Create a new client with default options and run query - -```js -const graphql = require('@octokit/graphql').defaults({ - headers: { - authorization: `token secret123` - } -}) -const { repository } = await graphql(`{ - repository(owner:"octokit", name:"graphql.js") { - issues(last:3) { - edges { - node { - title +const { repository } = await graphqlWithAuth( + `{ + repository(owner: "octokit", name: "graphql.js") { + issues(last: 3) { + edges { + node { + title + } } } } - } -}`) + }` +); ``` -Pass query together with headers and variables +### Variables + +⚠️ Do not use [template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) in the query strings as they make your code vulnerable to query injection attacks (see [#2](https://github.com/octokit/graphql.js/issues/2)). Use variables instead: ```js -const graphql = require('@octokit/graphql') +const { lastIssues } = await graphql( + ` + query lastIssues($owner: String!, $repo: String!, $num: Int = 3) { + repository(owner: $owner, name: $repo) { + issues(last: $num) { + edges { + node { + title + } + } + } + } + } + `, + { + owner: "octokit", + repo: "graphql.js", + headers: { + authorization: `token secret123`, + }, + } +); +``` + +### Pass query together with headers and variables + +```js +const { graphql } = require("@octokit/graphql"); const { lastIssues } = await graphql({ query: `query lastIssues($owner: String!, $repo: String!, $num: Int = 3) { repository(owner:$owner, name:$repo) { @@ -132,34 +178,73 @@ const { lastIssues } = await graphql({ } } }`, - owner: 'octokit', - repo: 'graphql.js' + owner: "octokit", + repo: "graphql.js", headers: { - authorization: `token secret123` - } -}) + authorization: `token secret123`, + }, +}); ``` -Use with GitHub Enterprise +### Use with GitHub Enterprise ```js -const graphql = require('@octokit/graphql').defaults({ - baseUrl: 'https://github-enterprise.acme-inc.com/api', +let { graphql } = require("@octokit/graphql"); +graphql = graphql.defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api", headers: { - authorization: `token secret123` - } -}) -const { repository } = await graphql(`{ - repository(owner:"acme-project", name:"acme-repo") { - issues(last:3) { - edges { - node { - title + authorization: `token secret123`, + }, +}); +const { repository } = await graphql(` + { + repository(owner: "acme-project", name: "acme-repo") { + issues(last: 3) { + edges { + node { + title + } } } } } -}`) +`); +``` + +### Use custom `@octokit/request` instance + +```js +const { request } = require("@octokit/request"); +const { withCustomRequest } = require("@octokit/graphql"); + +let requestCounter = 0; +const myRequest = request.defaults({ + headers: { + authentication: "token secret123", + }, + request: { + hook(request, options) { + requestCounter++; + return request(options); + }, + }, +}); +const myGraphql = withCustomRequest(myRequest); +await request("/"); +await myGraphql(` + { + repository(owner: "acme-project", name: "acme-repo") { + issues(last: 3) { + edges { + node { + title + } + } + } + } + } +`); +// requestCounter is now 2 ``` ## Errors @@ -167,19 +252,20 @@ const { repository } = await graphql(`{ In case of a GraphQL error, `error.message` is set to the first error from the response’s `errors` array. All errors can be accessed at `error.errors`. `error.request` has the request options such as query, variables and headers set for easier debugging. ```js -const graphql = require('@octokit/graphql').defaults({ +let { graphql } = require("@octokit/graphql"); +graphqlt = graphql.defaults({ headers: { - authorization: `token secret123` - } -}) + authorization: `token secret123`, + }, +}); const query = `{ viewer { bioHtml } -}` +}`; try { - const result = await graphql(query) + const result = await graphql(query); } catch (error) { // server responds with // { @@ -193,8 +279,8 @@ try { // }] // } - console.log('Request failed:', error.request) // { query, variables: {}, headers: { authorization: 'token secret123' } } - console.log(error.message) // Field 'bioHtml' doesn't exist on type 'User' + console.log("Request failed:", error.request); // { query, variables: {}, headers: { authorization: 'token secret123' } } + console.log(error.message); // Field 'bioHtml' doesn't exist on type 'User' } ``` @@ -203,11 +289,12 @@ try { A GraphQL query may respond with partial data accompanied by errors. In this case we will throw an error but the partial data will still be accessible through `error.data` ```js -const graphql = require('@octokit/graphql').defaults({ +let { graphql } = require("@octokit/graphql"); +graphql = graphql.defaults({ headers: { - authorization: `token secret123` - } -}) + authorization: `token secret123`, + }, +}); const query = `{ repository(name: "probot", owner: "probot") { name @@ -223,42 +310,42 @@ const query = `{ } } } -}` +}`; try { - const result = await graphql(query) + const result = await graphql(query); } catch (error) { // server responds with - // {  - // "data": {  - // "repository": {  - // "name": "probot",  - // "ref": null  - // }  - // },  - // "errors": [  - // {  - // "type": "INVALID_CURSOR_ARGUMENTS",  - // "path": [  - // "repository",  - // "ref",  - // "target",  - // "history"  - // ],  - // "locations": [  - // {  - // "line": 7,  - // "column": 11  - // }  - // ],  - // "message": "`invalid cursor` does not appear to be a valid cursor."  - // }  - // ]  - // }  + // { + // "data": { + // "repository": { + // "name": "probot", + // "ref": null + // } + // }, + // "errors": [ + // { + // "type": "INVALID_CURSOR_ARGUMENTS", + // "path": [ + // "repository", + // "ref", + // "target", + // "history" + // ], + // "locations": [ + // { + // "line": 7, + // "column": 11 + // } + // ], + // "message": "`invalid cursor` does not appear to be a valid cursor." + // } + // ] + // } - console.log('Request failed:', error.request) // { query, variables: {}, headers: { authorization: 'token secret123' } } - console.log(error.message) // `invalid cursor` does not appear to be a valid cursor. - console.log(error.data) // { repository: { name: 'probot', ref: null } } + console.log("Request failed:", error.request); // { query, variables: {}, headers: { authorization: 'token secret123' } } + console.log(error.message); // `invalid cursor` does not appear to be a valid cursor. + console.log(error.data); // { repository: { name: 'probot', ref: null } } } ``` @@ -267,24 +354,29 @@ try { You can pass a replacement for [the built-in fetch implementation](https://github.com/bitinn/node-fetch) as `request.fetch` option. For example, using [fetch-mock](http://www.wheresrhys.co.uk/fetch-mock/) works great to write tests ```js -const assert = require('assert') -const fetchMock = require('fetch-mock/es5/server') +const assert = require("assert"); +const fetchMock = require("fetch-mock/es5/server"); -const graphql = require('@octokit/graphql') +const { graphql } = require("@octokit/graphql"); -graphql('{ viewer { login } }', { +graphql("{ viewer { login } }", { headers: { - authorization: 'token secret123' + authorization: "token secret123", }, request: { - fetch: fetchMock.sandbox() - .post('https://api.github.com/graphql', (url, options) => { - assert.strictEqual(options.headers.authorization, 'token secret123') - assert.strictEqual(options.body, '{"query":"{ viewer { login } }"}', 'Sends correct query') - return { data: {} } - }) - } -}) + fetch: fetchMock + .sandbox() + .post("https://api.github.com/graphql", (url, options) => { + assert.strictEqual(options.headers.authorization, "token secret123"); + assert.strictEqual( + options.body, + '{"query":"{ viewer { login } }"}', + "Sends correct query" + ); + return { data: {} }; + }), + }, +}); ``` ## License diff --git a/node_modules/@octokit/graphql/dist-node/index.js b/node_modules/@octokit/graphql/dist-node/index.js new file mode 100644 index 0000000..5c26e9f --- /dev/null +++ b/node_modules/@octokit/graphql/dist-node/index.js @@ -0,0 +1,108 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +var request = require('@octokit/request'); +var universalUserAgent = require('universal-user-agent'); + +const VERSION = "4.5.8"; + +class GraphqlError extends Error { + constructor(request, response) { + const message = response.data.errors[0].message; + super(message); + Object.assign(this, response.data); + Object.assign(this, { + headers: response.headers + }); + this.name = "GraphqlError"; + this.request = request; // Maintains proper stack trace (only available on V8) + + /* istanbul ignore next */ + + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + } + +} + +const NON_VARIABLE_OPTIONS = ["method", "baseUrl", "url", "headers", "request", "query", "mediaType"]; +const GHES_V3_SUFFIX_REGEX = /\/api\/v3\/?$/; +function graphql(request, query, options) { + if (typeof query === "string" && options && "query" in options) { + return Promise.reject(new Error(`[@octokit/graphql] "query" cannot be used as variable name`)); + } + + const parsedOptions = typeof query === "string" ? Object.assign({ + query + }, options) : query; + const requestOptions = Object.keys(parsedOptions).reduce((result, key) => { + if (NON_VARIABLE_OPTIONS.includes(key)) { + result[key] = parsedOptions[key]; + return result; + } + + if (!result.variables) { + result.variables = {}; + } + + result.variables[key] = parsedOptions[key]; + return result; + }, {}); // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix + // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451 + + const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl; + + if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) { + requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, "/api/graphql"); + } + + return request(requestOptions).then(response => { + if (response.data.errors) { + const headers = {}; + + for (const key of Object.keys(response.headers)) { + headers[key] = response.headers[key]; + } + + throw new GraphqlError(requestOptions, { + headers, + data: response.data + }); + } + + return response.data.data; + }); +} + +function withDefaults(request$1, newDefaults) { + const newRequest = request$1.defaults(newDefaults); + + const newApi = (query, options) => { + return graphql(newRequest, query, options); + }; + + return Object.assign(newApi, { + defaults: withDefaults.bind(null, newRequest), + endpoint: request.request.endpoint + }); +} + +const graphql$1 = withDefaults(request.request, { + headers: { + "user-agent": `octokit-graphql.js/${VERSION} ${universalUserAgent.getUserAgent()}` + }, + method: "POST", + url: "/graphql" +}); +function withCustomRequest(customRequest) { + return withDefaults(customRequest, { + method: "POST", + url: "/graphql" + }); +} + +exports.graphql = graphql$1; +exports.withCustomRequest = withCustomRequest; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/dist-node/index.js.map b/node_modules/@octokit/graphql/dist-node/index.js.map new file mode 100644 index 0000000..3598288 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/error.js","../dist-src/graphql.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"4.5.8\";\n","export class GraphqlError extends Error {\n constructor(request, response) {\n const message = response.data.errors[0].message;\n super(message);\n Object.assign(this, response.data);\n Object.assign(this, { headers: response.headers });\n this.name = \"GraphqlError\";\n this.request = request;\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n }\n}\n","import { GraphqlError } from \"./error\";\nconst NON_VARIABLE_OPTIONS = [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"query\",\n \"mediaType\",\n];\nconst GHES_V3_SUFFIX_REGEX = /\\/api\\/v3\\/?$/;\nexport function graphql(request, query, options) {\n if (typeof query === \"string\" && options && \"query\" in options) {\n return Promise.reject(new Error(`[@octokit/graphql] \"query\" cannot be used as variable name`));\n }\n const parsedOptions = typeof query === \"string\" ? Object.assign({ query }, options) : query;\n const requestOptions = Object.keys(parsedOptions).reduce((result, key) => {\n if (NON_VARIABLE_OPTIONS.includes(key)) {\n result[key] = parsedOptions[key];\n return result;\n }\n if (!result.variables) {\n result.variables = {};\n }\n result.variables[key] = parsedOptions[key];\n return result;\n }, {});\n // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix\n // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451\n const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl;\n if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {\n requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, \"/api/graphql\");\n }\n return request(requestOptions).then((response) => {\n if (response.data.errors) {\n const headers = {};\n for (const key of Object.keys(response.headers)) {\n headers[key] = response.headers[key];\n }\n throw new GraphqlError(requestOptions, {\n headers,\n data: response.data,\n });\n }\n return response.data.data;\n });\n}\n","import { request as Request } from \"@octokit/request\";\nimport { graphql } from \"./graphql\";\nexport function withDefaults(request, newDefaults) {\n const newRequest = request.defaults(newDefaults);\n const newApi = (query, options) => {\n return graphql(newRequest, query, options);\n };\n return Object.assign(newApi, {\n defaults: withDefaults.bind(null, newRequest),\n endpoint: Request.endpoint,\n });\n}\n","import { request } from \"@octokit/request\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport { withDefaults } from \"./with-defaults\";\nexport const graphql = withDefaults(request, {\n headers: {\n \"user-agent\": `octokit-graphql.js/${VERSION} ${getUserAgent()}`,\n },\n method: \"POST\",\n url: \"/graphql\",\n});\nexport function withCustomRequest(customRequest) {\n return withDefaults(customRequest, {\n method: \"POST\",\n url: \"/graphql\",\n });\n}\n"],"names":["VERSION","GraphqlError","Error","constructor","request","response","message","data","errors","Object","assign","headers","name","captureStackTrace","NON_VARIABLE_OPTIONS","GHES_V3_SUFFIX_REGEX","graphql","query","options","Promise","reject","parsedOptions","requestOptions","keys","reduce","result","key","includes","variables","baseUrl","endpoint","DEFAULTS","test","url","replace","then","withDefaults","newDefaults","newRequest","defaults","newApi","bind","Request","getUserAgent","method","withCustomRequest","customRequest"],"mappings":";;;;;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACAA,MAAMC,YAAN,SAA2BC,KAA3B,CAAiC;AACpCC,EAAAA,WAAW,CAACC,OAAD,EAAUC,QAAV,EAAoB;AAC3B,UAAMC,OAAO,GAAGD,QAAQ,CAACE,IAAT,CAAcC,MAAd,CAAqB,CAArB,EAAwBF,OAAxC;AACA,UAAMA,OAAN;AACAG,IAAAA,MAAM,CAACC,MAAP,CAAc,IAAd,EAAoBL,QAAQ,CAACE,IAA7B;AACAE,IAAAA,MAAM,CAACC,MAAP,CAAc,IAAd,EAAoB;AAAEC,MAAAA,OAAO,EAAEN,QAAQ,CAACM;AAApB,KAApB;AACA,SAAKC,IAAL,GAAY,cAAZ;AACA,SAAKR,OAAL,GAAeA,OAAf,CAN2B;;AAQ3B;;AACA,QAAIF,KAAK,CAACW,iBAAV,EAA6B;AACzBX,MAAAA,KAAK,CAACW,iBAAN,CAAwB,IAAxB,EAA8B,KAAKV,WAAnC;AACH;AACJ;;AAbmC;;ACCxC,MAAMW,oBAAoB,GAAG,CACzB,QADyB,EAEzB,SAFyB,EAGzB,KAHyB,EAIzB,SAJyB,EAKzB,SALyB,EAMzB,OANyB,EAOzB,WAPyB,CAA7B;AASA,MAAMC,oBAAoB,GAAG,eAA7B;AACA,AAAO,SAASC,OAAT,CAAiBZ,OAAjB,EAA0Ba,KAA1B,EAAiCC,OAAjC,EAA0C;AAC7C,MAAI,OAAOD,KAAP,KAAiB,QAAjB,IAA6BC,OAA7B,IAAwC,WAAWA,OAAvD,EAAgE;AAC5D,WAAOC,OAAO,CAACC,MAAR,CAAe,IAAIlB,KAAJ,CAAW,4DAAX,CAAf,CAAP;AACH;;AACD,QAAMmB,aAAa,GAAG,OAAOJ,KAAP,KAAiB,QAAjB,GAA4BR,MAAM,CAACC,MAAP,CAAc;AAAEO,IAAAA;AAAF,GAAd,EAAyBC,OAAzB,CAA5B,GAAgED,KAAtF;AACA,QAAMK,cAAc,GAAGb,MAAM,CAACc,IAAP,CAAYF,aAAZ,EAA2BG,MAA3B,CAAkC,CAACC,MAAD,EAASC,GAAT,KAAiB;AACtE,QAAIZ,oBAAoB,CAACa,QAArB,CAA8BD,GAA9B,CAAJ,EAAwC;AACpCD,MAAAA,MAAM,CAACC,GAAD,CAAN,GAAcL,aAAa,CAACK,GAAD,CAA3B;AACA,aAAOD,MAAP;AACH;;AACD,QAAI,CAACA,MAAM,CAACG,SAAZ,EAAuB;AACnBH,MAAAA,MAAM,CAACG,SAAP,GAAmB,EAAnB;AACH;;AACDH,IAAAA,MAAM,CAACG,SAAP,CAAiBF,GAAjB,IAAwBL,aAAa,CAACK,GAAD,CAArC;AACA,WAAOD,MAAP;AACH,GAVsB,EAUpB,EAVoB,CAAvB,CAL6C;AAiB7C;;AACA,QAAMI,OAAO,GAAGR,aAAa,CAACQ,OAAd,IAAyBzB,OAAO,CAAC0B,QAAR,CAAiBC,QAAjB,CAA0BF,OAAnE;;AACA,MAAId,oBAAoB,CAACiB,IAArB,CAA0BH,OAA1B,CAAJ,EAAwC;AACpCP,IAAAA,cAAc,CAACW,GAAf,GAAqBJ,OAAO,CAACK,OAAR,CAAgBnB,oBAAhB,EAAsC,cAAtC,CAArB;AACH;;AACD,SAAOX,OAAO,CAACkB,cAAD,CAAP,CAAwBa,IAAxB,CAA8B9B,QAAD,IAAc;AAC9C,QAAIA,QAAQ,CAACE,IAAT,CAAcC,MAAlB,EAA0B;AACtB,YAAMG,OAAO,GAAG,EAAhB;;AACA,WAAK,MAAMe,GAAX,IAAkBjB,MAAM,CAACc,IAAP,CAAYlB,QAAQ,CAACM,OAArB,CAAlB,EAAiD;AAC7CA,QAAAA,OAAO,CAACe,GAAD,CAAP,GAAerB,QAAQ,CAACM,OAAT,CAAiBe,GAAjB,CAAf;AACH;;AACD,YAAM,IAAIzB,YAAJ,CAAiBqB,cAAjB,EAAiC;AACnCX,QAAAA,OADmC;AAEnCJ,QAAAA,IAAI,EAAEF,QAAQ,CAACE;AAFoB,OAAjC,CAAN;AAIH;;AACD,WAAOF,QAAQ,CAACE,IAAT,CAAcA,IAArB;AACH,GAZM,CAAP;AAaH;;AC5CM,SAAS6B,YAAT,CAAsBhC,SAAtB,EAA+BiC,WAA/B,EAA4C;AAC/C,QAAMC,UAAU,GAAGlC,SAAO,CAACmC,QAAR,CAAiBF,WAAjB,CAAnB;;AACA,QAAMG,MAAM,GAAG,CAACvB,KAAD,EAAQC,OAAR,KAAoB;AAC/B,WAAOF,OAAO,CAACsB,UAAD,EAAarB,KAAb,EAAoBC,OAApB,CAAd;AACH,GAFD;;AAGA,SAAOT,MAAM,CAACC,MAAP,CAAc8B,MAAd,EAAsB;AACzBD,IAAAA,QAAQ,EAAEH,YAAY,CAACK,IAAb,CAAkB,IAAlB,EAAwBH,UAAxB,CADe;AAEzBR,IAAAA,QAAQ,EAAEY,eAAO,CAACZ;AAFO,GAAtB,CAAP;AAIH;;MCPYd,SAAO,GAAGoB,YAAY,CAAChC,eAAD,EAAU;AACzCO,EAAAA,OAAO,EAAE;AACL,kBAAe,sBAAqBX,OAAQ,IAAG2C,+BAAY,EAAG;AADzD,GADgC;AAIzCC,EAAAA,MAAM,EAAE,MAJiC;AAKzCX,EAAAA,GAAG,EAAE;AALoC,CAAV,CAA5B;AAOP,AAAO,SAASY,iBAAT,CAA2BC,aAA3B,EAA0C;AAC7C,SAAOV,YAAY,CAACU,aAAD,EAAgB;AAC/BF,IAAAA,MAAM,EAAE,MADuB;AAE/BX,IAAAA,GAAG,EAAE;AAF0B,GAAhB,CAAnB;AAIH;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/dist-src/error.js b/node_modules/@octokit/graphql/dist-src/error.js new file mode 100644 index 0000000..37942ba --- /dev/null +++ b/node_modules/@octokit/graphql/dist-src/error.js @@ -0,0 +1,15 @@ +export class GraphqlError extends Error { + constructor(request, response) { + const message = response.data.errors[0].message; + super(message); + Object.assign(this, response.data); + Object.assign(this, { headers: response.headers }); + this.name = "GraphqlError"; + this.request = request; + // Maintains proper stack trace (only available on V8) + /* istanbul ignore next */ + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + } +} diff --git a/node_modules/@octokit/graphql/dist-src/graphql.js b/node_modules/@octokit/graphql/dist-src/graphql.js new file mode 100644 index 0000000..deb9488 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-src/graphql.js @@ -0,0 +1,47 @@ +import { GraphqlError } from "./error"; +const NON_VARIABLE_OPTIONS = [ + "method", + "baseUrl", + "url", + "headers", + "request", + "query", + "mediaType", +]; +const GHES_V3_SUFFIX_REGEX = /\/api\/v3\/?$/; +export function graphql(request, query, options) { + if (typeof query === "string" && options && "query" in options) { + return Promise.reject(new Error(`[@octokit/graphql] "query" cannot be used as variable name`)); + } + const parsedOptions = typeof query === "string" ? Object.assign({ query }, options) : query; + const requestOptions = Object.keys(parsedOptions).reduce((result, key) => { + if (NON_VARIABLE_OPTIONS.includes(key)) { + result[key] = parsedOptions[key]; + return result; + } + if (!result.variables) { + result.variables = {}; + } + result.variables[key] = parsedOptions[key]; + return result; + }, {}); + // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix + // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451 + const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl; + if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) { + requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, "/api/graphql"); + } + return request(requestOptions).then((response) => { + if (response.data.errors) { + const headers = {}; + for (const key of Object.keys(response.headers)) { + headers[key] = response.headers[key]; + } + throw new GraphqlError(requestOptions, { + headers, + data: response.data, + }); + } + return response.data.data; + }); +} diff --git a/node_modules/@octokit/graphql/dist-src/index.js b/node_modules/@octokit/graphql/dist-src/index.js new file mode 100644 index 0000000..b202378 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-src/index.js @@ -0,0 +1,17 @@ +import { request } from "@octokit/request"; +import { getUserAgent } from "universal-user-agent"; +import { VERSION } from "./version"; +import { withDefaults } from "./with-defaults"; +export const graphql = withDefaults(request, { + headers: { + "user-agent": `octokit-graphql.js/${VERSION} ${getUserAgent()}`, + }, + method: "POST", + url: "/graphql", +}); +export function withCustomRequest(customRequest) { + return withDefaults(customRequest, { + method: "POST", + url: "/graphql", + }); +} diff --git a/node_modules/@octokit/graphql/dist-src/types.js b/node_modules/@octokit/graphql/dist-src/types.js new file mode 100644 index 0000000..e69de29 diff --git a/node_modules/@octokit/graphql/dist-src/version.js b/node_modules/@octokit/graphql/dist-src/version.js new file mode 100644 index 0000000..cdefae2 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "4.5.8"; diff --git a/node_modules/@octokit/graphql/dist-src/with-defaults.js b/node_modules/@octokit/graphql/dist-src/with-defaults.js new file mode 100644 index 0000000..6ea309e --- /dev/null +++ b/node_modules/@octokit/graphql/dist-src/with-defaults.js @@ -0,0 +1,12 @@ +import { request as Request } from "@octokit/request"; +import { graphql } from "./graphql"; +export function withDefaults(request, newDefaults) { + const newRequest = request.defaults(newDefaults); + const newApi = (query, options) => { + return graphql(newRequest, query, options); + }; + return Object.assign(newApi, { + defaults: withDefaults.bind(null, newRequest), + endpoint: Request.endpoint, + }); +} diff --git a/node_modules/@octokit/graphql/dist-types/error.d.ts b/node_modules/@octokit/graphql/dist-types/error.d.ts new file mode 100644 index 0000000..81b31a4 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-types/error.d.ts @@ -0,0 +1,9 @@ +import { ResponseHeaders } from "@octokit/types"; +import { GraphQlEndpointOptions, GraphQlQueryResponse } from "./types"; +export declare class GraphqlError extends Error { + request: GraphQlEndpointOptions; + constructor(request: GraphQlEndpointOptions, response: { + headers: ResponseHeaders; + data: Required>; + }); +} diff --git a/node_modules/@octokit/graphql/dist-types/graphql.d.ts b/node_modules/@octokit/graphql/dist-types/graphql.d.ts new file mode 100644 index 0000000..2942b8b --- /dev/null +++ b/node_modules/@octokit/graphql/dist-types/graphql.d.ts @@ -0,0 +1,3 @@ +import { request as Request } from "@octokit/request"; +import { RequestParameters, GraphQlQueryResponseData } from "./types"; +export declare function graphql(request: typeof Request, query: string | RequestParameters, options?: RequestParameters): Promise; diff --git a/node_modules/@octokit/graphql/dist-types/index.d.ts b/node_modules/@octokit/graphql/dist-types/index.d.ts new file mode 100644 index 0000000..1878fd4 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-types/index.d.ts @@ -0,0 +1,3 @@ +import { request } from "@octokit/request"; +export declare const graphql: import("./types").graphql; +export declare function withCustomRequest(customRequest: typeof request): import("./types").graphql; diff --git a/node_modules/@octokit/graphql/dist-types/types.d.ts b/node_modules/@octokit/graphql/dist-types/types.d.ts new file mode 100644 index 0000000..ef60d95 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-types/types.d.ts @@ -0,0 +1,50 @@ +import { EndpointOptions, RequestParameters as RequestParametersType, EndpointInterface } from "@octokit/types"; +export declare type GraphQlEndpointOptions = EndpointOptions & { + variables?: { + [key: string]: unknown; + }; +}; +export declare type RequestParameters = RequestParametersType; +export declare type Query = string; +export interface graphql { + /** + * Sends a GraphQL query request based on endpoint options + * The GraphQL query must be specified in `options`. + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: RequestParameters): GraphQlResponse; + /** + * Sends a GraphQL query request based on endpoint options + * + * @param {string} query GraphQL query. Example: `'query { viewer { login } }'`. + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (query: Query, parameters?: RequestParameters): GraphQlResponse; + /** + * Returns a new `endpoint` with updated route and parameters + */ + defaults: (newDefaults: RequestParameters) => graphql; + /** + * Octokit endpoint API, see {@link https://github.com/octokit/endpoint.js|@octokit/endpoint} + */ + endpoint: EndpointInterface; +} +export declare type GraphQlResponse = Promise; +export declare type GraphQlQueryResponseData = { + [key: string]: any; +}; +export declare type GraphQlQueryResponse = { + data: ResponseData; + errors?: [{ + message: string; + path: [string]; + extensions: { + [key: string]: any; + }; + locations: [{ + line: number; + column: number; + }]; + }]; +}; diff --git a/node_modules/@octokit/graphql/dist-types/version.d.ts b/node_modules/@octokit/graphql/dist-types/version.d.ts new file mode 100644 index 0000000..1b94bb9 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "4.5.8"; diff --git a/node_modules/@octokit/graphql/dist-types/with-defaults.d.ts b/node_modules/@octokit/graphql/dist-types/with-defaults.d.ts new file mode 100644 index 0000000..03edc32 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-types/with-defaults.d.ts @@ -0,0 +1,3 @@ +import { request as Request } from "@octokit/request"; +import { graphql as ApiInterface, RequestParameters } from "./types"; +export declare function withDefaults(request: typeof Request, newDefaults: RequestParameters): ApiInterface; diff --git a/node_modules/@octokit/graphql/dist-web/index.js b/node_modules/@octokit/graphql/dist-web/index.js new file mode 100644 index 0000000..9cb20bc --- /dev/null +++ b/node_modules/@octokit/graphql/dist-web/index.js @@ -0,0 +1,95 @@ +import { request } from '@octokit/request'; +import { getUserAgent } from 'universal-user-agent'; + +const VERSION = "4.5.8"; + +class GraphqlError extends Error { + constructor(request, response) { + const message = response.data.errors[0].message; + super(message); + Object.assign(this, response.data); + Object.assign(this, { headers: response.headers }); + this.name = "GraphqlError"; + this.request = request; + // Maintains proper stack trace (only available on V8) + /* istanbul ignore next */ + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + } +} + +const NON_VARIABLE_OPTIONS = [ + "method", + "baseUrl", + "url", + "headers", + "request", + "query", + "mediaType", +]; +const GHES_V3_SUFFIX_REGEX = /\/api\/v3\/?$/; +function graphql(request, query, options) { + if (typeof query === "string" && options && "query" in options) { + return Promise.reject(new Error(`[@octokit/graphql] "query" cannot be used as variable name`)); + } + const parsedOptions = typeof query === "string" ? Object.assign({ query }, options) : query; + const requestOptions = Object.keys(parsedOptions).reduce((result, key) => { + if (NON_VARIABLE_OPTIONS.includes(key)) { + result[key] = parsedOptions[key]; + return result; + } + if (!result.variables) { + result.variables = {}; + } + result.variables[key] = parsedOptions[key]; + return result; + }, {}); + // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix + // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451 + const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl; + if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) { + requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, "/api/graphql"); + } + return request(requestOptions).then((response) => { + if (response.data.errors) { + const headers = {}; + for (const key of Object.keys(response.headers)) { + headers[key] = response.headers[key]; + } + throw new GraphqlError(requestOptions, { + headers, + data: response.data, + }); + } + return response.data.data; + }); +} + +function withDefaults(request$1, newDefaults) { + const newRequest = request$1.defaults(newDefaults); + const newApi = (query, options) => { + return graphql(newRequest, query, options); + }; + return Object.assign(newApi, { + defaults: withDefaults.bind(null, newRequest), + endpoint: request.endpoint, + }); +} + +const graphql$1 = withDefaults(request, { + headers: { + "user-agent": `octokit-graphql.js/${VERSION} ${getUserAgent()}`, + }, + method: "POST", + url: "/graphql", +}); +function withCustomRequest(customRequest) { + return withDefaults(customRequest, { + method: "POST", + url: "/graphql", + }); +} + +export { graphql$1 as graphql, withCustomRequest }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/dist-web/index.js.map b/node_modules/@octokit/graphql/dist-web/index.js.map new file mode 100644 index 0000000..aebdc5e --- /dev/null +++ b/node_modules/@octokit/graphql/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/error.js","../dist-src/graphql.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"4.5.8\";\n","export class GraphqlError extends Error {\n constructor(request, response) {\n const message = response.data.errors[0].message;\n super(message);\n Object.assign(this, response.data);\n Object.assign(this, { headers: response.headers });\n this.name = \"GraphqlError\";\n this.request = request;\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n }\n}\n","import { GraphqlError } from \"./error\";\nconst NON_VARIABLE_OPTIONS = [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"query\",\n \"mediaType\",\n];\nconst GHES_V3_SUFFIX_REGEX = /\\/api\\/v3\\/?$/;\nexport function graphql(request, query, options) {\n if (typeof query === \"string\" && options && \"query\" in options) {\n return Promise.reject(new Error(`[@octokit/graphql] \"query\" cannot be used as variable name`));\n }\n const parsedOptions = typeof query === \"string\" ? Object.assign({ query }, options) : query;\n const requestOptions = Object.keys(parsedOptions).reduce((result, key) => {\n if (NON_VARIABLE_OPTIONS.includes(key)) {\n result[key] = parsedOptions[key];\n return result;\n }\n if (!result.variables) {\n result.variables = {};\n }\n result.variables[key] = parsedOptions[key];\n return result;\n }, {});\n // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix\n // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451\n const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl;\n if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {\n requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, \"/api/graphql\");\n }\n return request(requestOptions).then((response) => {\n if (response.data.errors) {\n const headers = {};\n for (const key of Object.keys(response.headers)) {\n headers[key] = response.headers[key];\n }\n throw new GraphqlError(requestOptions, {\n headers,\n data: response.data,\n });\n }\n return response.data.data;\n });\n}\n","import { request as Request } from \"@octokit/request\";\nimport { graphql } from \"./graphql\";\nexport function withDefaults(request, newDefaults) {\n const newRequest = request.defaults(newDefaults);\n const newApi = (query, options) => {\n return graphql(newRequest, query, options);\n };\n return Object.assign(newApi, {\n defaults: withDefaults.bind(null, newRequest),\n endpoint: Request.endpoint,\n });\n}\n","import { request } from \"@octokit/request\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport { withDefaults } from \"./with-defaults\";\nexport const graphql = withDefaults(request, {\n headers: {\n \"user-agent\": `octokit-graphql.js/${VERSION} ${getUserAgent()}`,\n },\n method: \"POST\",\n url: \"/graphql\",\n});\nexport function withCustomRequest(customRequest) {\n return withDefaults(customRequest, {\n method: \"POST\",\n url: \"/graphql\",\n });\n}\n"],"names":["request","Request","graphql"],"mappings":";;;AAAO,MAAM,OAAO,GAAG,mBAAmB;;ACAnC,MAAM,YAAY,SAAS,KAAK,CAAC;AACxC,IAAI,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE;AACnC,QAAQ,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;AACxD,QAAQ,KAAK,CAAC,OAAO,CAAC,CAAC;AACvB,QAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC3C,QAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;AAC3D,QAAQ,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;AACnC,QAAQ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;AAC/B;AACA;AACA,QAAQ,IAAI,KAAK,CAAC,iBAAiB,EAAE;AACrC,YAAY,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;AAC5D,SAAS;AACT,KAAK;AACL,CAAC;;ACbD,MAAM,oBAAoB,GAAG;AAC7B,IAAI,QAAQ;AACZ,IAAI,SAAS;AACb,IAAI,KAAK;AACT,IAAI,SAAS;AACb,IAAI,SAAS;AACb,IAAI,OAAO;AACX,IAAI,WAAW;AACf,CAAC,CAAC;AACF,MAAM,oBAAoB,GAAG,eAAe,CAAC;AAC7C,AAAO,SAAS,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;AACjD,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,IAAI,OAAO,IAAI,OAAO,EAAE;AACpE,QAAQ,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,0DAA0D,CAAC,CAAC,CAAC,CAAC;AACvG,KAAK;AACL,IAAI,MAAM,aAAa,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC;AAChG,IAAI,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK;AAC9E,QAAQ,IAAI,oBAAoB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AAChD,YAAY,MAAM,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;AAC7C,YAAY,OAAO,MAAM,CAAC;AAC1B,SAAS;AACT,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;AAC/B,YAAY,MAAM,CAAC,SAAS,GAAG,EAAE,CAAC;AAClC,SAAS;AACT,QAAQ,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;AACnD,QAAQ,OAAO,MAAM,CAAC;AACtB,KAAK,EAAE,EAAE,CAAC,CAAC;AACX;AACA;AACA,IAAI,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;AAC/E,IAAI,IAAI,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;AAC5C,QAAQ,cAAc,CAAC,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE,cAAc,CAAC,CAAC;AACnF,KAAK;AACL,IAAI,OAAO,OAAO,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK;AACtD,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE;AAClC,YAAY,MAAM,OAAO,GAAG,EAAE,CAAC;AAC/B,YAAY,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;AAC7D,gBAAgB,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AACrD,aAAa;AACb,YAAY,MAAM,IAAI,YAAY,CAAC,cAAc,EAAE;AACnD,gBAAgB,OAAO;AACvB,gBAAgB,IAAI,EAAE,QAAQ,CAAC,IAAI;AACnC,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;AAClC,KAAK,CAAC,CAAC;AACP,CAAC;;AC5CM,SAAS,YAAY,CAACA,SAAO,EAAE,WAAW,EAAE;AACnD,IAAI,MAAM,UAAU,GAAGA,SAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AACrD,IAAI,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK;AACvC,QAAQ,OAAO,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACnD,KAAK,CAAC;AACN,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;AACjC,QAAQ,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC;AACrD,QAAQ,QAAQ,EAAEC,OAAO,CAAC,QAAQ;AAClC,KAAK,CAAC,CAAC;AACP,CAAC;;ACPW,MAACC,SAAO,GAAG,YAAY,CAAC,OAAO,EAAE;AAC7C,IAAI,OAAO,EAAE;AACb,QAAQ,YAAY,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AACvE,KAAK;AACL,IAAI,MAAM,EAAE,MAAM;AAClB,IAAI,GAAG,EAAE,UAAU;AACnB,CAAC,CAAC,CAAC;AACH,AAAO,SAAS,iBAAiB,CAAC,aAAa,EAAE;AACjD,IAAI,OAAO,YAAY,CAAC,aAAa,EAAE;AACvC,QAAQ,MAAM,EAAE,MAAM;AACtB,QAAQ,GAAG,EAAE,UAAU;AACvB,KAAK,CAAC,CAAC;AACP,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/index.js b/node_modules/@octokit/graphql/index.js deleted file mode 100644 index 7f8278c..0000000 --- a/node_modules/@octokit/graphql/index.js +++ /dev/null @@ -1,15 +0,0 @@ -const { request } = require('@octokit/request') -const getUserAgent = require('universal-user-agent') - -const version = require('./package.json').version -const userAgent = `octokit-graphql.js/${version} ${getUserAgent()}` - -const withDefaults = require('./lib/with-defaults') - -module.exports = withDefaults(request, { - method: 'POST', - url: '/graphql', - headers: { - 'user-agent': userAgent - } -}) diff --git a/node_modules/@octokit/graphql/lib/error.js b/node_modules/@octokit/graphql/lib/error.js deleted file mode 100644 index 4478abd..0000000 --- a/node_modules/@octokit/graphql/lib/error.js +++ /dev/null @@ -1,16 +0,0 @@ -module.exports = class GraphqlError extends Error { - constructor (request, response) { - const message = response.data.errors[0].message - super(message) - - Object.assign(this, response.data) - this.name = 'GraphqlError' - this.request = request - - // Maintains proper stack trace (only available on V8) - /* istanbul ignore next */ - if (Error.captureStackTrace) { - Error.captureStackTrace(this, this.constructor) - } - } -} diff --git a/node_modules/@octokit/graphql/lib/graphql.js b/node_modules/@octokit/graphql/lib/graphql.js deleted file mode 100644 index 4a5b211..0000000 --- a/node_modules/@octokit/graphql/lib/graphql.js +++ /dev/null @@ -1,36 +0,0 @@ -module.exports = graphql - -const GraphqlError = require('./error') - -const NON_VARIABLE_OPTIONS = ['method', 'baseUrl', 'url', 'headers', 'request', 'query'] - -function graphql (request, query, options) { - if (typeof query === 'string') { - options = Object.assign({ query }, options) - } else { - options = query - } - - const requestOptions = Object.keys(options).reduce((result, key) => { - if (NON_VARIABLE_OPTIONS.includes(key)) { - result[key] = options[key] - return result - } - - if (!result.variables) { - result.variables = {} - } - - result.variables[key] = options[key] - return result - }, {}) - - return request(requestOptions) - .then(response => { - if (response.data.errors) { - throw new GraphqlError(requestOptions, response) - } - - return response.data.data - }) -} diff --git a/node_modules/@octokit/graphql/lib/with-defaults.js b/node_modules/@octokit/graphql/lib/with-defaults.js deleted file mode 100644 index a5b1493..0000000 --- a/node_modules/@octokit/graphql/lib/with-defaults.js +++ /dev/null @@ -1,13 +0,0 @@ -module.exports = withDefaults - -const graphql = require('./graphql') - -function withDefaults (request, newDefaults) { - const newRequest = request.defaults(newDefaults) - const newApi = function (query, options) { - return graphql(newRequest, query, options) - } - - newApi.defaults = withDefaults.bind(null, newRequest) - return newApi -} diff --git a/node_modules/@octokit/graphql/package.json b/node_modules/@octokit/graphql/package.json index a1afbee..c28799b 100644 --- a/node_modules/@octokit/graphql/package.json +++ b/node_modules/@octokit/graphql/package.json @@ -1,67 +1,61 @@ { - "_from": "@octokit/graphql@^2.0.1", - "_id": "@octokit/graphql@2.1.3", + "_args": [ + [ + "@octokit/graphql@4.5.8", + "." + ] + ], + "_from": "@octokit/graphql@4.5.8", + "_id": "@octokit/graphql@4.5.8", "_inBundle": false, - "_integrity": "sha512-XoXJqL2ondwdnMIW3wtqJWEwcBfKk37jO/rYkoxNPEVeLBDGsGO1TCWggrAlq3keGt/O+C/7VepXnukUxwt5vA==", + "_integrity": "sha512-WnCtNXWOrupfPJgXe+vSmprZJUr0VIu14G58PMlkWGj3cH+KLZEfKMmbUQ6C3Wwx6fdhzVW1CD5RTnBdUHxhhA==", "_location": "/@octokit/graphql", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "@octokit/graphql@^2.0.1", + "raw": "@octokit/graphql@4.5.8", "name": "@octokit/graphql", "escapedName": "@octokit%2fgraphql", "scope": "@octokit", - "rawSpec": "^2.0.1", + "rawSpec": "4.5.8", "saveSpec": null, - "fetchSpec": "^2.0.1" + "fetchSpec": "4.5.8" }, "_requiredBy": [ - "/@actions/github" + "/@octokit/core" ], - "_resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-2.1.3.tgz", - "_shasum": "60c058a0ed5fa242eca6f938908d95fd1a2f4b92", - "_spec": "@octokit/graphql@^2.0.1", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@actions/github", - "author": { - "name": "Gregor Martynus", - "url": "https://github.com/gr2m" - }, + "_resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.5.8.tgz", + "_spec": "4.5.8", + "_where": ".", "bugs": { "url": "https://github.com/octokit/graphql.js/issues" }, - "bundleDependencies": false, - "bundlesize": [ - { - "path": "./dist/octokit-graphql.min.js.gz", - "maxSize": "5KB" - } - ], "dependencies": { - "@octokit/request": "^5.0.0", - "universal-user-agent": "^2.0.3" + "@octokit/request": "^5.3.0", + "@octokit/types": "^6.0.0", + "universal-user-agent": "^6.0.0" }, - "deprecated": false, "description": "GitHub GraphQL API client for browsers and Node", "devDependencies": { - "chai": "^4.2.0", - "compression-webpack-plugin": "^2.0.0", - "coveralls": "^3.0.3", - "cypress": "^3.1.5", - "fetch-mock": "^7.3.1", - "mkdirp": "^0.5.1", - "mocha": "^6.0.0", - "npm-run-all": "^4.1.3", - "nyc": "^14.0.0", - "semantic-release": "^15.13.3", - "simple-mock": "^0.8.0", - "standard": "^12.0.1", - "webpack": "^4.29.6", - "webpack-bundle-analyzer": "^3.1.0", - "webpack-cli": "^3.2.3" + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/fetch-mock": "^7.2.5", + "@types/jest": "^26.0.0", + "@types/node": "^14.0.4", + "fetch-mock": "^9.0.0", + "jest": "^25.1.0", + "prettier": "^2.0.0", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "ts-jest": "^25.1.0", + "typescript": "^3.4.5" }, "files": [ - "lib" + "dist-*/", + "bin/" ], "homepage": "https://github.com/octokit/graphql.js#readme", "keywords": [ @@ -71,49 +65,19 @@ "graphql" ], "license": "MIT", - "main": "index.js", + "main": "dist-node/index.js", + "module": "dist-web/index.js", "name": "@octokit/graphql", + "pika": true, "publishConfig": { "access": "public" }, - "release": { - "publish": [ - "@semantic-release/npm", - { - "path": "@semantic-release/github", - "assets": [ - "dist/*", - "!dist/*.map.gz" - ] - } - ] - }, "repository": { "type": "git", "url": "git+https://github.com/octokit/graphql.js.git" }, - "scripts": { - "build": "npm-run-all build:*", - "build:development": "webpack --mode development --entry . --output-library=octokitGraphql --output=./dist/octokit-graphql.js --profile --json > dist/bundle-stats.json", - "build:production": "webpack --mode production --entry . --plugin=compression-webpack-plugin --output-library=octokitGraphql --output-path=./dist --output-filename=octokit-graphql.min.js --devtool source-map", - "bundle-report": "webpack-bundle-analyzer dist/bundle-stats.json --mode=static --no-open --report dist/bundle-report.html", - "coverage": "nyc report --reporter=html && open coverage/index.html", - "coverage:upload": "nyc report --reporter=text-lcov | coveralls", - "prebuild": "mkdirp dist/", - "pretest": "standard", - "test": "nyc mocha test/*-test.js", - "test:browser": "cypress run --browser chrome" - }, - "standard": { - "globals": [ - "describe", - "before", - "beforeEach", - "afterEach", - "after", - "it", - "expect" - ] - }, - "version": "2.1.3" + "sideEffects": false, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "version": "4.5.8" } diff --git a/node_modules/@octokit/openapi-types/.github/workflows/release-notification.yml b/node_modules/@octokit/openapi-types/.github/workflows/release-notification.yml new file mode 100644 index 0000000..d29dc50 --- /dev/null +++ b/node_modules/@octokit/openapi-types/.github/workflows/release-notification.yml @@ -0,0 +1,18 @@ +name: Release notification +on: + release: + types: + - published + +jobs: + notify: + runs-on: ubuntu-latest + steps: + - uses: gr2m/await-npm-package-version-action@v1 + with: + package: "@octokit/openapi-types" + version: ${{ github.event.release.tag_name }} + - uses: gr2m/release-notifier-action@v1 + with: + app_id: ${{ secrets.RELEASE_NOTIFIER_APP_ID }} + private_key: ${{ secrets.RELEASE_NOTIFIER_APP_PRIVATE_KEY }} diff --git a/node_modules/@octokit/openapi-types/.github/workflows/release.yml b/node_modules/@octokit/openapi-types/.github/workflows/release.yml new file mode 100644 index 0000000..0da51d7 --- /dev/null +++ b/node_modules/@octokit/openapi-types/.github/workflows/release.yml @@ -0,0 +1,21 @@ +name: Release +on: + push: + branches: + - main + - next + - beta + - "*.x" # maintenance releases + +jobs: + release: + name: release + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2.1.3 + - run: npm ci + - run: npx semantic-release + env: + GITHUB_TOKEN: ${{ secrets.OCTOKITBOT_PAT }} + NPM_TOKEN: ${{ secrets.OCTOKITBOT_NPM_TOKEN }} diff --git a/node_modules/@octokit/openapi-types/.github/workflows/update.yml b/node_modules/@octokit/openapi-types/.github/workflows/update.yml new file mode 100644 index 0000000..3a1548c --- /dev/null +++ b/node_modules/@octokit/openapi-types/.github/workflows/update.yml @@ -0,0 +1,82 @@ +name: Update +on: + repository_dispatch: + types: ["octokit/openapi release"] + + push: + branches: + - dependabot/npm_and_yarn/openapi-typescript-* + + workflow_dispatch: + inputs: + version: + description: "Version of https://www.npmjs.com/package/@octokit/openapi" + required: true + +jobs: + update: + runs-on: ubuntu-latest + if: github.event_name == 'workflow_dispatch' || github.event.client_payload.action == 'published' + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2.1.3 + - run: npm ci + # do not update cache for dependabot update + - run: | + npm run download + npm run generate-types + if: github.event_name == 'repository_dispatch' + env: + VERSION: ${{ github.event.client_payload.release.tag_name }} + - run: | + npm run download + npm run generate-types + if: github.event_name == 'workflow_dispatch' + env: + VERSION: ${{ github.event.inputs.version }} + + # create/update pull request for dispatch event update + - name: Create Pull Request + if: github.event_name != 'push' + uses: gr2m/create-or-update-pull-request-action@v1.x + env: + GITHUB_TOKEN: ${{ secrets.OCTOKITBOT_PAT }} + with: + title: "🚧 OpenAPI types changed" + body: | + Make sure to update the commits so that the merge results in helpful release notes, see [Merging the Pull Request & releasing a new version](https://github.com/octokit/rest.js/blob/master/CONTRIBUTING.md#merging-the-pull-request--releasing-a-new-version). + + In general + + - Avoid breaking changes at all costs + - If there are no typescript changes, use `build: cache` as commit message + - If there are there are only updates, use `fix: ...` + - If there are any new additions, use `feat: ...` + - If there are breaking changes, keep the previous ones and deprecate them. Only if there is no other way, add `BREAKING CHANGE: ...` to the commit body (not subject!) to trigger a breaking change. + branch: "openapi-update" + commit-message: "WIP" + author: "Octokit Bot <33075676+octokitbot@users.noreply.github.com>" + labels: "maintenance" + + # update pull request for dependabot update + - name: Create Pull Request + if: github.event_name == 'push' + uses: gr2m/create-or-update-pull-request-action@v1.x + env: + GITHUB_TOKEN: ${{ secrets.OCTOKITBOT_PAT }} + with: + title: "🚧 OpenAPI types changed" + body: | + Make sure to update the commits so that the merge results in helpful release notes, see [Merging the Pull Request & releasing a new version](https://github.com/octokit/rest.js/blob/master/CONTRIBUTING.md#merging-the-pull-request--releasing-a-new-version). + + In general + + - Avoid breaking changes at all costs + - If there are no typescript changes, use `build: cache` as commit message + - If there are there are only updates, use `fix: ...` + - If there are any new additions, use `feat: ...` + - If there are breaking changes, keep the previous ones and deprecate them. Only if there is no other way, add `BREAKING CHANGE: ...` to the commit body (not subject!) to trigger a breaking change. + branch: "${{ github.ref }}" + commit-message: "WIP" + author: "Octokit Bot <33075676+octokitbot@users.noreply.github.com>" + labels: "maintenance" diff --git a/node_modules/@octokit/types/CODE_OF_CONDUCT.md b/node_modules/@octokit/openapi-types/CODE_OF_CONDUCT.md similarity index 97% rename from node_modules/@octokit/types/CODE_OF_CONDUCT.md rename to node_modules/@octokit/openapi-types/CODE_OF_CONDUCT.md index 8392e63..dad5ddc 100644 --- a/node_modules/@octokit/types/CODE_OF_CONDUCT.md +++ b/node_modules/@octokit/openapi-types/CODE_OF_CONDUCT.md @@ -55,7 +55,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at opensource+octokit@github.com. All +reported by contacting the project team at opensource+coc@martynus.net. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. @@ -72,4 +72,3 @@ available at [https://contributor-covenant.org/version/1/4][version] [homepage]: https://contributor-covenant.org [version]: https://contributor-covenant.org/version/1/4/ - diff --git a/node_modules/execa/license b/node_modules/@octokit/openapi-types/LICENSE similarity index 91% rename from node_modules/execa/license rename to node_modules/@octokit/openapi-types/LICENSE index e7af2f7..c61fbbe 100644 --- a/node_modules/execa/license +++ b/node_modules/@octokit/openapi-types/LICENSE @@ -1,9 +1,7 @@ -MIT License - -Copyright (c) Sindre Sorhus (sindresorhus.com) +Copyright 2020 Gregor Martynus Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/node_modules/@octokit/openapi-types/README.md b/node_modules/@octokit/openapi-types/README.md new file mode 100644 index 0000000..47acb12 --- /dev/null +++ b/node_modules/@octokit/openapi-types/README.md @@ -0,0 +1,9 @@ +# openapi-types.ts + +> Generated TypeScript definitions based on GitHub's OpenAPI spec + +This repository continously converts [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/) into TypeScript definitions and publishes them to npm as `@octokit/openapi-types` + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/openapi-types/cache/openapi-schema.json b/node_modules/@octokit/openapi-types/cache/openapi-schema.json new file mode 100644 index 0000000..234c544 --- /dev/null +++ b/node_modules/@octokit/openapi-types/cache/openapi-schema.json @@ -0,0 +1,67391 @@ +{ + "openapi": "3.0.3", + "info": { + "version": "2.3.1", + "title": "GitHub's official OpenAPI spec + Octokit extension", + "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", + "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, + "termsOfService": "https://docs.github.com/articles/github-terms-of-service", + "contact": { + "name": "Support", + "url": "https://github.com/octokit/openapi" + } + }, + "tags": [ + { + "name": "actions", + "description": "Endpoints to manage GitHub Actions using the REST API." + }, + { + "name": "activity", + "description": "Activity APIs provide access to notifications, subscriptions, and timelines." + }, + { + "name": "apps", + "description": "Information for integrations and installations." + }, + { + "name": "billing", + "description": "Monitor charges and usage from Actions and Packages." + }, + { + "name": "checks", + "description": "Rich interactions with checks run by your integrations." + }, + { + "name": "code-scanning", + "description": "Retrieve code scanning alerts from a repository." + }, + { + "name": "codes-of-conduct", + "description": "Insight into codes of conduct for your communities." + }, + { + "name": "emojis", + "description": "List emojis available to use on GitHub." + }, + { "name": "gists", "description": "View, modify your gists." }, + { "name": "git", "description": "Raw Git functionality." }, + { "name": "gitignore", "description": "View gitignore templates" }, + { + "name": "interactions", + "description": "Owner or admin management of users interactons." + }, + { "name": "issues", "description": "Interact with GitHub Issues." }, + { "name": "licenses", "description": "View various OSS licenses." }, + { "name": "markdown", "description": "Render Github flavored markdown" }, + { + "name": "meta", + "description": "Endpoints that give information about the API." + }, + { "name": "migrations", "description": "Move projects to or from GitHub." }, + { + "name": "oauth-authorizations", + "description": "Manage access of OAuth applications" + }, + { "name": "orgs", "description": "Interact with GitHub Orgs." }, + { "name": "projects", "description": "Interact with GitHub Projects." }, + { "name": "pulls", "description": "Interact with GitHub Pull Requests." }, + { + "name": "rate-limit", + "description": "Check your current rate limit status" + }, + { + "name": "reactions", + "description": "Interact with reactions to various GitHub entities." + }, + { "name": "repos", "description": "Interact with GitHub Repos." }, + { + "name": "scim", + "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." + }, + { "name": "search", "description": "Look for stuff on GitHub." }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, + { "name": "teams", "description": "Interact with GitHub Teams." }, + { + "name": "users", + "description": "Interact with and view information about users and also current user." + } + ], + "servers": [{ "url": "https://api.github.com" }], + "externalDocs": { + "description": "GitHub v3 REST API", + "url": "https://docs.github.com/rest/" + }, + "paths": { + "/": { + "get": { + "summary": "GitHub API Root", + "description": "Get Hypermedia links to resources accessible in GitHub's REST API", + "tags": ["meta"], + "operationId": "meta/root", + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "current_user_url": { "type": "string", "format": "uri" }, + "current_user_authorizations_html_url": { + "type": "string", + "format": "uri" + }, + "authorizations_url": { "type": "string", "format": "uri" }, + "code_search_url": { "type": "string", "format": "uri" }, + "commit_search_url": { "type": "string", "format": "uri" }, + "emails_url": { "type": "string", "format": "uri" }, + "emojis_url": { "type": "string", "format": "uri" }, + "events_url": { "type": "string", "format": "uri" }, + "feeds_url": { "type": "string", "format": "uri" }, + "followers_url": { "type": "string", "format": "uri" }, + "following_url": { "type": "string", "format": "uri" }, + "gists_url": { "type": "string", "format": "uri" }, + "hub_url": { "type": "string", "format": "uri" }, + "issue_search_url": { "type": "string", "format": "uri" }, + "issues_url": { "type": "string", "format": "uri" }, + "keys_url": { "type": "string", "format": "uri" }, + "label_search_url": { "type": "string", "format": "uri" }, + "notifications_url": { "type": "string", "format": "uri" }, + "organization_url": { "type": "string", "format": "uri" }, + "organization_repositories_url": { + "type": "string", + "format": "uri" + }, + "organization_teams_url": { + "type": "string", + "format": "uri" + }, + "public_gists_url": { "type": "string", "format": "uri" }, + "rate_limit_url": { "type": "string", "format": "uri" }, + "repository_url": { "type": "string", "format": "uri" }, + "repository_search_url": { + "type": "string", + "format": "uri" + }, + "current_user_repositories_url": { + "type": "string", + "format": "uri" + }, + "starred_url": { "type": "string", "format": "uri" }, + "starred_gists_url": { "type": "string", "format": "uri" }, + "topic_search_url": { "type": "string", "format": "uri" }, + "user_url": { "type": "string", "format": "uri" }, + "user_organizations_url": { + "type": "string", + "format": "uri" + }, + "user_repositories_url": { + "type": "string", + "format": "uri" + }, + "user_search_url": { "type": "string", "format": "uri" } + }, + "required": [ + "current_user_url", + "current_user_authorizations_html_url", + "authorizations_url", + "code_search_url", + "commit_search_url", + "emails_url", + "emojis_url", + "events_url", + "feeds_url", + "followers_url", + "following_url", + "gists_url", + "hub_url", + "issue_search_url", + "issues_url", + "keys_url", + "label_search_url", + "notifications_url", + "organization_url", + "organization_repositories_url", + "organization_teams_url", + "public_gists_url", + "rate_limit_url", + "repository_url", + "repository_search_url", + "current_user_repositories_url", + "starred_url", + "starred_gists_url", + "user_url", + "user_organizations_url", + "user_repositories_url", + "user_search_url" + ] + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "meta" + }, + "x-octokit": {} + } + }, + "/app": { + "get": { + "summary": "Get the authenticated app", + "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/get-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps/#get-the-authenticated-app" + }, + "parameters": [], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/integration" }, + "examples": { + "default": { "$ref": "#/components/examples/integration" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "apps", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/app-manifests/{code}/conversions": { + "post": { + "summary": "Create a GitHub App from a manifest", + "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", + "tags": ["apps"], + "operationId": "apps/create-from-manifest", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps/#create-a-github-app-from-a-manifest" + }, + "parameters": [ + { + "name": "code", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/integration" }, + { + "type": "object", + "properties": { + "client_id": { "type": "string" }, + "client_secret": { "type": "string" }, + "webhook_secret": { "type": "string" }, + "pem": { "type": "string" } + }, + "required": [ + "client_id", + "client_secret", + "webhook_secret", + "pem" + ], + "additionalProperties": true + } + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration-from-manifest" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/app/hook/config": { + "get": { + "summary": "Get a webhook configuration for an app", + "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/get-webhook-config-for-app", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps#get-a-webhook-configuration-for-an-app" + }, + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/webhook-config" }, + "examples": { + "default": { "$ref": "#/components/examples/webhook-config" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "webhooks" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a webhook configuration for an app", + "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/update-webhook-config-for-app", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps#update-a-webhook-configuration-for-an-app" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "url": { "$ref": "#/components/schemas/webhook-config-url" }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + } + }, + "example": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } + } + } + } + }, + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/webhook-config" }, + "examples": { + "default": { "$ref": "#/components/examples/webhook-config" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/app/installations": { + "get": { + "summary": "List installations for the authenticated app", + "description": "You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.", + "tags": ["apps"], + "operationId": "apps/list-installations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps/#list-installations-for-the-authenticated-app" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" }, + { "$ref": "#/components/parameters/since" }, + { + "name": "outdated", + "in": "query", + "required": false, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "The permissions the installation has are included under the `permissions` key.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/installation" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/base-installation-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "apps", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/app/installations/{installation_id}": { + "get": { + "summary": "Get an installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/get-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps/#get-an-installation-for-the-authenticated-app" + }, + "parameters": [{ "$ref": "#/components/parameters/installation_id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/installation" }, + "examples": { + "default": { + "$ref": "#/components/examples/base-installation" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "apps", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an installation for the authenticated app", + "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/v3/apps/#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/delete-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps/#delete-an-installation-for-the-authenticated-app" + }, + "parameters": [{ "$ref": "#/components/parameters/installation_id" }], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/app/installations/{installation_id}/access_tokens": { + "post": { + "summary": "Create an installation access token for an app", + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/create-installation-access-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps/#create-an-installation-access-token-for-an-app" + }, + "parameters": [{ "$ref": "#/components/parameters/installation_id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repositories": { + "description": "List of repository names that the token should have access to", + "type": "array", + "items": { "type": "string", "example": "rails" } + }, + "repository_ids": { + "description": "List of repository IDs that the token should have access to", + "example": [1], + "type": "array", + "items": { "type": "integer" } + }, + "permissions": { + "$ref": "#/components/schemas/app-permissions" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/installation-token" }, + "examples": { + "default": { + "$ref": "#/components/examples/installation-token" + } + } + } + } + }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "apps", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/app/installations/{installation_id}/suspended": { + "put": { + "summary": "Suspend an app installation", + "description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nSuspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/suspend-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps/#suspend-an-app-installation" + }, + "parameters": [{ "$ref": "#/components/parameters/installation_id" }], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Unsuspend an app installation", + "description": "**Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see \"[Suspending a GitHub App installation](https://docs.github.com/apps/managing-github-apps/suspending-a-github-app-installation/).\"\n\nRemoves a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/unsuspend-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps/#unsuspend-an-app-installation" + }, + "parameters": [{ "$ref": "#/components/parameters/installation_id" }], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/applications/grants": { + "get": { + "summary": "List your grants", + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.", + "tags": ["oauth-authorizations"], + "operationId": "oauth-authorizations/list-grants", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/oauth-authorizations#list-your-grants" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/application-grant" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/application-grant-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2020-11-13", + "deprecationDate": "2020-02-14", + "category": "oauth-authorizations", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/applications/grants/{grant_id}": { + "get": { + "summary": "Get a single grant", + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).", + "tags": ["oauth-authorizations"], + "operationId": "oauth-authorizations/get-grant", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/oauth-authorizations#get-a-single-grant" + }, + "parameters": [{ "$ref": "#/components/parameters/grant_id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/application-grant" }, + "examples": { + "default": { + "$ref": "#/components/examples/application-grant" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2020-11-13", + "deprecationDate": "2020-02-14", + "category": "oauth-authorizations", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a grant", + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "tags": ["oauth-authorizations"], + "operationId": "oauth-authorizations/delete-grant", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/oauth-authorizations#delete-a-grant" + }, + "parameters": [{ "$ref": "#/components/parameters/grant_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2020-11-13", + "deprecationDate": "2020-02-14", + "category": "oauth-authorizations", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/applications/{client_id}/grant": { + "delete": { + "summary": "Delete an app authorization", + "description": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "operationId": "apps/delete-authorization", + "tags": ["apps"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#delete-an-app-authorization" + }, + "parameters": [{ "$ref": "#/components/parameters/client-id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_token": { + "type": "string", + "description": "The OAuth access token used to authenticate to the GitHub API." + } + } + }, + "example": { + "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" + } + } + } + }, + "responses": { + "204": { "description": "Empty response" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "oauth-applications" + }, + "x-octokit": {} + } + }, + "/applications/{client_id}/grants/{access_token}": { + "delete": { + "summary": "Revoke a grant for an application", + "description": "**Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub](https://github.com/settings/applications#authorized).", + "tags": ["apps"], + "operationId": "apps/revoke-grant-for-application", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#revoke-a-grant-for-an-application" + }, + "parameters": [ + { "$ref": "#/components/parameters/client-id" }, + { "$ref": "#/components/parameters/access-token" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2021-05-05", + "deprecationDate": "2020-02-14", + "category": "apps", + "subcategory": "oauth-applications" + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/applications/{client_id}/token": { + "post": { + "summary": "Check a token", + "description": "OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", + "tags": ["apps"], + "operationId": "apps/check-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#check-a-token" + }, + "parameters": [{ "$ref": "#/components/parameters/client-id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "access_token": { + "description": "The access_token of the OAuth application.", + "type": "string" + } + }, + "required": ["access_token"], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/authorization" }, + "examples": { + "default": { + "$ref": "#/components/examples/authorization-with-user" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "oauth-applications" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Reset a token", + "description": "OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "tags": ["apps"], + "operationId": "apps/reset-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#reset-a-token" + }, + "parameters": [{ "$ref": "#/components/parameters/client-id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "access_token": { + "description": "The access_token of the OAuth application.", + "type": "string" + } + }, + "required": ["access_token"], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/authorization" }, + "examples": { + "default": { + "$ref": "#/components/examples/authorization-with-user" + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "oauth-applications" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an app token", + "description": "OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", + "tags": ["apps"], + "operationId": "apps/delete-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#delete-an-app-token" + }, + "parameters": [{ "$ref": "#/components/parameters/client-id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_token": { + "type": "string", + "description": "The OAuth access token used to authenticate to the GitHub API." + } + } + }, + "example": { + "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" + } + } + } + }, + "responses": { + "204": { "description": "Empty response" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "oauth-applications" + }, + "x-octokit": {} + } + }, + "/applications/{client_id}/token/scoped": { + "post": { + "summary": "Create a scoped access token", + "description": "Exchanges a non-repository scoped user-to-server OAuth access token for a repository scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "tags": ["apps"], + "operationId": "apps/scope-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#create-a-scoped-access-token" + }, + "parameters": [{ "$ref": "#/components/parameters/client-id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_token": { + "type": "string", + "description": "**Required.** The OAuth access token used to authenticate to the GitHub API.", + "example": "e72e16c7e42f292c6912e7710c838347ae178b4a" + }, + "target": { + "description": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", + "type": "string", + "example": "octocat" + }, + "target_id": { + "description": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", + "example": 1, + "type": "integer" + }, + "repositories": { + "description": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "type": "array", + "items": { "type": "string", "example": "rails" } + }, + "repository_ids": { + "description": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "example": [1], + "type": "array", + "items": { "type": "integer" } + }, + "permissions": { + "$ref": "#/components/schemas/app-permissions" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/authorization" }, + "examples": { + "default": { "$ref": "#/components/examples/scope-token" } + } + } + } + }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "oauth-applications" + }, + "x-octokit": {} + } + }, + "/applications/{client_id}/tokens/{access_token}": { + "get": { + "summary": "Check an authorization", + "description": "**Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "tags": ["apps"], + "operationId": "apps/check-authorization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#check-an-authorization" + }, + "parameters": [ + { "$ref": "#/components/parameters/client-id" }, + { "$ref": "#/components/parameters/access-token" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/authorization" }] + }, + "examples": { + "default": { + "$ref": "#/components/examples/authorization-with-user" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2021-05-05", + "deprecationDate": "2020-02-14", + "category": "apps", + "subcategory": "oauth-applications" + }, + "deprecated": true, + "x-octokit": {} + }, + "post": { + "summary": "Reset an authorization", + "description": "**Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "tags": ["apps"], + "operationId": "apps/reset-authorization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#reset-an-authorization" + }, + "parameters": [ + { "$ref": "#/components/parameters/client-id" }, + { "$ref": "#/components/parameters/access-token" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/authorization" }, + "examples": { + "default": { + "$ref": "#/components/examples/authorization-with-user" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2021-05-05", + "deprecationDate": "2020-02-14", + "category": "apps", + "subcategory": "oauth-applications" + }, + "deprecated": true, + "x-octokit": {} + }, + "delete": { + "summary": "Revoke an authorization for an application", + "description": "**Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", + "tags": ["apps"], + "operationId": "apps/revoke-authorization-for-application", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#revoke-an-authorization-for-an-application" + }, + "parameters": [ + { "$ref": "#/components/parameters/client-id" }, + { "$ref": "#/components/parameters/access-token" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2021-05-05", + "deprecationDate": "2020-02-14", + "category": "apps", + "subcategory": "oauth-applications" + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/apps/{app_slug}": { + "get": { + "summary": "Get an app", + "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/get-by-slug", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps/#get-an-app" + }, + "parameters": [{ "$ref": "#/components/parameters/app_slug" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/integration" }, + "examples": { + "default": { "$ref": "#/components/examples/integration" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "apps", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/authorizations": { + "get": { + "summary": "List your authorizations", + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).", + "tags": ["oauth-authorizations"], + "operationId": "oauth-authorizations/list-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/authorization" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/authorization-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2020-11-13", + "deprecationDate": "2020-02-14", + "category": "oauth-authorizations", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + }, + "post": { + "summary": "Create a new authorization", + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on).", + "tags": ["oauth-authorizations"], + "operationId": "oauth-authorizations/create-authorization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "scopes": { + "description": "A list of scopes that this authorization is in.", + "type": "array", + "items": { "type": "string" }, + "example": ["public_repo", "user"], + "nullable": true + }, + "note": { + "description": "A note to remind you what the OAuth token is for.", + "type": "string", + "example": "Update all gems" + }, + "note_url": { + "description": "A URL to remind you what app the OAuth token is for.", + "type": "string" + }, + "client_id": { + "description": "The OAuth app client key for which to create the token.", + "maxLength": 20, + "type": "string" + }, + "client_secret": { + "description": "The OAuth app client secret for which to create the token.", + "maxLength": 40, + "type": "string" + }, + "fingerprint": { + "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/authorization" }, + "examples": { + "default": { "$ref": "#/components/examples/authorization" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/authorizations/1", + "schema": { "type": "string" } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "410": { "$ref": "#/components/responses/gone" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2020-11-13", + "deprecationDate": "2020-02-14", + "category": "oauth-authorizations", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/authorizations/clients/{client_id}": { + "put": { + "summary": "Get-or-create an authorization for a specific app", + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\n**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).", + "tags": ["oauth-authorizations"], + "operationId": "oauth-authorizations/get-or-create-authorization-for-app", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app" + }, + "parameters": [{ "$ref": "#/components/parameters/client-id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "client_secret": { + "description": "The OAuth app client secret for which to create the token.", + "maxLength": 40, + "type": "string" + }, + "scopes": { + "description": "A list of scopes that this authorization is in.", + "type": "array", + "items": { "type": "string" }, + "example": ["public_repo", "user"], + "nullable": true + }, + "note": { + "description": "A note to remind you what the OAuth token is for.", + "type": "string", + "example": "Update all gems" + }, + "note_url": { + "description": "A URL to remind you what app the OAuth token is for.", + "type": "string" + }, + "fingerprint": { + "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", + "type": "string" + } + }, + "required": ["client_secret"], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response if returning an existing token", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/authorization" }, + "examples": { + "response-if-returning-an-existing-token": { + "$ref": "#/components/examples/authorization-response-if-returning-an-existing-token-2" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/authorizations/1", + "schema": { "type": "string" } + } + } + }, + "201": { + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/authorization" }, + "examples": { + "default": { "$ref": "#/components/examples/authorization" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/authorizations/1", + "schema": { "type": "string" } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2020-11-13", + "deprecationDate": "2020-02-14", + "category": "oauth-authorizations", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/authorizations/clients/{client_id}/{fingerprint}": { + "put": { + "summary": "Get-or-create an authorization for a specific app and fingerprint", + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"", + "tags": ["oauth-authorizations"], + "operationId": "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint" + }, + "parameters": [ + { "$ref": "#/components/parameters/client-id" }, + { + "name": "fingerprint", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "client_secret": { + "description": "The OAuth app client secret for which to create the token.", + "maxLength": 40, + "type": "string" + }, + "scopes": { + "description": "A list of scopes that this authorization is in.", + "type": "array", + "items": { "type": "string" }, + "example": ["public_repo", "user"], + "nullable": true + }, + "note": { + "description": "A note to remind you what the OAuth token is for.", + "type": "string", + "example": "Update all gems" + }, + "note_url": { + "description": "A URL to remind you what app the OAuth token is for.", + "type": "string" + } + }, + "required": ["client_secret"], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Response if returning an existing token", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/authorization" }, + "examples": { + "response-if-returning-an-existing-token": { + "$ref": "#/components/examples/authorization-response-if-returning-an-existing-token" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/authorizations/1", + "schema": { "type": "string" } + } + } + }, + "201": { + "description": "Response if returning a new token", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/authorization" }, + "examples": { + "default": { "$ref": "#/components/examples/authorization-3" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/authorizations/1", + "schema": { "type": "string" } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2020-11-13", + "deprecationDate": "2020-02-14", + "category": "oauth-authorizations", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/authorizations/{authorization_id}": { + "get": { + "summary": "Get a single authorization", + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).", + "tags": ["oauth-authorizations"], + "operationId": "oauth-authorizations/get-authorization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/oauth-authorizations#get-a-single-authorization" + }, + "parameters": [{ "$ref": "#/components/parameters/authorization_id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/authorization" }, + "examples": { + "default": { "$ref": "#/components/examples/authorization-2" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2020-11-13", + "deprecationDate": "2020-02-14", + "category": "oauth-authorizations", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + }, + "patch": { + "summary": "Update an existing authorization", + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.", + "tags": ["oauth-authorizations"], + "operationId": "oauth-authorizations/update-authorization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/oauth-authorizations#update-an-existing-authorization" + }, + "parameters": [{ "$ref": "#/components/parameters/authorization_id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "scopes": { + "description": "A list of scopes that this authorization is in.", + "type": "array", + "items": { "type": "string" }, + "example": ["public_repo", "user"], + "nullable": true + }, + "add_scopes": { + "description": "A list of scopes to add to this authorization.", + "type": "array", + "items": { "type": "string" } + }, + "remove_scopes": { + "description": "A list of scopes to remove from this authorization.", + "type": "array", + "items": { "type": "string" } + }, + "note": { + "description": "A note to remind you what the OAuth token is for.", + "type": "string", + "example": "Update all gems" + }, + "note_url": { + "description": "A URL to remind you what app the OAuth token is for.", + "type": "string" + }, + "fingerprint": { + "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/authorization" }, + "examples": { + "default": { "$ref": "#/components/examples/authorization-2" } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2020-11-13", + "deprecationDate": "2020-02-14", + "category": "oauth-authorizations", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an authorization", + "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).", + "tags": ["oauth-authorizations"], + "operationId": "oauth-authorizations/delete-authorization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/oauth-authorizations#delete-an-authorization" + }, + "parameters": [{ "$ref": "#/components/parameters/authorization_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2020-11-13", + "deprecationDate": "2020-02-14", + "category": "oauth-authorizations", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/codes_of_conduct": { + "get": { + "summary": "Get all codes of conduct", + "description": "", + "tags": ["codes-of-conduct"], + "operationId": "codes-of-conduct/get-all-codes-of-conduct", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/codes_of_conduct/#get-all-codes-of-conduct" + }, + "parameters": [], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/code-of-conduct" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-of-conduct-simple-items" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "scarlet-witch", + "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```" + } + ], + "category": "codes-of-conduct", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/codes_of_conduct/{key}": { + "get": { + "summary": "Get a code of conduct", + "description": "", + "tags": ["codes-of-conduct"], + "operationId": "codes-of-conduct/get-conduct-code", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/codes_of_conduct/#get-a-code-of-conduct" + }, + "parameters": [ + { + "name": "key", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/code-of-conduct" }, + "examples": { + "default": { "$ref": "#/components/examples/code-of-conduct" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "scarlet-witch", + "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```" + } + ], + "category": "codes-of-conduct", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/content_references/{content_reference_id}/attachments": { + "post": { + "summary": "Create a content attachment", + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/create-content-attachment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#create-a-content-attachment" + }, + "parameters": [ + { + "name": "content_reference_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + } + }, + "required": ["title", "body"], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content-reference-attachment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-reference-attachment" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "corsair", + "note": "To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.corsair-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "x-octokit": {} + } + }, + "/emojis": { + "get": { + "summary": "Get emojis", + "description": "Lists all the emojis available to use on GitHub.", + "operationId": "emojis/get", + "tags": ["emojis"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/emojis/#get-emojis" + }, + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { "type": "string" } + } + } + }, + "description": "response" + }, + "304": { "$ref": "#/components/responses/not_modified" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "emojis", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for an enterprise", + "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-github-actions-permissions-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-enterprise-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-enterprise-permissions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set GitHub Actions permissions for an enterprise", + "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-github-actions-permissions-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "responses": { "204": { "description": "Empty response" } }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_organizations": { + "$ref": "#/components/schemas/enabled-organizations" + }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + } + }, + "required": ["enabled_organizations"] + }, + "example": { + "enabled_organizations": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/permissions/organizations": { + "get": { + "summary": "List selected organizations enabled for GitHub Actions in an enterprise", + "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { "type": "number" }, + "organizations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + } + }, + "required": ["total_count", "organizations"] + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-targets" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set selected organizations enabled for GitHub Actions in an enterprise", + "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "responses": { "204": { "description": "Empty response" } }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_organization_ids": { + "description": "List of organization IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + } + } + }, + "required": ["selected_organization_ids"] + }, + "example": { "selected_organization_ids": [32, 91] } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + "put": { + "summary": "Enable a selected organization for GitHub Actions in an enterprise", + "description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/enable-selected-organization-github-actions-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/org_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Disable a selected organization for GitHub Actions in an enterprise", + "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/disable-selected-organization-github-actions-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/org_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for an enterprise", + "description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-allowed-actions-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/selected-actions" }, + "examples": { + "default": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set allowed actions for an enterprise", + "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-allowed-actions-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "responses": { "204": { "description": "Empty response" } }, + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/selected-actions" }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/runner-groups": { + "get": { + "summary": "List self-hosted runner groups for an enterprise", + "description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { "type": "number" }, + "runner_groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-groups-enterprise" + } + } + }, + "required": ["total_count", "runner_groups"] + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-groups-enterprise" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a self-hosted runner group for an enterprise", + "description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected`", + "type": "string", + "enum": ["selected", "all"] + }, + "selected_organization_ids": { + "description": "List of organization IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": ["name"] + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_organization_ids": [32, 91], + "runners": [9, 2] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group-enterprise" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + "get": { + "summary": "Get a self-hosted runner group for an enterprise", + "description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_group_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group-enterprise" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a self-hosted runner group for an enterprise", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_group_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected`", + "type": "string", + "enum": ["selected", "all"], + "default": "all" + } + } + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group-update-enterprise" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a self-hosted runner group from an enterprise", + "description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_group_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + "get": { + "summary": "List organization access to a self-hosted runner group in an enterprise", + "description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_group_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { "type": "number" }, + "organizations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + } + }, + "required": ["total_count", "organizations"] + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-targets" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set organization access for a self-hosted runner group in an enterprise", + "description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_group_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_organization_ids": { + "description": "List of organization IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + } + } + }, + "required": ["selected_organization_ids"] + }, + "example": { "selected_organization_ids": [32, 91] } + } + } + }, + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + "put": { + "summary": "Add organization access to a self-hosted runner group in an enterprise", + "description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_group_id" }, + { "$ref": "#/components/parameters/org_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove organization access to a self-hosted runner group in an enterprise", + "description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_group_id" }, + { "$ref": "#/components/parameters/org_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + "get": { + "summary": "List self-hosted runners in a group for an enterprise", + "description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_group_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { "type": "number" }, + "runners": { + "type": "array", + "items": { "$ref": "#/components/schemas/runner" } + } + }, + "required": ["total_count", "runners"] + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set self-hosted runners in a group for an enterprise", + "description": "Replaces the list of self-hosted runners that that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_group_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": ["runners"] + }, + "example": { "runners": [9, 2] } + } + } + }, + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + "put": { + "summary": "Add a self-hosted runner to a group for an enterprise", + "description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.", + "operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#add-a-self-hosted-runner-to-a-group-for-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_group_id" }, + { "$ref": "#/components/parameters/runner_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a self-hosted runner from a group for an enterprise", + "description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_group_id" }, + { "$ref": "#/components/parameters/runner_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/runners": { + "get": { + "summary": "List self-hosted runners for an enterprise", + "description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { "type": "number" }, + "runners": { + "type": "array", + "items": { "$ref": "#/components/schemas/runner" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/runners/downloads": { + "get": { + "summary": "List runner applications for an enterprise", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-runner-applications-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#list-runner-applications-for-an-enterprise" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/runner-application" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-application-items" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/runners/registration-token": { + "post": { + "summary": "Create a registration token for an enterprise", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```", + "operationId": "enterprise-admin/create-registration-token-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#create-a-registration-token-for-an-enterprise" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authentication-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authentication-token" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/runners/remove-token": { + "post": { + "summary": "Create a remove token for an enterprise", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", + "operationId": "enterprise-admin/create-remove-token-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#create-a-remove-token-for-an-enterprise" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authentication-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authentication-token-2" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for an enterprise", + "description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/runner" }, + "examples": { + "default": { "$ref": "#/components/examples/runner" } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a self-hosted runner from an enterprise", + "description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/runner_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/audit-log": { + "get": { + "summary": "Get the audit log for an enterprise", + "description": "**Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.\n\nGets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope.", + "operationId": "audit-log/get-audit-log", + "tags": ["audit-log"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#get-the-audit-log-for-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/audit-log-phrase" }, + { "$ref": "#/components/parameters/audit-log-include" }, + { "$ref": "#/components/parameters/audit-log-after" }, + { "$ref": "#/components/parameters/audit-log-before" }, + { "$ref": "#/components/parameters/per_page" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/audit-log-event" } + }, + "examples": { + "default": { "$ref": "#/components/examples/audit-log" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "audit-log" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/settings/billing/actions": { + "get": { + "summary": "Get GitHub Actions billing for an enterprise", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nThe authenticated user must be an enterprise admin.", + "operationId": "billing/get-github-actions-billing-ghe", + "tags": ["billing"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/billing/#get-github-actions-billing-for-an-enterprise" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-billing-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-billing-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "billing" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/settings/billing/packages": { + "get": { + "summary": "Get GitHub Packages billing for an enterprise", + "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nThe authenticated user must be an enterprise admin.", + "operationId": "billing/get-github-packages-billing-ghe", + "tags": ["billing"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/billing/#get-github-packages-billing-for-an-enterprise" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/packages-billing-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/packages-billing-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "billing" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/settings/billing/shared-storage": { + "get": { + "summary": "Get shared storage billing for an enterprise", + "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nThe authenticated user must be an enterprise admin.", + "operationId": "billing/get-shared-storage-billing-ghe", + "tags": ["billing"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/billing/#get-shared-storage-billing-for-an-enterprise" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/combined-billing-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/combined-billing-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "billing" + }, + "x-octokit": {} + } + }, + "/events": { + "get": { + "summary": "List public events", + "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "tags": ["activity"], + "operationId": "activity/list-public-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-public-events" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/event" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/feeds": { + "get": { + "summary": "Get feeds", + "description": "GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "tags": ["activity"], + "operationId": "activity/get-feeds", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#get-feeds" + }, + "parameters": [], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/feed" }, + "examples": { + "default": { "$ref": "#/components/examples/feed" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "feeds" + }, + "x-octokit": {} + } + }, + "/gists": { + "get": { + "summary": "List gists for the authenticated user", + "description": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:", + "tags": ["gists"], + "operationId": "gists/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#list-gists-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/base-gist" } + }, + "examples": { + "default": { "$ref": "#/components/examples/base-gist-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a gist", + "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", + "operationId": "gists/create", + "tags": ["gists"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#create-a-gist" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "Description of the gist", + "example": "Example Ruby script", + "type": "string" + }, + "files": { + "description": "Names and content for the files that make up the gist", + "example": { + "hello.rb": { "content": "puts \"Hello, World!\"" } + }, + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "content": { + "description": "Content of the file", + "readOnly": false, + "type": "string" + } + }, + "required": ["content"] + } + }, + "public": { + "oneOf": [ + { + "description": "Flag indicating whether the gist is public", + "example": true, + "type": "boolean", + "default": false + }, + { + "type": "string", + "example": "true", + "default": "false", + "enum": ["true", "false"] + } + ] + } + }, + "required": ["files"], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gist-full" }, + "examples": { + "default": { "$ref": "#/components/examples/gist" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "schema": { "type": "string" } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/gists/public": { + "get": { + "summary": "List public gists", + "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", + "tags": ["gists"], + "operationId": "gists/list-public", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#list-public-gists" + }, + "parameters": [ + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/base-gist" } + }, + "examples": { + "default": { "$ref": "#/components/examples/base-gist-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/gists/starred": { + "get": { + "summary": "List starred gists", + "description": "List the authenticated user's starred gists:", + "tags": ["gists"], + "operationId": "gists/list-starred", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#list-starred-gists" + }, + "parameters": [ + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/base-gist" } + }, + "examples": { + "default": { "$ref": "#/components/examples/base-gist-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/gists/{gist_id}": { + "get": { + "summary": "Get a gist", + "description": "", + "tags": ["gists"], + "operationId": "gists/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#get-a-gist" + }, + "parameters": [{ "$ref": "#/components/parameters/gist_id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gist-full" }, + "examples": { + "default": { "$ref": "#/components/examples/gist" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden_gist" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a gist", + "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", + "tags": ["gists"], + "operationId": "gists/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#update-a-gist" + }, + "parameters": [{ "$ref": "#/components/parameters/gist_id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "Description of the gist", + "example": "Example Ruby script", + "type": "string" + }, + "files": { + "description": "Names of files to be updated", + "example": { + "hello.rb": { + "content": "blah", + "filename": "goodbye.rb" + } + }, + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "content": { + "description": "The new content of the file", + "type": "string" + }, + "filename": { + "description": "The new filename for the file", + "type": "string", + "nullable": true + } + }, + "additionalProperties": false, + "nullable": true + } + } + }, + "anyOf": [ + { "required": ["description"] }, + { "required": ["files"] } + ], + "type": "object", + "nullable": true + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gist-full" }, + "examples": { + "default": { "$ref": "#/components/examples/gist" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a gist", + "description": "", + "tags": ["gists"], + "operationId": "gists/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#delete-a-gist" + }, + "parameters": [{ "$ref": "#/components/parameters/gist_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/gists/{gist_id}/comments": { + "get": { + "summary": "List gist comments", + "description": "", + "tags": ["gists"], + "operationId": "gists/list-comments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/gists#list-gist-comments" + }, + "parameters": [ + { "$ref": "#/components/parameters/gist_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/gist-comment" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/gist-comment-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": "comments" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a gist comment", + "description": "", + "tags": ["gists"], + "operationId": "gists/create-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/gists#create-a-gist-comment" + }, + "parameters": [{ "$ref": "#/components/parameters/gist_id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "body": { + "description": "The comment text.", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment" + } + }, + "type": "object", + "required": ["body"] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gist-comment" }, + "examples": { + "default": { "$ref": "#/components/examples/gist-comment" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", + "schema": { "type": "string" } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": "comments" + }, + "x-octokit": {} + } + }, + "/gists/{gist_id}/comments/{comment_id}": { + "get": { + "summary": "Get a gist comment", + "description": "", + "tags": ["gists"], + "operationId": "gists/get-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/gists#get-a-gist-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/gist_id" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gist-comment" }, + "examples": { + "default": { "$ref": "#/components/examples/gist-comment" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden_gist" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": "comments" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a gist comment", + "description": "", + "tags": ["gists"], + "operationId": "gists/update-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/gists#update-a-gist-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/gist_id" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "body": { + "description": "The comment text.", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment" + } + }, + "type": "object", + "required": ["body"] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gist-comment" }, + "examples": { + "default": { "$ref": "#/components/examples/gist-comment" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": "comments" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a gist comment", + "description": "", + "tags": ["gists"], + "operationId": "gists/delete-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/gists#delete-a-gist-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/gist_id" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": "comments" + }, + "x-octokit": {} + } + }, + "/gists/{gist_id}/commits": { + "get": { + "summary": "List gist commits", + "description": "", + "tags": ["gists"], + "operationId": "gists/list-commits", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#list-gist-commits" + }, + "parameters": [ + { "$ref": "#/components/parameters/gist_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/gist-commit" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/gist-commit-items" + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { "type": "string" } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/gists/{gist_id}/forks": { + "get": { + "summary": "List gist forks", + "description": "", + "tags": ["gists"], + "operationId": "gists/list-forks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#list-gist-forks" + }, + "parameters": [ + { "$ref": "#/components/parameters/gist_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/gist-full" } + }, + "examples": { + "default": { "$ref": "#/components/examples/gist-fork-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Fork a gist", + "description": "**Note**: This was previously `/gists/:gist_id/fork`.", + "tags": ["gists"], + "operationId": "gists/fork", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#fork-a-gist" + }, + "parameters": [{ "$ref": "#/components/parameters/gist_id" }], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/base-gist" }, + "examples": { + "default": { "$ref": "#/components/examples/base-gist" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "schema": { "type": "string" } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/gists/{gist_id}/star": { + "get": { + "summary": "Check if a gist is starred", + "description": "", + "tags": ["gists"], + "operationId": "gists/check-is-starred", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#check-if-a-gist-is-starred" + }, + "parameters": [{ "$ref": "#/components/parameters/gist_id" }], + "responses": { + "204": { "description": "Response if gist is starred" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { + "description": "Response if gist is not starred", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + }, + "put": { + "summary": "Star a gist", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "tags": ["gists"], + "operationId": "gists/star", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#star-a-gist" + }, + "parameters": [{ "$ref": "#/components/parameters/gist_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Unstar a gist", + "description": "", + "tags": ["gists"], + "operationId": "gists/unstar", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#unstar-a-gist" + }, + "parameters": [{ "$ref": "#/components/parameters/gist_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/gists/{gist_id}/{sha}": { + "get": { + "summary": "Get a gist revision", + "description": "", + "tags": ["gists"], + "operationId": "gists/get-revision", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#get-a-gist-revision" + }, + "parameters": [ + { "$ref": "#/components/parameters/gist_id" }, + { + "name": "sha", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gist-full" }, + "examples": { + "default": { "$ref": "#/components/examples/gist" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/gitignore/templates": { + "get": { + "summary": "Get all gitignore templates", + "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user).", + "operationId": "gitignore/get-all-templates", + "tags": ["gitignore"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gitignore/#get-all-gitignore-templates" + }, + "parameters": [], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "type": "array", "items": { "type": "string" } }, + "example": [ + "Actionscript", + "Android", + "AppceleratorTitanium", + "Autotools", + "Bancha", + "C", + "C++" + ] + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "gitignore", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/gitignore/templates/{name}": { + "get": { + "summary": "Get a gitignore template", + "description": "The API also allows fetching the source of a single template.\nUse the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents.", + "operationId": "gitignore/get-template", + "tags": ["gitignore"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gitignore/#get-a-gitignore-template" + }, + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gitignore-template" }, + "examples": { + "default": { + "$ref": "#/components/examples/gitignore-template" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "gitignore", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/installation/repositories": { + "get": { + "summary": "List repositories accessible to the app installation", + "description": "List repositories that an app installation can access.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/list-repos-accessible-to-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-app-installation" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "repositories"], + "properties": { + "total_count": { "type": "integer" }, + "repositories": { + "type": "array", + "items": { "$ref": "#/components/schemas/repository" } + }, + "repository_selection": { + "type": "string", + "example": "selected" + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated-2" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "mercy", + "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "x-octokit": {} + } + }, + "/installation/token": { + "delete": { + "summary": "Revoke an installation access token", + "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)\" endpoint.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/revoke-installation-access-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#revoke-an-installation-access-token" + }, + "parameters": [], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "apps", + "subcategory": "installations" + }, + "x-octokit": {} + } + }, + "/issues": { + "get": { + "summary": "List issues assigned to the authenticated user", + "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", + "tags": ["issues"], + "operationId": "issues/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/issues/#list-issues-assigned-to-the-authenticated-user" + }, + "parameters": [ + { + "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "default": "assigned" + } + }, + { + "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": ["open", "closed", "all"], + "default": "open" + } + }, + { "$ref": "#/components/parameters/labels" }, + { + "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["created", "updated", "comments"], + "default": "created" + } + }, + { "$ref": "#/components/parameters/direction" }, + { "$ref": "#/components/parameters/since" }, + { + "name": "collab", + "in": "query", + "required": false, + "schema": { "type": "boolean" } + }, + { + "name": "orgs", + "in": "query", + "required": false, + "schema": { "type": "boolean" } + }, + { + "name": "owned", + "in": "query", + "required": false, + "schema": { "type": "boolean" } + }, + { + "name": "pulls", + "in": "query", + "required": false, + "schema": { "type": "boolean" } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/issue" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-with-repo-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "issues", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/licenses": { + "get": { + "summary": "Get all commonly used licenses", + "description": "", + "tags": ["licenses"], + "operationId": "licenses/get-all-commonly-used", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/licenses/#get-all-commonly-used-licenses" + }, + "parameters": [ + { + "name": "featured", + "in": "query", + "required": false, + "schema": { "type": "boolean" } + }, + { "$ref": "#/components/parameters/per_page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/license-simple" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/license-simple-items" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "licenses", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/licenses/{license}": { + "get": { + "summary": "Get a license", + "description": "", + "tags": ["licenses"], + "operationId": "licenses/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/licenses/#get-a-license" + }, + "parameters": [ + { + "name": "license", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/license" }, + "examples": { + "default": { "$ref": "#/components/examples/license" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "licenses", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/markdown": { + "post": { + "summary": "Render a Markdown document", + "description": "", + "operationId": "markdown/render", + "tags": ["markdown"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/markdown/#render-a-markdown-document" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "text": { + "description": "The Markdown text to render in HTML.", + "type": "string" + }, + "mode": { + "description": "The rendering mode.", + "enum": ["markdown", "gfm"], + "default": "markdown", + "example": "markdown", + "type": "string" + }, + "context": { + "description": "The repository context to use when creating references in `gfm` mode.", + "type": "string" + } + }, + "required": ["text"], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "headers": { + "Content-Type": { "$ref": "#/components/headers/content-type" }, + "Content-Length": { + "example": "279", + "schema": { "type": "string" } + }, + "X-CommonMarker-Version": { + "$ref": "#/components/headers/x-common-marker-version" + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "markdown", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/markdown/raw": { + "post": { + "summary": "Render a Markdown document in raw mode", + "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.", + "operationId": "markdown/render-raw", + "tags": ["markdown"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode" + }, + "parameters": [], + "requestBody": { + "content": { + "text/plain": { "schema": { "type": "string" } }, + "text/x-markdown": { "schema": { "type": "string" } } + } + }, + "responses": { + "200": { + "description": "response", + "headers": { + "X-CommonMarker-Version": { + "$ref": "#/components/headers/x-common-marker-version" + } + }, + "content": { "text/html": { "schema": { "type": "string" } } } + }, + "304": { "$ref": "#/components/responses/not_modified" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "markdown", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/marketplace_listing/accounts/{account_id}": { + "get": { + "summary": "Get a subscription plan for an account", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/get-subscription-plan-for-account", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account" + }, + "parameters": [{ "$ref": "#/components/parameters/account_id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketplace-purchase" + }, + "examples": { + "default": { + "$ref": "#/components/examples/marketplace-purchase" + } + } + } + } + }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "404": { + "description": "Response when the account has not purchased the listing", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "marketplace" + }, + "x-octokit": {} + } + }, + "/marketplace_listing/plans": { + "get": { + "summary": "List plans", + "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/list-plans", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#list-plans" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/marketplace-listing-plan-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "marketplace" + }, + "x-octokit": {} + } + }, + "/marketplace_listing/plans/{plan_id}/accounts": { + "get": { + "summary": "List accounts for a plan", + "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/list-accounts-for-plan", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan" + }, + "parameters": [ + { "$ref": "#/components/parameters/plan_id" }, + { "$ref": "#/components/parameters/sort" }, + { + "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"] } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/marketplace-purchase" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/marketplace-purchase-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "marketplace" + }, + "x-octokit": {} + } + }, + "/marketplace_listing/stubbed/accounts/{account_id}": { + "get": { + "summary": "Get a subscription plan for an account (stubbed)", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/get-subscription-plan-for-account-stubbed", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account-stubbed" + }, + "parameters": [{ "$ref": "#/components/parameters/account_id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketplace-purchase" + }, + "examples": { + "default": { + "$ref": "#/components/examples/marketplace-purchase" + } + } + } + } + }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "404": { + "description": "Response when the account has not purchased the listing" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "marketplace" + }, + "x-octokit": {} + } + }, + "/marketplace_listing/stubbed/plans": { + "get": { + "summary": "List plans (stubbed)", + "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/list-plans-stubbed", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#list-plans-stubbed" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/marketplace-listing-plan-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "401": { "$ref": "#/components/responses/requires_authentication" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "marketplace" + }, + "x-octokit": {} + } + }, + "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + "get": { + "summary": "List accounts for a plan (stubbed)", + "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/list-accounts-for-plan-stubbed", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan-stubbed" + }, + "parameters": [ + { "$ref": "#/components/parameters/plan_id" }, + { "$ref": "#/components/parameters/sort" }, + { + "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"] } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/marketplace-purchase" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/marketplace-purchase-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "401": { "$ref": "#/components/responses/requires_authentication" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "marketplace" + }, + "x-octokit": {} + } + }, + "/meta": { + "get": { + "summary": "Get GitHub meta information", + "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/).\"\n\n**Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.", + "tags": ["meta"], + "operationId": "meta/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/meta/#get-github-meta-information" + }, + "parameters": [], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/api-overview" }, + "examples": { + "default": { "$ref": "#/components/examples/api-overview" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "meta", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/networks/{owner}/{repo}/events": { + "get": { + "summary": "List public events for a network of repositories", + "description": "", + "tags": ["activity"], + "operationId": "activity/list-public-events-for-repo-network", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/event" } + } + } + } + }, + "301": { "$ref": "#/components/responses/moved_permanently" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/notifications": { + "get": { + "summary": "List notifications for the authenticated user", + "description": "List all notifications for the current user, sorted by most recently updated.", + "tags": ["activity"], + "operationId": "activity/list-notifications-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/all" }, + { "$ref": "#/components/parameters/participating" }, + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/before" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/thread" } + }, + "examples": { + "default": { "$ref": "#/components/examples/thread-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "x-octokit": {} + }, + "put": { + "summary": "Mark notifications as read", + "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "tags": ["activity"], + "operationId": "activity/mark-notifications-as-read", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#mark-notifications-as-read" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "last_read_at": { + "description": "Describes the last point that notifications were checked.", + "type": "string", + "format": "date-time" + }, + "read": { + "description": "Whether the notification has been read.", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { "message": { "type": "string" } } + } + } + } + }, + "205": { "description": "response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "x-octokit": {} + } + }, + "/notifications/threads/{thread_id}": { + "get": { + "summary": "Get a thread", + "description": "", + "tags": ["activity"], + "operationId": "activity/get-thread", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#get-a-thread" + }, + "parameters": [{ "$ref": "#/components/parameters/thread_id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/thread" }, + "examples": { + "default": { "$ref": "#/components/examples/thread" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Mark a thread as read", + "description": "", + "tags": ["activity"], + "operationId": "activity/mark-thread-as-read", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#mark-a-thread-as-read" + }, + "parameters": [{ "$ref": "#/components/parameters/thread_id" }], + "responses": { + "205": { "description": "response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "x-octokit": {} + } + }, + "/notifications/threads/{thread_id}/subscription": { + "get": { + "summary": "Get a thread subscription for the authenticated user", + "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", + "tags": ["activity"], + "operationId": "activity/get-thread-subscription-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user" + }, + "parameters": [{ "$ref": "#/components/parameters/thread_id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/thread-subscription" + }, + "examples": { + "default": { + "$ref": "#/components/examples/thread-subscription" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set a thread subscription", + "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint.", + "tags": ["activity"], + "operationId": "activity/set-thread-subscription", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#set-a-thread-subscription" + }, + "parameters": [{ "$ref": "#/components/parameters/thread_id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "ignored": { + "description": "Whether to block all notifications from a thread.", + "default": false, + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/thread-subscription" + }, + "examples": { + "default": { + "$ref": "#/components/examples/thread-subscription" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a thread subscription", + "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.", + "tags": ["activity"], + "operationId": "activity/delete-thread-subscription", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#delete-a-thread-subscription" + }, + "parameters": [{ "$ref": "#/components/parameters/thread_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "x-octokit": {} + } + }, + "/octocat": { + "get": { + "summary": "Get Octocat", + "description": "Get the octocat as ASCII art", + "tags": ["meta"], + "operationId": "meta/get-octocat", + "parameters": [ + { + "name": "s", + "in": "query", + "description": "The words to show in Octocat's speech bubble", + "schema": { "type": "string" }, + "required": false + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/octocat-stream": { "schema": { "type": "string" } } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "meta" + }, + "x-octokit": {} + } + }, + "/organizations": { + "get": { + "summary": "List organizations", + "description": "Lists all organizations, in the order that they were created on GitHub.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations.", + "tags": ["orgs"], + "operationId": "orgs/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/orgs/#list-organizations" + }, + "parameters": [ + { "$ref": "#/components/parameters/since-org" }, + { "$ref": "#/components/parameters/per_page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { "type": "string" } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}": { + "get": { + "summary": "Get an organization", + "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub plan information' below.\"", + "tags": ["orgs"], + "operationId": "orgs/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/orgs/#get-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/organization-full" }, + "examples": { + "default-response": { + "$ref": "#/components/examples/organization-full-default-response" + }, + "response-with-git-hub-plan-information": { + "$ref": "#/components/examples/organization-full-response-with-git-hub-plan-information" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "surtur", + "note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```" + } + ], + "category": "orgs", + "subcategory": null + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an organization", + "description": "**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", + "tags": ["orgs"], + "operationId": "orgs/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/orgs/#update-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "billing_email": { + "type": "string", + "description": "Billing email address. This address is not publicized." + }, + "company": { + "type": "string", + "description": "The company name." + }, + "email": { + "type": "string", + "description": "The publicly visible email address." + }, + "twitter_username": { + "type": "string", + "description": "The Twitter username of the company." + }, + "location": { + "type": "string", + "description": "The location." + }, + "name": { + "type": "string", + "description": "The shorthand name of the company." + }, + "description": { + "type": "string", + "description": "The description of the company." + }, + "has_organization_projects": { + "type": "boolean", + "description": "Toggles whether an organization can use organization projects." + }, + "has_repository_projects": { + "type": "boolean", + "description": "Toggles whether repositories that belong to the organization can use repository projects." + }, + "default_repository_permission": { + "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", "admin", "none"], + "default": "read" + }, + "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 organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", + "default": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "description": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_can_create_private_repositories": { + "type": "boolean", + "description": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_can_create_public_repositories": { + "type": "boolean", + "description": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_allowed_repository_creation_type": { + "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 Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "enum": ["all", "private", "none"] + }, + "members_can_create_pages": { + "type": "boolean", + "description": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. \nDefault: `true`. " + }, + "blog": { + "type": "string", + "example": "\"http://github.blog\"" + } + } + }, + "example": { + "billing_email": "mona@github.com", + "company": "GitHub", + "email": "mona@github.com", + "twitter_username": "github", + "location": "San Francisco", + "name": "github", + "description": "GitHub, the company.", + "default_repository_permission": "read", + "members_can_create_repositories": true, + "members_allowed_repository_creation_type": "all" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/organization-full" }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-full" + } + } + } + } + }, + "409": { "$ref": "#/components/responses/conflict" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { "$ref": "#/components/schemas/validation-error" }, + { "$ref": "#/components/schemas/validation-error-simple" } + ] + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "surtur", + "note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```" + } + ], + "category": "orgs", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for an organization", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-github-actions-permissions-organization", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-organization-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-organization-permissions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set GitHub Actions permissions for an organization", + "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-github-actions-permissions-organization", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { "204": { "description": "Empty response" } }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "$ref": "#/components/schemas/enabled-repositories" + }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + } + }, + "required": ["enabled_repositories"] + }, + "example": { + "enabled_repositories": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/permissions/repositories": { + "get": { + "summary": "List selected repositories enabled for GitHub Actions in an organization", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "repositories"], + "properties": { + "total_count": { "type": "number" }, + "repositories": { + "type": "array", + "items": { "$ref": "#/components/schemas/repository" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set selected repositories enabled for GitHub Actions in an organization", + "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { "204": { "description": "Empty response" } }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": ["selected_repository_ids"] + }, + "example": { "selected_repository_ids": [32, 42] } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "put": { + "summary": "Enable a selected repository for GitHub Actions in an organization", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/enable-selected-repository-github-actions-organization", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/repository_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Disable a selected repository for GitHub Actions in an organization", + "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/disable-selected-repository-github-actions-organization", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/repository_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for an organization", + "description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-allowed-actions-organization", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/selected-actions" }, + "examples": { + "default": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set allowed actions for an organization", + "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-allowed-actions-organization", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { "204": { "description": "Empty response" } }, + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/selected-actions" }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runner-groups": { + "get": { + "summary": "List self-hosted runner groups for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nLists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runner-groups-for-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-self-hosted-runner-groups-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "runner_groups"], + "properties": { + "total_count": { "type": "number" }, + "runner_groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-groups-org" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-groups-org" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nCreates a new self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/create-self-hosted-runner-group-for-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#create-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`.", + "type": "string", + "enum": ["selected", "all", "private"], + "default": "all" + }, + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": ["name"] + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [32, 91], + "runners": [9, 2] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/runner-groups-org" }, + "examples": { + "default": { "$ref": "#/components/examples/runner-group" } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "get": { + "summary": "Get a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nGets a specific self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-self-hosted-runner-group-for-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_group_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/runner-groups-org" }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group-item" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nUpdates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/update-self-hosted-runner-group-for-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_group_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`.", + "type": "string", + "enum": ["selected", "all", "private"] + } + } + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/runner-groups-org" }, + "examples": { + "default": { "$ref": "#/components/examples/runner-group" } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a self-hosted runner group from an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nDeletes a self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/delete-self-hosted-runner-group-from-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-group-from-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_group_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + "get": { + "summary": "List repository access to a self-hosted runner group in an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nLists the repositories with access to a self-hosted runner group configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_group_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "repositories"], + "properties": { + "total_count": { "type": "number" }, + "repositories": { + "type": "array", + "items": { "$ref": "#/components/schemas/repository" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set repository access for a self-hosted runner group in an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nReplaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#set-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_group_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": ["selected_repository_ids"] + }, + "example": { "selected_repository_ids": [32, 91] } + } + } + }, + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + "put": { + "summary": "Add repository access to a self-hosted runner group in an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\n\nAdds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org`\nscope to use this endpoint.", + "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#add-repository-acess-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_group_id" }, + { "$ref": "#/components/parameters/repository_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove repository access to a self-hosted runner group in an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\n\nRemoves a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_group_id" }, + { "$ref": "#/components/parameters/repository_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "get": { + "summary": "List self-hosted runners in a group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nLists self-hosted runners that are in a specific organization group.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runners-in-group-for-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_group_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "runners"], + "properties": { + "total_count": { "type": "number" }, + "runners": { + "type": "array", + "items": { "$ref": "#/components/schemas/runner" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set self-hosted runners in a group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nReplaces the list of self-hosted runners that are part of an organization runner group.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-in-group-for-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_group_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": ["runners"] + }, + "example": { "runners": [9, 2] } + } + } + }, + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + "put": { + "summary": "Add a self-hosted runner to a group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\n\nAdds a self-hosted runner to a runner group configured in an organization.\n\nYou must authenticate using an access token with the `admin:org`\nscope to use this endpoint.", + "operationId": "actions/add-self-hosted-runner-to-group-for-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#add-a-self-hosted-runner-to-a-group-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_group_id" }, + { "$ref": "#/components/parameters/runner_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a self-hosted runner from a group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\n\nRemoves a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-self-hosted-runner-from-group-for-org", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_group_id" }, + { "$ref": "#/components/parameters/runner_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runners": { + "get": { + "summary": "List self-hosted runners for an organization", + "description": "Lists all self-hosted runners configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/list-self-hosted-runners-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "runners"], + "properties": { + "total_count": { "type": "integer" }, + "runners": { + "type": "array", + "items": { "$ref": "#/components/schemas/runner" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runners/downloads": { + "get": { + "summary": "List runner applications for an organization", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/list-runner-applications-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/runner-application" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-application-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runners/registration-token": { + "post": { + "summary": "Create a registration token for an organization", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```", + "tags": ["actions"], + "operationId": "actions/create-registration-token-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#create-a-registration-token-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authentication-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authentication-token" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runners/remove-token": { + "post": { + "summary": "Create a remove token for an organization", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", + "tags": ["actions"], + "operationId": "actions/create-remove-token-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#create-a-remove-token-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authentication-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authentication-token-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for an organization", + "description": "Gets a specific self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/get-self-hosted-runner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/runner" }, + "examples": { + "default": { "$ref": "#/components/examples/runner" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a self-hosted runner from an organization", + "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/delete-self-hosted-runner-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/runner_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/secrets": { + "get": { + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/list-org-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-organization-secrets" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "secrets"], + "properties": { + "total_count": { "type": "integer" }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-actions-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-actions-secret-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-an-organization-public-key" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/actions-public-key" }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-an-organization-secret" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/secret_name" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-actions-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-actions-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "tags": ["actions"], + "operationId": "actions/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/secret_name" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint." + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Configures the access that repositories have to the organization secret. Can be one of: \n\\- `all` - All repositories in an organization can access the secret. \n\\- `private` - Private repositories in an organization can access the secret. \n\\- `selected` - Only specific repositories can access the secret.", + "enum": ["all", "private", "selected"] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { "type": "string" } + } + } + }, + "example": { + "encrypted_value": "****************************************************************************************", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": ["1296269", "1296280"] + } + } + } + }, + "responses": { + "201": { "description": "Response when creating a secret" }, + "204": { "description": "Response when updating a secret" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#delete-an-organization-secret" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/secret_name" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + "get": { + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/secret_name" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "repositories"], + "properties": { + "total_count": { "type": "integer" }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/public-repository-paginated" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/secret_name" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { "type": "integer" } + } + } + }, + "example": { "selected_repository_ids": [64780797] } + } + } + }, + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#add-selected-repository-to-an-organization-secret" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/secret_name" }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response when repository was added to the selected list" + }, + "409": { + "description": "Response when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/secret_name" }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "409": { + "description": "Response when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/audit-log": { + "get": { + "summary": "Get the audit log for an organization", + "description": "**Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub.\n\nGets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nTo use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint.", + "operationId": "orgs/get-audit-log", + "tags": ["orgs"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#get-the-audit-log-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/audit-log-phrase" }, + { "$ref": "#/components/parameters/audit-log-include" }, + { "$ref": "#/components/parameters/audit-log-after" }, + { "$ref": "#/components/parameters/audit-log-before" }, + { "$ref": "#/components/parameters/per_page" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/audit-log-event" } + }, + "examples": { + "default": { "$ref": "#/components/examples/audit-log" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/blocks": { + "get": { + "summary": "List users blocked by an organization", + "description": "List the users blocked by an organization.", + "tags": ["orgs"], + "operationId": "orgs/list-blocked-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-users-blocked-by-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "blocking" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/blocks/{username}": { + "get": { + "summary": "Check if a user is blocked by an organization", + "description": "", + "tags": ["orgs"], + "operationId": "orgs/check-blocked-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "If the user is blocked:" }, + "404": { + "description": "If the user is not blocked:", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "blocking" + }, + "x-octokit": {} + }, + "put": { + "summary": "Block a user from an organization", + "description": "", + "tags": ["orgs"], + "operationId": "orgs/block-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#block-a-user-from-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Empty response" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "blocking" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Unblock a user from an organization", + "description": "", + "tags": ["orgs"], + "operationId": "orgs/unblock-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#unblock-a-user-from-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "blocking" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/credential-authorizations": { + "get": { + "summary": "List SAML SSO authorizations for an organization", + "description": "Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products).\n\nAn authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://help.github.com/en/articles/about-authentication-with-saml-single-sign-on).", + "tags": ["orgs"], + "operationId": "orgs/list-saml-sso-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/orgs/#list-saml-sso-authorizations-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/credential-authorization" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/credential-authorization-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/credential-authorizations/{credential_id}": { + "delete": { + "summary": "Remove a SAML SSO authorization for an organization", + "description": "Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products).\n\nAn authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access.", + "tags": ["orgs"], + "operationId": "orgs/remove-saml-sso-authorization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/orgs/#remove-a-saml-sso-authorization-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { + "name": "credential_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/events": { + "get": { + "summary": "List public organization events", + "description": "", + "tags": ["activity"], + "operationId": "activity/list-public-org-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-public-organization-events" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/event" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/hooks": { + "get": { + "summary": "List organization webhooks", + "description": "", + "tags": ["orgs"], + "operationId": "orgs/list-webhooks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-organization-webhooks" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/org-hook" } + }, + "examples": { + "default": { "$ref": "#/components/examples/org-hook-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an organization webhook", + "description": "Here's how you can create a hook that posts payloads in JSON format:", + "tags": ["orgs"], + "operationId": "orgs/create-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#create-an-organization-webhook" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Must be passed as \"web\"." + }, + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params).", + "properties": { + "url": { + "$ref": "#/components/schemas/webhook-config-url" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + }, + "username": { + "type": "string", + "example": "\"kdaigle\"" + }, + "password": { + "type": "string", + "example": "\"password\"" + } + }, + "required": ["url"] + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", + "default": ["push"], + "items": { "type": "string" } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + } + }, + "required": ["name", "config"] + }, + "example": { + "name": "web", + "active": true, + "events": ["push", "pull_request"], + "config": { + "url": "http://example.com/webhook", + "content_type": "json" + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/org-hook" }, + "examples": { + "default": { "$ref": "#/components/examples/org-hook" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/orgs/octocat/hooks/1", + "schema": { "type": "string" } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/hooks/{hook_id}": { + "get": { + "summary": "Get an organization webhook", + "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization).\"", + "tags": ["orgs"], + "operationId": "orgs/get-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#get-an-organization-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/org-hook" }, + "examples": { + "default": { "$ref": "#/components/examples/org-hook" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an organization webhook", + "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization).\"", + "tags": ["orgs"], + "operationId": "orgs/update-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#update-an-organization-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params).", + "properties": { + "url": { + "$ref": "#/components/schemas/webhook-config-url" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + } + }, + "required": ["url"] + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", + "default": ["push"], + "items": { "type": "string" } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + }, + "name": { "type": "string", "example": "\"web\"" } + } + }, + "example": { "active": true, "events": ["pull_request"] } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/org-hook" }, + "examples": { + "default": { "$ref": "#/components/examples/org-hook-2" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an organization webhook", + "description": "", + "tags": ["orgs"], + "operationId": "orgs/delete-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#delete-an-organization-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/hooks/{hook_id}/config": { + "get": { + "summary": "Get a webhook configuration for an organization", + "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.", + "tags": ["orgs"], + "operationId": "orgs/get-webhook-config-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/orgs#get-a-webhook-configuration-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/webhook-config" }, + "examples": { + "default": { "$ref": "#/components/examples/webhook-config" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a webhook configuration for an organization", + "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.", + "tags": ["orgs"], + "operationId": "orgs/update-webhook-config-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/orgs#update-a-webhook-configuration-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "url": { "$ref": "#/components/schemas/webhook-config-url" }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + } + }, + "example": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } + } + } + } + }, + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/webhook-config" }, + "examples": { + "default": { "$ref": "#/components/examples/webhook-config" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/hooks/{hook_id}/pings": { + "post": { + "summary": "Ping an organization webhook", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", + "tags": ["orgs"], + "operationId": "orgs/ping-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#ping-an-organization-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/installation": { + "get": { + "summary": "Get an organization installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/get-org-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps/#get-an-organization-installation-for-the-authenticated-app" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/installation" }, + "examples": { + "default": { "$ref": "#/components/examples/installation" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/installations": { + "get": { + "summary": "List app installations for an organization", + "description": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.", + "tags": ["orgs"], + "operationId": "orgs/list-app-installations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/orgs/#list-app-installations-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "installations"], + "properties": { + "total_count": { "type": "integer" }, + "installations": { + "type": "array", + "items": { "$ref": "#/components/schemas/installation" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/installation-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/interaction-limits": { + "get": { + "summary": "Get interaction restrictions for an organization", + "description": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.", + "tags": ["interactions"], + "operationId": "interactions/get-restrictions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interaction-limit-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/interaction-limit-response" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "interactions", + "subcategory": "orgs" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set interaction restrictions for an organization", + "description": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.", + "tags": ["interactions"], + "operationId": "interactions/set-restrictions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/interaction-limit" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interaction-limit-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/interaction-limit-response" + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "interactions", + "subcategory": "orgs" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove interaction restrictions for an organization", + "description": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.", + "tags": ["interactions"], + "operationId": "interactions/remove-restrictions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "interactions", + "subcategory": "orgs" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/invitations": { + "get": { + "summary": "List pending organization invitations", + "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", + "tags": ["orgs"], + "operationId": "orgs/list-pending-invitations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-pending-organization-invitations" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-invitation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-invitation-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an organization invitation", + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "tags": ["orgs"], + "operationId": "orgs/create-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#create-an-organization-invitation" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "invitee_id": { + "type": "integer", + "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting." + }, + "email": { + "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": { + "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", "billing_manager"], + "default": "direct_member" + }, + "team_ids": { + "type": "array", + "description": "Specify IDs for the teams you want to invite new members to.", + "items": { "type": "integer" } + } + } + }, + "example": { + "email": "octocat@github.com", + "role": "direct_member", + "team_ids": [12, 26] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-invitation" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-invitation" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/invitations/{invitation_id}/teams": { + "get": { + "summary": "List organization invitation teams", + "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.", + "tags": ["orgs"], + "operationId": "orgs/list-invitation-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-organization-invitation-teams" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/invitation_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team" } + }, + "examples": { + "default": { "$ref": "#/components/examples/team-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/issues": { + "get": { + "summary": "List organization issues assigned to the authenticated user", + "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", + "tags": ["issues"], + "operationId": "issues/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/issues/#list-organization-issues-assigned-to-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { + "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": ["assigned", "created", "mentioned", "subscribed", "all"], + "default": "assigned" + } + }, + { + "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": ["open", "closed", "all"], + "default": "open" + } + }, + { "$ref": "#/components/parameters/labels" }, + { + "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["created", "updated", "comments"], + "default": "created" + } + }, + { "$ref": "#/components/parameters/direction" }, + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/issue" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-with-repo-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "issues", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/members": { + "get": { + "summary": "List organization members", + "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", + "tags": ["orgs"], + "operationId": "orgs/list-members", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-organization-members" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { + "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": ["2fa_disabled", "all"], + "default": "all" + } + }, + { + "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": ["all", "admin", "member"], + "default": "all" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "302": { + "description": "Response if requester is not an organization member", + "headers": { + "Location": { + "example": "https://api.github.com/orgs/github/public_members", + "schema": { "type": "string" } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/members/{username}": { + "get": { + "summary": "Check organization membership for a user", + "description": "Check if a user is, publicly or privately, a member of the organization.", + "tags": ["orgs"], + "operationId": "orgs/check-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#check-organization-membership-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { + "description": "Response if requester is an organization member and user is a member" + }, + "302": { + "description": "Response if requester is not an organization member", + "headers": { + "Location": { + "example": "https://api.github.com/orgs/github/public_members/pezra", + "schema": { "type": "string" } + } + } + }, + "404": { + "description": "Response if requester is an organization member and user is not a member" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove an organization member", + "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.", + "tags": ["orgs"], + "operationId": "orgs/remove-member", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#remove-an-organization-member" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Empty response" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/memberships/{username}": { + "get": { + "summary": "Get organization membership for a user", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "tags": ["orgs"], + "operationId": "orgs/get-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/org-membership" }, + "examples": { + "response-if-user-has-an-active-admin-membership-with-organization": { + "$ref": "#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization" + }, + "response-if-user-has-an-active-membership-with-organization": { + "$ref": "#/components/examples/org-membership-response-if-user-has-an-active-membership-with-organization" + }, + "response-if-user-has-a-pending-membership-with-organization": { + "$ref": "#/components/examples/org-membership-response-if-user-has-a-pending-membership-with-organization" + } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set organization membership for a user", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "tags": ["orgs"], + "operationId": "orgs/set-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#set-organization-membership-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "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"], + "default": "member" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/org-membership" }, + "examples": { + "response-if-user-was-previously-unaffiliated-with-organization": { + "$ref": "#/components/examples/org-membership-response-if-user-was-previously-unaffiliated-with-organization" + }, + "response-if-user-already-had-membership-with-organization": { + "$ref": "#/components/examples/org-membership-response-if-user-already-had-membership-with-organization" + } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove organization membership for a user", + "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", + "tags": ["orgs"], + "operationId": "orgs/remove-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#remove-organization-membership-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Empty response" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/migrations": { + "get": { + "summary": "List organization migrations", + "description": "Lists the most recent migrations.", + "tags": ["migrations"], + "operationId": "migrations/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#list-organization-migrations" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/migration" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/migration-with-short-org-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "wyandotte", + "note": "To access the Migrations API, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.wyandotte-preview+json\n```" + } + ], + "category": "migrations", + "subcategory": "orgs" + }, + "x-octokit": {} + }, + "post": { + "summary": "Start an organization migration", + "description": "Initiates the generation of a migration archive.", + "tags": ["migrations"], + "operationId": "migrations/start-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#start-an-organization-migration" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repositories": { + "type": "array", + "description": "A list of arrays indicating which repositories should be migrated.", + "items": { "type": "string" } + }, + "lock_repositories": { + "type": "boolean", + "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", + "default": false + }, + "exclude_attachments": { + "type": "boolean", + "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", + "default": false + }, + "exclude": { "type": "array", "items": { "type": "string" } } + }, + "required": ["repositories"] + }, + "example": { + "repositories": ["github/Hello-World"], + "lock_repositories": true + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/migration" }, + "examples": { + "default": { + "$ref": "#/components/examples/migration-with-short-org-2" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "migrations", + "subcategory": "orgs" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/migrations/{migration_id}": { + "get": { + "summary": "Get an organization migration status", + "description": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", + "tags": ["migrations"], + "operationId": "migrations/get-status-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#get-an-organization-migration-status" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/migration_id" } + ], + "responses": { + "200": { + "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/migration" }, + "examples": { + "default": { + "$ref": "#/components/examples/migration-with-short-org" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "wyandotte", + "note": "To access the Migrations API, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.wyandotte-preview+json\n```" + } + ], + "category": "migrations", + "subcategory": "orgs" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/migrations/{migration_id}/archive": { + "get": { + "summary": "Download an organization migration archive", + "description": "Fetches the URL to a migration archive.", + "tags": ["migrations"], + "operationId": "migrations/download-archive-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#download-an-organization-migration-archive" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/migration_id" } + ], + "responses": { + "302": { "description": "response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "wyandotte", + "note": "To access the Migrations API, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.wyandotte-preview+json\n```" + } + ], + "category": "migrations", + "subcategory": "orgs" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an organization migration archive", + "description": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.", + "tags": ["migrations"], + "operationId": "migrations/delete-archive-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#delete-an-organization-migration-archive" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/migration_id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "wyandotte", + "note": "To access the Migrations API, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.wyandotte-preview+json\n```" + } + ], + "category": "migrations", + "subcategory": "orgs" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + "delete": { + "summary": "Unlock an organization repository", + "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", + "tags": ["migrations"], + "operationId": "migrations/unlock-repo-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#unlock-an-organization-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/migration_id" }, + { "$ref": "#/components/parameters/repo_name" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "wyandotte", + "note": "To access the Migrations API, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.wyandotte-preview+json\n```" + } + ], + "category": "migrations", + "subcategory": "orgs" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/migrations/{migration_id}/repositories": { + "get": { + "summary": "List repositories in an organization migration", + "description": "List all the repositories for this organization migration.", + "tags": ["migrations"], + "operationId": "migrations/list-repos-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#list-repositories-in-an-organization-migration" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/migration_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/minimal-repository" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "wyandotte", + "note": "To access the Migrations API, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.wyandotte-preview+json\n```" + } + ], + "category": "migrations", + "subcategory": "orgs" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/outside_collaborators": { + "get": { + "summary": "List outside collaborators for an organization", + "description": "List all users who are outside collaborators of an organization.", + "tags": ["orgs"], + "operationId": "orgs/list-outside-collaborators", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-outside-collaborators-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { + "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": ["2fa_disabled", "all"], + "default": "all" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "outside-collaborators" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/outside_collaborators/{username}": { + "put": { + "summary": "Convert an organization member to outside collaborator", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", + "tags": ["orgs"], + "operationId": "orgs/convert-member-to-outside-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "202": { "description": "User is getting converted asynchronously" }, + "204": { "description": "User was converted" }, + "403": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + }, + "examples": { + "response-if-user-is-the-last-owner-of-the-organization": { + "summary": "Response if user is the last owner of the organization", + "value": { + "message": "Cannot convert the last owner to an outside collaborator", + "documentation_url": "https://docs.github.com/rest/reference/orgs#convert-member-to-outside-collaborator" + } + }, + "response-if-user-is-not-a-member-of-the-organization": { + "summary": "Response if user is not a member of the organization", + "value": { + "message": " is not a member of the organization.", + "documentation_url": "https://docs.github.com/rest/reference/orgs#convert-member-to-outside-collaborator" + } + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "outside-collaborators" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove outside collaborator from an organization", + "description": "Removing a user from this list will remove them from all the organization's repositories.", + "tags": ["orgs"], + "operationId": "orgs/remove-outside-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#remove-outside-collaborator-from-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Empty response" }, + "422": { + "description": "Response if user is a member of the organization", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + }, + "examples": { + "response-if-user-is-a-member-of-the-organization": { + "value": { + "message": "You cannot specify an organization member to remove as an outside collaborator.", + "documentation_url": "https://docs.github.com/rest/reference/orgs#remove-outside-collaborator" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "outside-collaborators" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/projects": { + "get": { + "summary": "List organization projects", + "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "tags": ["projects"], + "operationId": "projects/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/projects/#list-organization-projects" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { + "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": ["open", "closed", "all"], + "default": "open" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/project" } + }, + "examples": { + "default": { "$ref": "#/components/examples/project-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an organization project", + "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "tags": ["projects"], + "operationId": "projects/create-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/projects/#create-an-organization-project" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the project." + }, + "body": { + "type": "string", + "description": "The description of the project." + } + }, + "required": ["name"] + }, + "example": { + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year." + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/project" }, + "examples": { + "default": { "$ref": "#/components/examples/project-2" } + } + } + } + }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/public_members": { + "get": { + "summary": "List public organization members", + "description": "Members of an organization can choose to have their membership publicized or not.", + "tags": ["orgs"], + "operationId": "orgs/list-public-members", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-public-organization-members" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/public_members/{username}": { + "get": { + "summary": "Check public organization membership for a user", + "description": "", + "tags": ["orgs"], + "operationId": "orgs/check-public-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#check-public-organization-membership-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Response if user is a public member" }, + "404": { "description": "Response if user is not a public member" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set public organization membership for the authenticated user", + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "tags": ["orgs"], + "operationId": "orgs/set-public-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Empty response" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove public organization membership for the authenticated user", + "description": "", + "tags": ["orgs"], + "operationId": "orgs/remove-public-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/repos": { + "get": { + "summary": "List organization repositories", + "description": "Lists repositories for the specified organization.", + "tags": ["repos"], + "operationId": "repos/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#list-organization-repositories" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { + "name": "type", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "public", + "private", + "forks", + "sources", + "member", + "internal" + ] + } + }, + { + "name": "sort", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["created", "updated", "pushed", "full_name"], + "default": "created" + } + }, + { + "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"] } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/minimal-repository" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + }, + { + "required": false, + "name": "baptiste", + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an organization repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "tags": ["repos"], + "operationId": "repos/create-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#create-an-organization-repository" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository." + }, + "description": { + "type": "string", + "description": "A short description of the repository." + }, + "homepage": { + "type": "string", + "description": "A URL with more information about the repository." + }, + "private": { + "type": "boolean", + "description": "Either `true` to create a private repository or `false` to create a public one.", + "default": false + }, + "visibility": { + "type": "string", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "enum": ["public", "private", "visibility", "internal"] + }, + "has_issues": { + "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "default": true + }, + "has_projects": { + "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": { + "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "default": true + }, + "is_template": { + "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "default": false + }, + "team_id": { + "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": { + "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", + "default": false + }, + "gitignore_template": { + "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": { + "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": { + "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "default": true + }, + "allow_merge_commit": { + "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": { + "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "default": true + }, + "delete_branch_on_merge": { + "type": "boolean", + "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "default": false + } + }, + "required": ["name"] + }, + "example": { + "name": "Hello-World", + "description": "This is your first repository", + "homepage": "https://github.com", + "private": false, + "has_issues": true, + "has_projects": true, + "has_wiki": true + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/repository" }, + "examples": { + "default": { "$ref": "#/components/examples/repository" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World", + "schema": { "type": "string" } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + }, + { + "required": false, + "name": "baptiste", + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/settings/billing/actions": { + "get": { + "summary": "Get GitHub Actions billing for an organization", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.", + "operationId": "billing/get-github-actions-billing-org", + "tags": ["billing"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/billing/#get-github-actions-billing-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-billing-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-billing-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "billing", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/settings/billing/packages": { + "get": { + "summary": "Get GitHub Packages billing for an organization", + "description": "Gets the free and paid storage usued for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.", + "operationId": "billing/get-github-packages-billing-org", + "tags": ["billing"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/billing/#get-github-packages-billing-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/packages-billing-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/packages-billing-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "billing", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/settings/billing/shared-storage": { + "get": { + "summary": "Get shared storage billing for an organization", + "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.", + "operationId": "billing/get-shared-storage-billing-org", + "tags": ["billing"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/billing/#get-shared-storage-billing-for-an-organization" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/combined-billing-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/combined-billing-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "billing", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/team-sync/groups": { + "get": { + "summary": "List IdP groups for an organization", + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nList IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nThe `per_page` parameter provides pagination for a list of IdP groups the authenticated user can access in an organization. For example, if the user `octocat` wants to see two groups per page in `octo-org` via cURL, it would look like this:", + "tags": ["teams"], + "operationId": "teams/list-idp-groups-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#list-idp-groups-for-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/group-mapping" }, + "examples": { + "default": { "$ref": "#/components/examples/group-mapping-3" } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { "type": "string" } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": "team-sync" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams": { + "get": { + "summary": "List teams", + "description": "Lists all teams in an organization that are visible to the authenticated user.", + "tags": ["teams"], + "operationId": "teams/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#list-teams" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team" } + }, + "examples": { + "default": { "$ref": "#/components/examples/team-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a team", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "tags": ["teams"], + "operationId": "teams/create", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#create-a-team" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "maintainers": { + "type": "array", + "description": "List GitHub IDs for organization members who will become team maintainers.", + "items": { "type": "string" } + }, + "repo_names": { + "type": "array", + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", + "items": { "type": "string" } + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", + "enum": ["secret", "closed"] + }, + "permission": { + "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", "admin"], + "default": "pull" + }, + "parent_team_id": { + "type": "integer", + "description": "The ID of a team to set as the parent team." + } + }, + "required": ["name"] + }, + "example": { + "name": "Justice League", + "description": "A great team", + "permission": "admin", + "privacy": "closed" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-full" }, + "examples": { + "default": { "$ref": "#/components/examples/team-full" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}": { + "get": { + "summary": "Get a team by name", + "description": "Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", + "tags": ["teams"], + "operationId": "teams/get-by-name", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#get-a-team-by-name" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-full" }, + "examples": { + "default": { "$ref": "#/components/examples/team-full" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a team", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + "tags": ["teams"], + "operationId": "teams/update-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#update-a-team" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "enum": ["secret", "closed"] + }, + "permission": { + "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", "admin"], + "default": "pull" + }, + "parent_team_id": { + "type": "integer", + "description": "The ID of a team to set as the parent team." + } + }, + "required": ["name"] + }, + "example": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-full" }, + "examples": { + "default": { "$ref": "#/components/examples/team-full" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a team", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", + "tags": ["teams"], + "operationId": "teams/delete-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#delete-a-team" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/discussions": { + "get": { + "summary": "List discussions", + "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.", + "tags": ["teams"], + "operationId": "teams/list-discussions-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#list-discussions" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/direction" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team-discussion" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-discussion-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "teams", + "subcategory": "discussions" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a discussion", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "tags": ["teams"], + "operationId": "teams/create-discussion-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#create-a-discussion" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The discussion post's title." + }, + "body": { + "type": "string", + "description": "The discussion post's body text." + }, + "private": { + "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 + } + }, + "required": ["title", "body"] + }, + "example": { + "title": "Our first team post", + "body": "Hi! This is an area for us to collaborate as a team." + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-discussion" }, + "examples": { + "default": { "$ref": "#/components/examples/team-discussion" } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "teams", + "subcategory": "discussions" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + "get": { + "summary": "Get a discussion", + "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", + "tags": ["teams"], + "operationId": "teams/get-discussion-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#get-a-discussion" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-discussion" }, + "examples": { + "default": { "$ref": "#/components/examples/team-discussion" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "teams", + "subcategory": "discussions" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a discussion", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", + "tags": ["teams"], + "operationId": "teams/update-discussion-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#update-a-discussion" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The discussion post's title." + }, + "body": { + "type": "string", + "description": "The discussion post's body text." + } + } + }, + "example": { "title": "Welcome to our first team post" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-discussion" }, + "examples": { + "default": { + "$ref": "#/components/examples/team-discussion-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "teams", + "subcategory": "discussions" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a discussion", + "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", + "tags": ["teams"], + "operationId": "teams/delete-discussion-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#delete-a-discussion" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": "discussions" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + "get": { + "summary": "List discussion comments", + "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "tags": ["teams"], + "operationId": "teams/list-discussion-comments-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#list-discussion-comments" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/direction" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team-discussion-comment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-discussion-comment-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "teams", + "subcategory": "discussion-comments" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a discussion comment", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "tags": ["teams"], + "operationId": "teams/create-discussion-comment-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#create-a-discussion-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The discussion comment's body text." + } + }, + "required": ["body"] + }, + "example": { "body": "Do you like apples?" } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-discussion-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-discussion-comment" + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "teams", + "subcategory": "discussion-comments" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + "get": { + "summary": "Get a discussion comment", + "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", + "tags": ["teams"], + "operationId": "teams/get-discussion-comment-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#get-a-discussion-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/comment-number" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-discussion-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-discussion-comment" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "teams", + "subcategory": "discussion-comments" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a discussion comment", + "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", + "tags": ["teams"], + "operationId": "teams/update-discussion-comment-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#update-a-discussion-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/comment-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The discussion comment's body text." + } + }, + "required": ["body"] + }, + "example": { "body": "Do you like pineapples?" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-discussion-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-discussion-comment-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "teams", + "subcategory": "discussion-comments" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a discussion comment", + "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", + "tags": ["teams"], + "operationId": "teams/delete-discussion-comment-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#delete-a-discussion-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/comment-number" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": "discussion-comments" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + "get": { + "summary": "List reactions for a team discussion comment", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "tags": ["reactions"], + "operationId": "reactions/list-for-team-discussion-comment-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/comment-number" }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/reaction" } + }, + "examples": { + "default": { "$ref": "#/components/examples/reaction-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create reaction for a team discussion comment", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "tags": ["reactions"], + "operationId": "reactions/create-for-team-discussion-comment-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/comment-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": ["content"] + }, + "example": { "content": "heart" } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/reaction" }, + "examples": { + "default": { "$ref": "#/components/examples/reaction" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete team discussion comment reaction", + "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["reactions"], + "operationId": "reactions/delete-for-team-discussion-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#delete-team-discussion-comment-reaction" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/comment-number" }, + { "$ref": "#/components/parameters/reaction-id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + "get": { + "summary": "List reactions for a team discussion", + "description": "List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", + "tags": ["reactions"], + "operationId": "reactions/list-for-team-discussion-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#list-reactions-for-a-team-discussion" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/reaction" } + }, + "examples": { + "default": { "$ref": "#/components/examples/reaction-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create reaction for a team discussion", + "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", + "tags": ["reactions"], + "operationId": "reactions/create-for-team-discussion-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#create-reaction-for-a-team-discussion" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": ["content"] + }, + "example": { "content": "heart" } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/reaction" }, + "examples": { + "default": { "$ref": "#/components/examples/reaction" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete team discussion reaction", + "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["reactions"], + "operationId": "reactions/delete-for-team-discussion", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#delete-team-discussion-reaction" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/reaction-id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/invitations": { + "get": { + "summary": "List pending team invitations", + "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", + "tags": ["teams"], + "operationId": "teams/list-pending-invitations-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#list-pending-team-invitations" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-invitation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-invitation-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": "members" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/members": { + "get": { + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "tags": ["teams"], + "operationId": "teams/list-members-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#list-team-members" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { + "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": ["member", "maintainer", "all"], + "default": "all" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": "members" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + "get": { + "summary": "Get team membership for a user", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", + "tags": ["teams"], + "operationId": "teams/get-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-membership" }, + "examples": { + "response-if-user-has-an-active-membership-with-team": { + "$ref": "#/components/examples/team-membership-response-if-user-has-an-active-membership-with-team" + }, + "response-if-user-is-a-team-maintainer": { + "$ref": "#/components/examples/team-membership-response-if-user-is-a-team-maintainer" + }, + "response-if-user-has-a-pending-membership-with-team": { + "$ref": "#/components/examples/team-membership-response-if-user-has-a-pending-membership-with-team" + } + } + } + } + }, + "404": { "description": "Response if user has no team membership" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": "members" + }, + "x-octokit": {} + }, + "put": { + "summary": "Add or update team membership for a user", + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": ["teams"], + "operationId": "teams/add-or-update-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/username" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "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"], + "default": "member" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-membership" }, + "examples": { + "response-if-users-membership-with-team-is-now-active": { + "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-active" + }, + "response-if-users-membership-with-team-is-now-pending": { + "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending" + } + } + } + } + }, + "403": { + "description": "Response if team synchronization is set up" + }, + "422": { + "description": "Response if you attempt to add an organization to a team", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { "type": "string" }, + "field": { "type": "string" }, + "resource": { "type": "string" } + } + } + } + } + }, + "examples": { + "response-if-you-attempt-to-add-an-organization-to-a-team": { + "value": { + "message": "Cannot add an organization as a member.", + "errors": [ + { + "code": "org", + "field": "user", + "resource": "TeamMember" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": "members" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove team membership for a user", + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": ["teams"], + "operationId": "teams/remove-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Empty response" }, + "403": { "description": "Response if team synchronization is set up" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": "members" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/projects": { + "get": { + "summary": "List team projects", + "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", + "tags": ["teams"], + "operationId": "teams/list-projects-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#list-team-projects" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team-project" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-project-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + "get": { + "summary": "Check team permissions for a project", + "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "tags": ["teams"], + "operationId": "teams/check-permissions-for-project-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#check-team-permissions-for-a-project" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/project-id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-project" }, + "examples": { + "default": { "$ref": "#/components/examples/team-project" } + } + } + } + }, + "404": { + "description": "Response if project is not managed by this team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + }, + "put": { + "summary": "Add or update team project permissions", + "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "tags": ["teams"], + "operationId": "teams/add-or-update-project-permissions-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#add-or-update-team-project-permissions" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/project-id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "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://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "enum": ["read", "write", "admin"] + } + } + } + } + } + }, + "responses": { + "204": { "description": "Empty response" }, + "403": { + "description": "Response if the project is not owned by the organization", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + }, + "examples": { + "response-if-the-project-is-not-owned-by-the-organization": { + "value": { + "message": "Must have admin rights to Repository.", + "documentation_url": "https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a project from a team", + "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "tags": ["teams"], + "operationId": "teams/remove-project-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#remove-a-project-from-a-team" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/project-id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/repos": { + "get": { + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "tags": ["teams"], + "operationId": "teams/list-repos-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#list-team-repositories" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/minimal-repository" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + "get": { + "summary": "Check team permissions for a repository", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "tags": ["teams"], + "operationId": "teams/check-permissions-for-repo-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#check-team-permissions-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "Alternative response with repository permissions", + "content": { + "application/vnd.github.v3.repository+json": { + "schema": { "$ref": "#/components/schemas/team-repository" }, + "examples": { + "alternative-response-with-repository-permissions": { + "$ref": "#/components/examples/team-repository-alternative-response-with-repository-permissions" + } + } + } + } + }, + "204": { + "description": "Response if team has permission for the repository" + }, + "404": { + "description": "Response if team does not have permission for the repository" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + }, + "put": { + "summary": "Add or update team repository permissions", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "tags": ["teams"], + "operationId": "teams/add-or-update-repo-permissions-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#add-or-update-team-repository-permissions" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "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\\* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. \n\\* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. \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.", + "enum": ["pull", "push", "admin", "maintain", "triage"] + } + } + } + } + } + }, + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a repository from a team", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "tags": ["teams"], + "operationId": "teams/remove-repo-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#remove-a-repository-from-a-team" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { + "get": { + "summary": "List IdP groups for a team", + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nList IdP groups connected to a team on GitHub.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", + "tags": ["teams"], + "operationId": "teams/list-idp-groups-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/group-mapping" }, + "examples": { + "default": { "$ref": "#/components/examples/group-mapping-3" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "previews": [], + "category": "teams", + "subcategory": "team-sync" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Create or update IdP group connections", + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", + "tags": ["teams"], + "operationId": "teams/create-or-update-idp-group-connections-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groups": { + "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": { + "type": "string", + "description": "ID of the IdP group." + }, + "group_name": { + "type": "string", + "description": "Name of the IdP group." + }, + "group_description": { + "type": "string", + "description": "Description of the IdP group." + } + }, + "required": [ + "group_id", + "group_name", + "group_description" + ] + } + } + }, + "required": ["groups"] + }, + "example": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "group_description": "string" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/group-mapping" }, + "examples": { + "default": { "$ref": "#/components/examples/group-mapping" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "previews": [], + "category": "teams", + "subcategory": "team-sync" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/teams/{team_slug}/teams": { + "get": { + "summary": "List child teams", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "tags": ["teams"], + "operationId": "teams/list-child-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#list-child-teams" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/team_slug" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "Response if child teams exist", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team" } + }, + "examples": { + "response-if-child-teams-exist": { + "$ref": "#/components/examples/team-items-response-if-child-teams-exist" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/projects/columns/cards/{card_id}": { + "get": { + "summary": "Get a project card", + "description": "", + "tags": ["projects"], + "operationId": "projects/get-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#get-a-project-card" + }, + "parameters": [{ "$ref": "#/components/parameters/card_id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/project-card" }, + "examples": { + "default": { "$ref": "#/components/examples/project-card" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "cards" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an existing project card", + "description": "", + "tags": ["projects"], + "operationId": "projects/update-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#update-a-project-card" + }, + "parameters": [{ "$ref": "#/components/parameters/card_id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "note": { + "description": "The project card's note", + "example": "Update all gems", + "type": "string", + "nullable": true + }, + "archived": { + "description": "Whether or not the card is archived", + "example": false, + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/project-card" }, + "examples": { + "default": { "$ref": "#/components/examples/project-card" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "cards" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a project card", + "description": "", + "tags": ["projects"], + "operationId": "projects/delete-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#delete-a-project-card" + }, + "parameters": [{ "$ref": "#/components/parameters/card_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" }, + "errors": { "type": "array", "items": { "type": "string" } } + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "cards" + }, + "x-octokit": {} + } + }, + "/projects/columns/cards/{card_id}/moves": { + "post": { + "summary": "Move a project card", + "description": "", + "tags": ["projects"], + "operationId": "projects/move-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#move-a-project-card" + }, + "parameters": [{ "$ref": "#/components/parameters/card_id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "position": { + "description": "The position of the card in a column", + "example": "bottom", + "type": "string", + "pattern": "^(?:top|bottom|after:\\d+)$" + }, + "column_id": { + "description": "The unique identifier of the column the card should be moved to", + "example": 42, + "type": "integer" + } + }, + "required": ["position"], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { "type": "string" }, + "message": { "type": "string" }, + "resource": { "type": "string" }, + "field": { "type": "string" } + } + } + } + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { "type": "string" }, + "message": { "type": "string" }, + "documentation_url": { "type": "string" }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { "type": "string" }, + "message": { "type": "string" } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "cards" + }, + "x-octokit": {} + } + }, + "/projects/columns/{column_id}": { + "get": { + "summary": "Get a project column", + "description": "", + "tags": ["projects"], + "operationId": "projects/get-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#get-a-project-column" + }, + "parameters": [{ "$ref": "#/components/parameters/column_id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/project-column" }, + "examples": { + "default": { "$ref": "#/components/examples/project-column" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "columns" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an existing project column", + "description": "", + "tags": ["projects"], + "operationId": "projects/update-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#update-a-project-column" + }, + "parameters": [{ "$ref": "#/components/parameters/column_id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the project column", + "example": "Remaining tasks", + "type": "string" + } + }, + "required": ["name"], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/project-column" }, + "examples": { + "default": { "$ref": "#/components/examples/project-column" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "columns" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a project column", + "description": "", + "tags": ["projects"], + "operationId": "projects/delete-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#delete-a-project-column" + }, + "parameters": [{ "$ref": "#/components/parameters/column_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "columns" + }, + "x-octokit": {} + } + }, + "/projects/columns/{column_id}/cards": { + "get": { + "summary": "List project cards", + "description": "", + "tags": ["projects"], + "operationId": "projects/list-cards", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#list-project-cards" + }, + "parameters": [ + { "$ref": "#/components/parameters/column_id" }, + { + "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": ["all", "archived", "not_archived"], + "default": "not_archived" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/project-card" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/project-card-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "cards" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a project card", + "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", + "tags": ["projects"], + "operationId": "projects/create-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#create-a-project-card" + }, + "parameters": [{ "$ref": "#/components/parameters/column_id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "note": { + "description": "The project card's note", + "example": "Update all gems", + "type": "string", + "nullable": true + } + }, + "required": ["note"] + }, + { + "type": "object", + "properties": { + "content_id": { + "description": "The unique identifier of the content associated with the card", + "example": 42, + "type": "integer" + }, + "content_type": { + "description": "The piece of content associated with the card", + "example": "PullRequest", + "type": "string" + } + }, + "required": ["content_id", "content_type"] + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/project-card" }, + "examples": { + "default": { "$ref": "#/components/examples/project-card" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { "$ref": "#/components/schemas/validation-error" }, + { "$ref": "#/components/schemas/validation-error-simple" } + ] + } + } + } + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { "type": "string" }, + "message": { "type": "string" }, + "documentation_url": { "type": "string" }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { "type": "string" }, + "message": { "type": "string" } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "cards" + }, + "x-octokit": {} + } + }, + "/projects/columns/{column_id}/moves": { + "post": { + "summary": "Move a project column", + "description": "", + "tags": ["projects"], + "operationId": "projects/move-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#move-a-project-column" + }, + "parameters": [{ "$ref": "#/components/parameters/column_id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "position": { + "description": "The position of the column in a project", + "example": "last", + "type": "string", + "pattern": "^(?:first|last|after:\\d+)$" + } + }, + "required": ["position"], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "columns" + }, + "x-octokit": {} + } + }, + "/projects/{project_id}": { + "get": { + "summary": "Get a project", + "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "tags": ["projects"], + "operationId": "projects/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/projects/#get-a-project" + }, + "parameters": [{ "$ref": "#/components/parameters/project-id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/project" }, + "examples": { + "default": { "$ref": "#/components/examples/project-3" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": null + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a project", + "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "operationId": "projects/update", + "tags": ["projects"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/projects/#update-a-project" + }, + "parameters": [{ "$ref": "#/components/parameters/project-id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the project", + "example": "Week One Sprint", + "type": "string" + }, + "body": { + "description": "Body of the project", + "example": "This project represents the sprint of the first week in January", + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project", + "type": "string", + "enum": ["read", "write", "admin", "none"] + }, + "private": { + "description": "Whether or not this project can be seen by everyone.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/project" }, + "examples": { + "default": { "$ref": "#/components/examples/project-3" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" }, + "errors": { "type": "array", "items": { "type": "string" } } + } + } + } + } + }, + "404": { + "description": "Response if the authenticated user does not have access to the project" + }, + "410": { "$ref": "#/components/responses/gone" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a project", + "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", + "operationId": "projects/delete", + "tags": ["projects"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/projects/#delete-a-project" + }, + "parameters": [{ "$ref": "#/components/parameters/project-id" }], + "responses": { + "204": { "description": "Delete Success" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" }, + "errors": { "type": "array", "items": { "type": "string" } } + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/projects/{project_id}/collaborators": { + "get": { + "summary": "List project collaborators", + "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.", + "tags": ["projects"], + "operationId": "projects/list-collaborators", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#list-project-collaborators" + }, + "parameters": [ + { "$ref": "#/components/parameters/project-id" }, + { + "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": ["outside", "direct", "all"], + "default": "all" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "collaborators" + }, + "x-octokit": {} + } + }, + "/projects/{project_id}/collaborators/{username}": { + "put": { + "summary": "Add project collaborator", + "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", + "tags": ["projects"], + "operationId": "projects/add-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#add-project-collaborator" + }, + "parameters": [ + { "$ref": "#/components/parameters/project-id" }, + { "$ref": "#/components/parameters/username" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "description": "The permission to grant the collaborator.", + "enum": ["read", "write", "admin"], + "default": "write", + "example": "write", + "type": "string" + } + } + } + } + } + }, + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "collaborators" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove user as a collaborator", + "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", + "tags": ["projects"], + "operationId": "projects/remove-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#remove-project-collaborator" + }, + "parameters": [ + { "$ref": "#/components/parameters/project-id" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "collaborators" + }, + "x-octokit": {} + } + }, + "/projects/{project_id}/collaborators/{username}/permission": { + "get": { + "summary": "Get project permission for a user", + "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", + "tags": ["projects"], + "operationId": "projects/get-permission-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#get-project-permission-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/project-id" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-collaborator-permission" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-collaborator-permission" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "collaborators" + }, + "x-octokit": {} + } + }, + "/projects/{project_id}/columns": { + "get": { + "summary": "List project columns", + "description": "", + "tags": ["projects"], + "operationId": "projects/list-columns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#list-project-columns" + }, + "parameters": [ + { "$ref": "#/components/parameters/project-id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/project-column" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/project-column-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "columns" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a project column", + "description": "", + "tags": ["projects"], + "operationId": "projects/create-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/projects#create-a-project-column" + }, + "parameters": [{ "$ref": "#/components/parameters/project-id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the project column", + "example": "Remaining tasks", + "type": "string" + } + }, + "required": ["name"], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/project-column" }, + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "columns" + }, + "x-octokit": {} + } + }, + "/rate_limit": { + "get": { + "summary": "Get rate limit status for the authenticated user", + "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "tags": ["rate-limit"], + "operationId": "rate-limit/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/rate_limit/#get-rate-limit-status-for-the-authenticated-user" + }, + "parameters": [], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rate-limit-overview" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rate-limit-overview" + } + } + } + }, + "headers": { + "X-RateLimit-Limit": { + "$ref": "#/components/headers/x-rate-limit-limit" + }, + "X-RateLimit-Remaining": { + "$ref": "#/components/headers/x-rate-limit-remaining" + }, + "X-RateLimit-Reset": { + "$ref": "#/components/headers/x-rate-limit-reset" + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "rate-limit", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/reactions/{reaction_id}": { + "delete": { + "summary": "Delete a reaction (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments).", + "tags": ["reactions"], + "operationId": "reactions/delete-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#delete-a-reaction-legacy" + }, + "parameters": [{ "$ref": "#/components/parameters/reaction-id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "410": { "$ref": "#/components/responses/gone" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-21", + "deprecationDate": "2020-02-26", + "category": "reactions", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}": { + "get": { + "summary": "Get a repository", + "description": "When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.\n\nThe `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", + "tags": ["repos"], + "operationId": "repos/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#get-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/full-repository" }, + "examples": { + "default-response": { + "$ref": "#/components/examples/full-repository-default-response" + }, + "response-with-scarlet-witch-preview-media-type": { + "$ref": "#/components/examples/full-repository-response-with-scarlet-witch-preview-media-type" + } + } + } + } + }, + "301": { "$ref": "#/components/responses/moved_permanently" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + }, + { + "required": false, + "name": "scarlet-witch", + "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a repository", + "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint.", + "tags": ["repos"], + "operationId": "repos/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#update-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository." + }, + "description": { + "type": "string", + "description": "A short description of the repository." + }, + "homepage": { + "type": "string", + "description": "A URL with more information about the repository." + }, + "private": { + "type": "boolean", + "description": "Either `true` to make the repository private or `false` to make it public. 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 + }, + "visibility": { + "type": "string", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.", + "enum": ["public", "private", "visibility", "internal"] + }, + "has_issues": { + "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "default": true + }, + "has_projects": { + "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": { + "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "default": true + }, + "is_template": { + "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "default": false + }, + "default_branch": { + "type": "string", + "description": "Updates the default branch for this repository." + }, + "allow_squash_merge": { + "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "default": true + }, + "allow_merge_commit": { + "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": { + "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "default": true + }, + "delete_branch_on_merge": { + "type": "boolean", + "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "default": false + }, + "archived": { + "type": "boolean", + "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "default": false + } + } + }, + "example": { + "name": "Hello-World", + "description": "This is your first repository", + "homepage": "https://github.com", + "private": true, + "has_issues": true, + "has_projects": true, + "has_wiki": true + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/full-repository" }, + "examples": { + "default": { "$ref": "#/components/examples/full-repository" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + }, + { + "required": false, + "name": "baptiste", + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a repository", + "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.", + "tags": ["repos"], + "operationId": "repos/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#delete-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "204": { "description": "Empty response" }, + "403": { + "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + }, + "example": { + "message": "Organization members cannot delete repositories.", + "documentation_url": "https://docs.github.com/rest/reference/repos#delete-a-repository" + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/artifacts": { + "get": { + "summary": "List artifacts for a repository", + "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/list-artifacts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "artifacts"], + "properties": { + "total_count": { "type": "integer" }, + "artifacts": { + "type": "array", + "items": { "$ref": "#/components/schemas/artifact" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "artifacts" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + "get": { + "summary": "Get an artifact", + "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/get-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-an-artifact" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/artifact_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/artifact" }, + "examples": { + "default": { "$ref": "#/components/examples/artifact" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "artifacts" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an artifact", + "description": "Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/delete-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#delete-an-artifact" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/artifact_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "artifacts" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + "get": { + "summary": "Download an artifact", + "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/download-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#download-an-artifact" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/artifact_id" }, + { + "name": "archive_format", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "302": { + "description": "response", + "headers": { + "Location": { "$ref": "#/components/headers/location" } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "artifacts" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + "get": { + "summary": "Get a job for a workflow run", + "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/get-job-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-a-job-for-a-workflow-run" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/job_id" } + ], + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/job" }, + "examples": { + "default": { "$ref": "#/components/examples/job" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-jobs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + "get": { + "summary": "Download job logs for a workflow run", + "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can\nuse this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must\nhave the `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/download-job-logs-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#download-job-logs-for-a-workflow-run" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/job_id" } + ], + "responses": { + "302": { + "description": "response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { "type": "string" } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-jobs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for a repository", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-github-actions-permissions-repository", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-repository-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-repository-permissions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "x-octokit": { + "changes": [ + { + "type": "OPERATION", + "date": "2020-11-10", + "before": { "operationId": "actions/get-repo-permissions" } + } + ] + } + }, + "put": { + "summary": "Set GitHub Actions permissions for a repository", + "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-github-actions-permissions-repository", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { "204": { "description": "Empty response" } }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { "$ref": "#/components/schemas/actions-enabled" }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + } + }, + "required": ["enabled"] + }, + "example": { "enabled": true, "allowed_actions": "selected" } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for a repository", + "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-allowed-actions-repository", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-allowed-actions-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/selected-actions" }, + "examples": { + "default": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set allowed actions for a repository", + "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-allowed-actions-repository", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { "204": { "description": "Empty response" } }, + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/selected-actions" }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runners": { + "get": { + "summary": "List self-hosted runners for a repository", + "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/list-self-hosted-runners-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "runners"], + "properties": { + "total_count": { "type": "integer" }, + "runners": { + "type": "array", + "items": { "$ref": "#/components/schemas/runner" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runners/downloads": { + "get": { + "summary": "List runner applications for a repository", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/list-runner-applications-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/runner-application" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-application-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runners/registration-token": { + "post": { + "summary": "Create a registration token for a repository", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate\nusing an access token with the `repo` scope to use this endpoint.\n\n#### Example using registration token\n \nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n```", + "tags": ["actions"], + "operationId": "actions/create-registration-token-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#create-a-registration-token-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authentication-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authentication-token" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runners/remove-token": { + "post": { + "summary": "Create a remove token for a repository", + "description": "Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\n\n#### Example using remove token\n \nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.\n\n```\n./config.sh remove --token TOKEN\n```", + "tags": ["actions"], + "operationId": "actions/create-remove-token-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#create-a-remove-token-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authentication-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authentication-token-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for a repository", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", + "tags": ["actions"], + "operationId": "actions/get-self-hosted-runner-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/runner_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/runner" }, + "examples": { + "default": { "$ref": "#/components/examples/runner" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a self-hosted runner from a repository", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo`\nscope to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/delete-self-hosted-runner-from-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/runner_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runs": { + "get": { + "summary": "List workflow runs for a repository", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/list-workflow-runs-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-workflow-runs-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/actor" }, + { "$ref": "#/components/parameters/workflow-run-branch" }, + { "$ref": "#/components/parameters/event" }, + { "$ref": "#/components/parameters/workflow-run-status" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "workflow_runs"], + "properties": { + "total_count": { "type": "integer" }, + "workflow_runs": { + "type": "array", + "items": { "$ref": "#/components/schemas/workflow-run" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-run-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}": { + "get": { + "summary": "Get a workflow run", + "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/get-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-a-workflow-run" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/run-id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/workflow-run" }, + "examples": { + "default": { "$ref": "#/components/examples/workflow-run" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a workflow run", + "description": "Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is\nprivate you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use\nthis endpoint.", + "operationId": "actions/delete-workflow-run", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#delete-a-workflow-run" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/run-id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + "get": { + "summary": "List workflow run artifacts", + "description": "Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/list-workflow-run-artifacts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-workflow-run-artifacts" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/run-id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "artifacts"], + "properties": { + "total_count": { "type": "integer" }, + "artifacts": { + "type": "array", + "items": { "$ref": "#/components/schemas/artifact" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "artifacts" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + "post": { + "summary": "Cancel a workflow run", + "description": "Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#cancel-a-workflow-run" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/run-id" } + ], + "responses": { "202": { "description": "response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + "get": { + "summary": "List jobs for a workflow run", + "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).", + "tags": ["actions"], + "operationId": "actions/list-jobs-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/run-id" }, + { + "name": "filter", + "description": "Filters jobs by their `completed_at` timestamp. Can be one of: \n\\* `latest`: Returns jobs from the most recent execution of the workflow run. \n\\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["latest", "all"], + "default": "latest" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "jobs"], + "properties": { + "total_count": { "type": "integer" }, + "jobs": { + "type": "array", + "items": { "$ref": "#/components/schemas/job" } + } + } + }, + "examples": { + "default": { "$ref": "#/components/examples/job-paginated" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-jobs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + "get": { + "summary": "Download workflow run logs", + "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use\nthis endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have\nthe `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/download-workflow-run-logs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#download-workflow-run-logs" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/run-id" } + ], + "responses": { + "302": { + "description": "response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { "type": "string" } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete workflow run logs", + "description": "Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/delete-workflow-run-logs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#delete-workflow-run-logs" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/run-id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + "post": { + "summary": "Re-run a workflow", + "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/re-run-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#re-run-a-workflow" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/run-id" } + ], + "responses": { "201": { "description": "response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + "get": { + "summary": "Get workflow run usage", + "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/get-workflow-run-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-workflow-run-usage" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/run-id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/workflow-run-usage" }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-run-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/secrets": { + "get": { + "summary": "List repository secrets", + "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/list-repo-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-repository-secrets" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "secrets"], + "properties": { + "total_count": { "type": "integer" }, + "secrets": { + "type": "array", + "items": { "$ref": "#/components/schemas/actions-secret" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/secrets/public-key": { + "get": { + "summary": "Get a repository public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/get-repo-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-a-repository-public-key" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/actions-public-key" }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + "get": { + "summary": "Get a repository secret", + "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/get-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-a-repository-secret" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/secret_name" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/actions-secret" }, + "examples": { + "default": { "$ref": "#/components/examples/actions-secret" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "put": { + "summary": "Create or update a repository secret", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "tags": ["actions"], + "operationId": "actions/create-or-update-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#create-or-update-a-repository-secret" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/secret_name" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint." + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + } + }, + "example": { + "encrypted_value": "****************************************************************************************", + "key_id": "012345678912345678" + } + } + } + }, + "responses": { + "201": { "description": "Response when creating a secret" }, + "204": { "description": "Response when updating a secret" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a repository secret", + "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/delete-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#delete-a-repository-secret" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/secret_name" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/workflows": { + "get": { + "summary": "List repository workflows", + "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/list-repo-workflows", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-repository-workflows" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "workflows"], + "properties": { + "total_count": { "type": "integer" }, + "workflows": { + "type": "array", + "items": { "$ref": "#/components/schemas/workflow" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflows" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + "get": { + "summary": "Get a workflow", + "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/get-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-a-workflow" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/workflow-id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/workflow" }, + "examples": { + "default": { "$ref": "#/components/examples/workflow" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflows" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + "put": { + "summary": "Disable a workflow", + "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/disable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#disable-a-workflow" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/workflow-id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflows" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + "post": { + "summary": "Create a workflow dispatch event", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", + "operationId": "actions/create-workflow-dispatch", + "tags": ["actions"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#create-a-workflow-dispatch-event" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/workflow-id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The git reference for the workflow. The reference can be a branch or tag name." + }, + "inputs": { + "type": "object", + "description": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", + "additionalProperties": { "type": "string" }, + "maxProperties": 10 + } + }, + "required": ["ref"] + }, + "example": { + "ref": "topic-branch", + "inputs": { + "name": "Mona the Octocat", + "home": "San Francisco, CA" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflows" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + "put": { + "summary": "Enable a workflow", + "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/enable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#enable-a-workflow" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/workflow-id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflows" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + "get": { + "summary": "List workflow runs", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", + "tags": ["actions"], + "operationId": "actions/list-workflow-runs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#list-workflow-runs" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/workflow-id" }, + { "$ref": "#/components/parameters/actor" }, + { "$ref": "#/components/parameters/workflow-run-branch" }, + { "$ref": "#/components/parameters/event" }, + { "$ref": "#/components/parameters/workflow-run-status" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "workflow_runs"], + "properties": { + "total_count": { "type": "integer" }, + "workflow_runs": { + "type": "array", + "items": { "$ref": "#/components/schemas/workflow-run" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-run-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + "get": { + "summary": "Get workflow usage", + "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": ["actions"], + "operationId": "actions/get-workflow-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#get-workflow-usage" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/workflow-id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/workflow-usage" }, + "examples": { + "default": { "$ref": "#/components/examples/workflow-usage" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "actions", + "subcategory": "workflows" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/assignees": { + "get": { + "summary": "List assignees", + "description": "Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "tags": ["issues"], + "operationId": "issues/list-assignees", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#list-assignees" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "assignees" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/assignees/{assignee}": { + "get": { + "summary": "Check if a user can be assigned", + "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.", + "tags": ["issues"], + "operationId": "issues/check-user-can-be-assigned", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#check-if-a-user-can-be-assigned" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "assignee", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "204": { + "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned." + }, + "404": { + "description": "Otherwise a `404` status code is returned.", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "assignees" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/automated-security-fixes": { + "put": { + "summary": "Enable automated security fixes", + "description": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)\".", + "tags": ["repos"], + "operationId": "repos/enable-automated-security-fixes", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#enable-automated-security-fixes" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "london", + "note": "Enabling or disabling automated security fixes is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.london-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Disable automated security fixes", + "description": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)\".", + "tags": ["repos"], + "operationId": "repos/disable-automated-security-fixes", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#disable-automated-security-fixes" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "london", + "note": "Enabling or disabling automated security fixes is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.london-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/branches": { + "get": { + "summary": "List branches", + "description": "", + "tags": ["repos"], + "operationId": "repos/list-branches", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-branches" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "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" } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/short-branch" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/short-branch-items" + }, + "with-protection": { + "$ref": "#/components/examples/short-branch-with-protection-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/branches/{branch}": { + "get": { + "summary": "Get a branch", + "description": "", + "tags": ["repos"], + "operationId": "repos/get-branch", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-branch" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/branch-with-protection" + }, + "examples": { + "default": { + "$ref": "#/components/examples/branch-with-protection" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection": { + "get": { + "summary": "Get branch protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": ["repos"], + "operationId": "repos/get-branch-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-branch-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/branch-protection" }, + "examples": { + "default": { + "$ref": "#/components/examples/branch-protection" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "luke-cage", + "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "put": { + "summary": "Update branch protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "tags": ["repos"], + "operationId": "repos/update-branch-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#update-branch-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "required_status_checks": { + "type": "object", + "description": "Require status checks to pass before merging. Set to `null` to disable.", + "nullable": true, + "properties": { + "strict": { + "type": "boolean", + "description": "Require branches to be up to date before merging." + }, + "contexts": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch", + "items": { "type": "string" } + } + }, + "required": ["strict", "contexts"] + }, + "enforce_admins": { + "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": { + "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": { + "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": { + "type": "array", + "description": "The list of user `login`s with dismissal access", + "items": { "type": "string" } + }, + "teams": { + "type": "array", + "description": "The list of team `slug`s with dismissal access", + "items": { "type": "string" } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." + }, + "require_code_owner_reviews": { + "type": "boolean", + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them." + }, + "required_approving_review_count": { + "type": "integer", + "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6." + } + } + }, + "restrictions": { + "type": "object", + "description": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", + "nullable": true, + "properties": { + "users": { + "type": "array", + "description": "The list of user `login`s with push access", + "items": { "type": "string" } + }, + "teams": { + "type": "array", + "description": "The list of team `slug`s with push access", + "items": { "type": "string" } + }, + "apps": { + "type": "array", + "description": "The list of app `slug`s with push access", + "items": { "type": "string" } + } + }, + "required": ["users", "teams"] + }, + "required_linear_history": { + "type": "boolean", + "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation." + }, + "allow_force_pushes": { + "type": "boolean", + "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", + "nullable": true + }, + "allow_deletions": { + "type": "boolean", + "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation." + } + }, + "required": [ + "required_status_checks", + "enforce_admins", + "required_pull_request_reviews", + "restrictions" + ] + }, + "example": { + "required_status_checks": { + "strict": true, + "contexts": ["continuous-integration/travis-ci"] + }, + "enforce_admins": true, + "required_pull_request_reviews": { + "dismissal_restrictions": { + "users": ["octocat"], + "teams": ["justice-league"] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2 + }, + "restrictions": { + "users": ["octocat"], + "teams": ["justice-league"], + "apps": ["super-ci"] + }, + "required_linear_history": true, + "allow_force_pushes": true, + "allow_deletions": true + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/protected-branch" } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "luke-cage", + "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete branch protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": ["repos"], + "operationId": "repos/delete-branch-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-branch-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "204": { "description": "Empty response" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + "get": { + "summary": "Get admin branch protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": ["repos"], + "operationId": "repos/get-admin-branch-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-admin-branch-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/protected-branch-admin-enforced" + }, + "examples": { + "default": { + "$ref": "#/components/examples/protected-branch-admin-enforced-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "post": { + "summary": "Set admin branch protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "tags": ["repos"], + "operationId": "repos/set-admin-branch-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#set-admin-branch-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/protected-branch-admin-enforced" + }, + "examples": { + "default": { + "$ref": "#/components/examples/protected-branch-admin-enforced-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete admin branch protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "tags": ["repos"], + "operationId": "repos/delete-admin-branch-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-admin-branch-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "204": { "description": "No Content" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + "get": { + "summary": "Get pull request review protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": ["repos"], + "operationId": "repos/get-pull-request-review-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-pull-request-review-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/vnd.github.luke-cage-preview+json": { + "schema": { + "$ref": "#/components/schemas/protected-branch-pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/protected-branch-pull-request-review" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "luke-cage", + "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update pull request review protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "tags": ["repos"], + "operationId": "repos/update-pull-request-review-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#update-pull-request-review-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "dismissal_restrictions": { + "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": { + "type": "array", + "description": "The list of user `login`s with dismissal access", + "items": { "type": "string" } + }, + "teams": { + "type": "array", + "description": "The list of team `slug`s with dismissal access", + "items": { "type": "string" } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." + }, + "require_code_owner_reviews": { + "type": "boolean", + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed." + }, + "required_approving_review_count": { + "type": "integer", + "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6." + } + } + }, + "example": { + "dismissal_restrictions": { + "users": ["octocat"], + "teams": ["justice-league"] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2 + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/protected-branch-pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/protected-branch-pull-request-review" + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "luke-cage", + "note": "The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.luke-cage-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete pull request review protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": ["repos"], + "operationId": "repos/delete-pull-request-review-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-pull-request-review-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "204": { "description": "No Content" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + "get": { + "summary": "Get commit signature protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "tags": ["repos"], + "operationId": "repos/get-commit-signature-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-commit-signature-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/protected-branch-admin-enforced" + }, + "examples": { + "default": { + "$ref": "#/components/examples/protected-branch-admin-enforced" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "zzzax", + "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create commit signature protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "tags": ["repos"], + "operationId": "repos/create-commit-signature-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#create-commit-signature-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/protected-branch-admin-enforced" + }, + "examples": { + "default": { + "$ref": "#/components/examples/protected-branch-admin-enforced" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "zzzax", + "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete commit signature protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "tags": ["repos"], + "operationId": "repos/delete-commit-signature-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-commit-signature-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "204": { "description": "No Content" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "zzzax", + "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + "get": { + "summary": "Get status checks protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": ["repos"], + "operationId": "repos/get-status-checks-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-status-checks-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status-check-policy" + }, + "examples": { + "default": { + "$ref": "#/components/examples/status-check-policy" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update status check protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "tags": ["repos"], + "operationId": "repos/update-status-check-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#update-status-check-potection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "strict": { + "type": "boolean", + "description": "Require branches to be up to date before merging." + }, + "contexts": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch", + "items": { "type": "string" } + } + } + }, + "example": { + "strict": true, + "contexts": ["continuous-integration/travis-ci"] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status-check-policy" + }, + "examples": { + "default": { + "$ref": "#/components/examples/status-check-policy" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": { + "changes": [ + { + "type": "OPERATION", + "date": "2020-09-17", + "before": { "operationId": "repos/update-status-check-potection" } + } + ] + } + }, + "delete": { + "summary": "Remove status check protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": ["repos"], + "operationId": "repos/remove-status-check-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#remove-status-check-protection" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { "204": { "description": "No Content" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + "get": { + "summary": "Get all status check contexts", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": ["repos"], + "operationId": "repos/get-all-status-check-contexts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-all-status-check-contexts" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "type": "array", "items": { "type": "string" } }, + "example": ["continuous-integration/travis-ci"] + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "post": { + "summary": "Add status check contexts", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": ["repos"], + "operationId": "repos/add-status-check-contexts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#add-status-check-contexts" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "contexts": { + "type": "array", + "description": "contexts parameter", + "items": { "type": "string" } + } + }, + "required": ["contexts"], + "example": { "contexts": ["contexts"] } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "type": "array", "items": { "type": "string" } }, + "example": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "contexts", + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set status check contexts", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": ["repos"], + "operationId": "repos/set-status-check-contexts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#set-status-check-contexts" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "contexts": { + "type": "array", + "description": "contexts parameter", + "items": { "type": "string" } + } + }, + "required": ["contexts"], + "example": { "contexts": ["contexts"] } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "type": "array", "items": { "type": "string" } }, + "example": ["continuous-integration/travis-ci"] + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "contexts", + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove status check contexts", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": ["repos"], + "operationId": "repos/remove-status-check-contexts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#remove-status-check-contexts" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "contexts": { + "type": "array", + "description": "contexts parameter", + "items": { "type": "string" } + } + }, + "required": ["contexts"], + "example": { "contexts": ["contexts"] } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "type": "array", "items": { "type": "string" } }, + "example": ["continuous-integration/travis-ci"] + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "contexts", + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + "get": { + "summary": "Get access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "tags": ["repos"], + "operationId": "repos/get-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-access-restrictions" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/branch-restriction-policy" + }, + "examples": { + "default": { + "$ref": "#/components/examples/branch-restriction-policy" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "tags": ["repos"], + "operationId": "repos/delete-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-access-restrictions" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { "204": { "description": "No Content" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + "get": { + "summary": "Get apps with access to the protected branch", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", + "tags": ["repos"], + "operationId": "repos/get-apps-with-access-to-protected-branch", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-apps-with-access-to-the-protected-branch" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/integration" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration-items" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "post": { + "summary": "Add app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": ["repos"], + "operationId": "repos/add-app-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#add-app-access-restrictions" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "apps parameter", + "items": { "type": "string" } + } + }, + "required": ["apps"], + "example": { "apps": ["my-app"] } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/integration" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration-items" + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "apps", + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": ["repos"], + "operationId": "repos/set-app-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#set-app-access-restrictions" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "apps parameter", + "items": { "type": "string" } + } + }, + "required": ["apps"], + "example": { "apps": ["my-app"] } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/integration" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration-items" + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "apps", + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": ["repos"], + "operationId": "repos/remove-app-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#remove-app-access-restrictions" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "apps parameter", + "items": { "type": "string" } + } + }, + "required": ["apps"], + "example": { "apps": ["my-app"] } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/integration" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration-items" + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "apps", + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + "get": { + "summary": "Get teams with access to the protected branch", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "tags": ["repos"], + "operationId": "repos/get-teams-with-access-to-protected-branch", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team" } + }, + "examples": { + "default": { "$ref": "#/components/examples/team-items" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "post": { + "summary": "Add team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": ["repos"], + "operationId": "repos/add-team-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#add-team-access-restrictions" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "teams": { + "type": "array", + "description": "teams parameter", + "items": { "type": "string" } + } + }, + "required": ["teams"], + "example": { "teams": ["my-team"] } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team" } + }, + "examples": { + "default": { "$ref": "#/components/examples/team-items" } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "teams", + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": ["repos"], + "operationId": "repos/set-team-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#set-team-access-restrictions" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "teams": { + "type": "array", + "description": "teams parameter", + "items": { "type": "string" } + } + }, + "required": ["teams"], + "example": { "teams": ["my-team"] } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team" } + }, + "examples": { + "default": { "$ref": "#/components/examples/team-items" } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "teams", + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": ["repos"], + "operationId": "repos/remove-team-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#remove-team-access-restrictions" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "teams": { + "type": "array", + "description": "teams parameter", + "items": { "type": "string" } + } + }, + "required": ["teams"], + "example": { "teams": ["my-team"] } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team" } + }, + "examples": { + "default": { "$ref": "#/components/examples/team-items" } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "teams", + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + "get": { + "summary": "Get users with access to the protected branch", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "tags": ["repos"], + "operationId": "repos/get-users-with-access-to-protected-branch", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-users-with-access-to-the-protected-branch" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "post": { + "summary": "Add user access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": ["repos"], + "operationId": "repos/add-user-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#add-user-access-restrictions" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "users parameter", + "items": { "type": "string" } + } + }, + "required": ["users"], + "example": { "users": ["mona"] } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "users", + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set user access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": ["repos"], + "operationId": "repos/set-user-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#set-user-access-restrictions" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "users parameter", + "items": { "type": "string" } + } + }, + "required": ["users"], + "example": { "users": ["mona"] } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "users", + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove user access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": ["repos"], + "operationId": "repos/remove-user-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#remove-user-access-restrictions" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/branch" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "users parameter", + "items": { "type": "string" } + } + }, + "required": ["users"], + "example": { "users": ["mona"] } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "users", + "category": "repos", + "subcategory": "branches" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/check-runs": { + "post": { + "summary": "Create a check run", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.", + "tags": ["checks"], + "operationId": "checks/create", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/checks#create-a-check-run" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the check. For example, \"code-coverage\"." + }, + "head_sha": { + "type": "string", + "description": "The SHA of the commit." + }, + "details_url": { + "type": "string", + "description": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used." + }, + "external_id": { + "type": "string", + "description": "A reference for the run on the integrator's system." + }, + "status": { + "type": "string", + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "default": "queued" + }, + "started_at": { + "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": { + "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`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ] + }, + "completed_at": { + "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": { + "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://docs.github.com/rest/reference/checks#output-object) description.", + "properties": { + "title": { + "type": "string", + "description": "The title of the check run." + }, + "summary": { + "type": "string", + "description": "The summary of the check run. This parameter supports Markdown." + }, + "text": { + "type": "string", + "description": "The details of the check run. This parameter supports Markdown." + }, + "annotations": { + "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://docs.github.com/rest/reference/checks#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://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter.", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`." + }, + "start_line": { + "type": "integer", + "description": "The start line of the annotation." + }, + "end_line": { + "type": "integer", + "description": "The end line of the annotation." + }, + "start_column": { + "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": { + "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": { + "type": "string", + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", + "enum": ["notice", "warning", "failure"] + }, + "message": { + "type": "string", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB." + }, + "title": { + "type": "string", + "description": "The title that represents the annotation. The maximum size is 255 characters." + }, + "raw_details": { + "type": "string", + "description": "Details about this annotation. The maximum size is 64 KB." + } + }, + "required": [ + "path", + "start_line", + "end_line", + "annotation_level", + "message" + ] + } + }, + "images": { + "type": "array", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details.", + "items": { + "type": "object", + "properties": { + "alt": { + "type": "string", + "description": "The alternative text for the image." + }, + "image_url": { + "type": "string", + "description": "The full URL of the image." + }, + "caption": { + "type": "string", + "description": "A short image description." + } + }, + "required": ["alt", "image_url"] + } + } + }, + "required": ["title", "summary"] + }, + "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://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"", + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters." + }, + "description": { + "type": "string", + "description": "A short explanation of what this action would do. The maximum size is 40 characters." + }, + "identifier": { + "type": "string", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters." + } + }, + "required": ["label", "description", "identifier"] + } + } + }, + "required": ["name", "head_sha"] + }, + "examples": { + "example-of-in-progress-conclusion": { + "summary": "Example of in_progress conclusion", + "value": { + "name": "mighty_readme", + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "status": "in_progress", + "external_id": "42", + "started_at": "2018-05-04T01:14:52Z", + "output": { + "title": "Mighty Readme report", + "summary": "", + "text": "" + } + } + }, + "example-of-completed-conclusion": { + "summary": "Example of completed conclusion", + "value": { + "name": "mighty_readme", + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "status": "completed", + "started_at": "2017-11-30T19:39:10Z", + "conclusion": "success", + "completed_at": "2017-11-30T19:49:10Z", + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notices.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations": [ + { + "path": "README.md", + "annotation_level": "warning", + "title": "Spell Checker", + "message": "Check your spelling for 'banaas'.", + "raw_details": "Do you mean 'bananas' or 'banana'?", + "start_line": 2, + "end_line": 2 + }, + { + "path": "README.md", + "annotation_level": "warning", + "title": "Spell Checker", + "message": "Check your spelling for 'aples'", + "raw_details": "Do you mean 'apples' or 'Naples'", + "start_line": 4, + "end_line": 4 + } + ], + "images": [ + { + "alt": "Super bananas", + "image_url": "http://example.com/images/42" + } + ] + }, + "actions": [ + { + "label": "Fix", + "identifier": "fix_errors", + "description": "Allow us to fix these errors for you" + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/check-run" }, + "examples": { + "example-of-in-progress-conclusion": { + "$ref": "#/components/examples/check-run-example-of-in-progress-conclusion" + }, + "example-of-completed-conclusion": { + "$ref": "#/components/examples/check-run-example-of-completed-conclusion" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "runs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + "get": { + "summary": "Get a check run", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "tags": ["checks"], + "operationId": "checks/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/checks#get-a-check-run" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/check_run_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/check-run" }, + "examples": { + "default": { "$ref": "#/components/examples/check-run" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "runs" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a check run", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", + "tags": ["checks"], + "operationId": "checks/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/checks#update-a-check-run" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/check_run_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the check. For example, \"code-coverage\"." + }, + "details_url": { + "type": "string", + "description": "The URL of the integrator's site that has the full details of the check." + }, + "external_id": { + "type": "string", + "description": "A reference for the run on the integrator's system." + }, + "started_at": { + "type": "string", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "status": { + "type": "string", + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"] + }, + "conclusion": { + "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`, `skipped`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ] + }, + "completed_at": { + "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": { + "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://docs.github.com/rest/reference/checks#output-object-1) description.", + "properties": { + "title": { + "type": "string", + "description": "**Required**." + }, + "summary": { + "type": "string", + "description": "Can contain Markdown." + }, + "text": { + "type": "string", + "description": "Can contain Markdown." + }, + "annotations": { + "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://docs.github.com/rest/reference/checks#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://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`." + }, + "start_line": { + "type": "integer", + "description": "The start line of the annotation." + }, + "end_line": { + "type": "integer", + "description": "The end line of the annotation." + }, + "start_column": { + "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": { + "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": { + "type": "string", + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", + "enum": ["notice", "warning", "failure"] + }, + "message": { + "type": "string", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB." + }, + "title": { + "type": "string", + "description": "The title that represents the annotation. The maximum size is 255 characters." + }, + "raw_details": { + "type": "string", + "description": "Details about this annotation. The maximum size is 64 KB." + } + }, + "required": [ + "path", + "start_line", + "end_line", + "annotation_level", + "message" + ] + } + }, + "images": { + "type": "array", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.", + "items": { + "type": "object", + "properties": { + "alt": { + "type": "string", + "description": "The alternative text for the image." + }, + "image_url": { + "type": "string", + "description": "The full URL of the image." + }, + "caption": { + "type": "string", + "description": "A short image description." + } + }, + "required": ["alt", "image_url"] + } + } + }, + "required": ["summary"] + }, + "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://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"", + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters." + }, + "description": { + "type": "string", + "description": "A short explanation of what this action would do. The maximum size is 40 characters." + }, + "identifier": { + "type": "string", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters." + } + }, + "required": ["label", "description", "identifier"] + } + } + } + }, + "example": { + "name": "mighty_readme", + "started_at": "2018-05-04T01:14:52Z", + "status": "completed", + "conclusion": "success", + "completed_at": "2018-05-04T01:14:52Z", + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notices.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations": [ + { + "path": "README.md", + "annotation_level": "warning", + "title": "Spell Checker", + "message": "Check your spelling for 'banaas'.", + "raw_details": "Do you mean 'bananas' or 'banana'?", + "start_line": 2, + "end_line": 2 + }, + { + "path": "README.md", + "annotation_level": "warning", + "title": "Spell Checker", + "message": "Check your spelling for 'aples'", + "raw_details": "Do you mean 'apples' or 'Naples'", + "start_line": 4, + "end_line": 4 + } + ], + "images": [ + { + "alt": "Super bananas", + "image_url": "http://example.com/images/42" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/check-run" }, + "examples": { + "default": { "$ref": "#/components/examples/check-run" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "runs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + "get": { + "summary": "List check run annotations", + "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", + "tags": ["checks"], + "operationId": "checks/list-annotations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/checks#list-check-run-annotations" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/check_run_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/check-annotation" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-annotation-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "runs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/check-suites": { + "post": { + "summary": "Create a check suite", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.", + "tags": ["checks"], + "operationId": "checks/create-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/checks#create-a-check-suite" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "head_sha": { + "type": "string", + "description": "The sha of the head commit." + } + }, + "required": ["head_sha"] + }, + "example": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/check-suite" }, + "examples": { + "default": { "$ref": "#/components/examples/check-suite" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "suites" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/check-suites/preferences": { + "patch": { + "summary": "Update repository preferences for check suites", + "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", + "tags": ["checks"], + "operationId": "checks/set-suites-preferences", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "auto_trigger_checks": { + "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://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details.", + "items": { + "type": "object", + "properties": { + "app_id": { + "type": "integer", + "description": "The `id` of the GitHub App." + }, + "setting": { + "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 + } + }, + "required": ["app_id", "setting"] + } + } + } + }, + "example": { + "auto_trigger_checks": [{ "app_id": 4, "setting": false }] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/check-suite-preference" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-suite-preference" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "suites" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + "get": { + "summary": "Get a check suite", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "tags": ["checks"], + "operationId": "checks/get-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/checks#get-a-check-suite" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/check_suite_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/check-suite" }, + "examples": { + "default": { "$ref": "#/components/examples/check-suite" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "suites" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + "get": { + "summary": "List check runs in a check suite", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "tags": ["checks"], + "operationId": "checks/list-for-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/check_suite_id" }, + { "$ref": "#/components/parameters/check_name" }, + { "$ref": "#/components/parameters/status" }, + { + "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": ["latest", "all"], + "default": "latest" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "check_runs"], + "properties": { + "total_count": { "type": "integer" }, + "check_runs": { + "type": "array", + "items": { "$ref": "#/components/schemas/check-run" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "runs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + "post": { + "summary": "Rerequest a check suite", + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", + "tags": ["checks"], + "operationId": "checks/rerequest-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/checks#rerequest-a-check-suite" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/check_suite_id" } + ], + "responses": { "201": { "description": "response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "suites" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts": { + "get": { + "summary": "List code scanning alerts for a repository", + "description": "Lists all open code scanning alerts for the default branch (usually `main` or `master`). You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "tags": ["code-scanning"], + "operationId": "code-scanning/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/code-scanning/#list-code-scanning-alerts-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "state", + "description": "Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-alert-state" + } + }, + { + "name": "ref", + "in": "query", + "description": "Set a full Git reference to list alerts for a specific branch. The `ref` must be formatted as `refs/heads/`.", + "required": false, + "schema": { "$ref": "#/components/schemas/code-scanning-alert-ref" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-scanning-alert-code-scanning-alert-items" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-alert-code-scanning-alert-items" + } + } + } + } + }, + "403": { + "description": "Response if github advanced security is not enabled for this repository" + }, + "404": { + "description": "Response if the ref does not match an existing ref" + }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + "get": { + "summary": "Get a code scanning alert", + "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe security `alert_number` is found at the end of the security alert's URL. For example, the security alert ID for `https://github.com/Octo-org/octo-repo/security/code-scanning/88` is `88`.", + "tags": ["code-scanning"], + "operationId": "code-scanning/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/code-scanning/#get-a-code-scanning-alert" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "alert_number", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-alert-code-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-alert-code-scanning-alert" + } + } + } + } + }, + "403": { + "description": "Response if github advanced security is not enabled for this repository" + }, + "404": { "$ref": "#/components/responses/not_found" }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": null + }, + "x-octokit": { + "changes": [ + { + "type": "PARAMETER", + "date": "2020-09-17", + "parameter": "alert_number", + "before": { "name": "alert_id" } + } + ] + } + }, + "patch": { + "summary": "Update a code scanning alert", + "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.", + "operationId": "code-scanning/update-alert", + "tags": ["code-scanning"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/code-scanning/#upload-a-code-scanning-alert" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/alert_number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "$ref": "#/components/schemas/code-scanning-alert-set-state" + }, + "dismissed_reason": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" + } + }, + "required": ["state"] + }, + "example": { + "state": "dismissed", + "dismissed_reason": "false positive" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-alert-code-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-alert-code-scanning-alert-dismissed" + } + } + } + } + }, + "403": { + "description": "Response if the repository is archived, or if github advanced security is not enabled for this repository" + }, + "503": { + "description": "Response when code scanning is not available and you should try again at a later time" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "code-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/analyses": { + "get": { + "summary": "List recent code scanning analyses for a repository", + "description": "List the details of recent code scanning analyses for a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "operationId": "code-scanning/list-recent-analyses", + "tags": ["code-scanning"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/code-scanning/#list-recent-analyses" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "ref", + "in": "query", + "description": "Set a full Git reference to list alerts for a specific branch. The `ref` must be formatted as `refs/heads/`.", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-analysis-ref" + } + }, + { + "name": "tool_name", + "in": "query", + "description": "Set a single code scanning tool name to filter alerts by tool.", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-analysis-tool-name" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-scanning-analysis-code-scanning-analysis" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-analysis-code-scanning-analysis-items" + } + } + } + } + }, + "403": { + "description": "Response if github advanced security is not enabled for this repository" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "code-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/sarifs": { + "post": { + "summary": "Upload a SARIF file", + "description": "Upload a SARIF file containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.", + "operationId": "code-scanning/upload-sarif", + "tags": ["code-scanning"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/code-scanning/#upload-a-sarif-analysis" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commit_sha": { + "$ref": "#/components/schemas/code-scanning-analysis-commit-sha" + }, + "ref": { + "$ref": "#/components/schemas/code-scanning-analysis-ref" + }, + "sarif": { + "$ref": "#/components/schemas/code-scanning-analysis-sarif-file" + }, + "checkout_uri": { + "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", + "example": "file:///github/workspace/", + "type": "string", + "format": "uri" + }, + "started_at": { + "description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date", + "type": "string" + }, + "tool_name": { + "$ref": "#/components/schemas/code-scanning-analysis-tool-name" + } + }, + "required": ["commit_sha", "ref", "sarif", "tool_name"] + }, + "example": { + "commit_sha": "9a450a043b9038ba86722926570d2312cff6aba8", + "ref": "refs/heads/main", + "sarif": "REPLACE_ME", + "tool_name": "codeql" + } + } + } + }, + "responses": { + "202": { "description": "response" }, + "400": { "description": "Response if the `sarif` field is invalid" }, + "403": { + "description": "Response if the repository is archived, or if github advanced security is not enabled for this repository" + }, + "404": { + "description": "Response if `commit_sha` or `ref` cannot be found" + }, + "413": { "description": "Response if the `sarif` field is too large" } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "code-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/collaborators": { + "get": { + "summary": "List repository collaborators", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.", + "tags": ["repos"], + "operationId": "repos/list-collaborators", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-repository-collaborators" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "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": ["outside", "direct", "all"], + "default": "all" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/collaborator" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/collaborator-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "collaborators" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/collaborators/{username}": { + "get": { + "summary": "Check if a user is a repository collaborator", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.", + "tags": ["repos"], + "operationId": "repos/check-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#check-if-a-user-is-a-repository-collaborator" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Response if user is a collaborator" }, + "404": { "description": "Response if user is not a collaborator" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "collaborators" + }, + "x-octokit": {} + }, + "put": { + "summary": "Add a repository collaborator", + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "tags": ["repos"], + "operationId": "repos/add-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#add-a-repository-collaborator" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/username" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "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. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", + "enum": ["pull", "push", "admin", "maintain", "triage"], + "default": "push" + }, + "permissions": { "type": "string", "example": "\"push\"" } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when a new invitation is created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-invitation" + }, + "examples": { + "response-when-a-new-invitation-is-created": { + "$ref": "#/components/examples/repository-invitation-response-when-a-new-invitation-is-created" + } + } + } + } + }, + "204": { + "description": "Response when person is already a collaborator" + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "collaborators" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a repository collaborator", + "description": "", + "tags": ["repos"], + "operationId": "repos/remove-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#remove-a-repository-collaborator" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "collaborators" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/collaborators/{username}/permission": { + "get": { + "summary": "Get repository permissions for a user", + "description": "Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`.", + "tags": ["repos"], + "operationId": "repos/get-collaborator-permission-level", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-repository-permissions-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "200": { + "description": "Response if user has admin permissions", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-collaborator-permission" + }, + "examples": { + "response-if-user-has-admin-permissions": { + "$ref": "#/components/examples/repository-collaborator-permission-response-if-user-has-admin-permissions" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "collaborators" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/comments": { + "get": { + "summary": "List commit comments for a repository", + "description": "Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/).\n\nComments are ordered by ascending ID.", + "tags": ["repos"], + "operationId": "repos/list-commit-comments-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-commit-comments-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/commit-comment" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-comment-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "repos", + "subcategory": "comments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/comments/{comment_id}": { + "get": { + "summary": "Get a commit comment", + "description": "", + "tags": ["repos"], + "operationId": "repos/get-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-commit-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/commit-comment" }, + "examples": { + "default": { "$ref": "#/components/examples/commit-comment" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "repos", + "subcategory": "comments" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a commit comment", + "description": "", + "tags": ["repos"], + "operationId": "repos/update-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#update-a-commit-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The contents of the comment" + } + }, + "required": ["body"] + }, + "example": { "body": "Nice change" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/commit-comment" }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-comment-2" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "comments" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a commit comment", + "description": "", + "tags": ["repos"], + "operationId": "repos/delete-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-a-commit-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "comments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + "get": { + "summary": "List reactions for a commit comment", + "description": "List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments).", + "tags": ["reactions"], + "operationId": "reactions/list-for-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#list-reactions-for-a-commit-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/reaction" } + }, + "examples": { + "default": { "$ref": "#/components/examples/reaction-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create reaction for a commit comment", + "description": "Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment.", + "tags": ["reactions"], + "operationId": "reactions/create-for-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#create-reaction-for-a-commit-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": ["content"] + }, + "example": { "content": "heart" } + } + } + }, + "responses": { + "200": { + "description": "Reaction exists", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/reaction" }, + "examples": { + "default": { "$ref": "#/components/examples/reaction" } + } + } + } + }, + "201": { + "description": "Reaction created", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/reaction" }, + "examples": { + "default": { "$ref": "#/components/examples/reaction" } + } + } + } + }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete a commit comment reaction", + "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments).", + "tags": ["reactions"], + "operationId": "reactions/delete-for-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#delete-a-commit-comment-reaction" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" }, + { "$ref": "#/components/parameters/reaction-id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/commits": { + "get": { + "summary": "List commits", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": ["repos"], + "operationId": "repos/list-commits", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-commits" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "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" } + }, + { + "name": "path", + "description": "Only commits containing this file path will be returned.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + { + "name": "author", + "description": "GitHub login or email address by which to filter by commit author.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + { "$ref": "#/components/parameters/since" }, + { + "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" } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/commit" } + }, + "examples": { + "default": { "$ref": "#/components/examples/commit-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "404": { "$ref": "#/components/responses/not_found" }, + "409": { "$ref": "#/components/responses/conflict" }, + "500": { "$ref": "#/components/responses/internal_error" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "commits" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + "get": { + "summary": "List branches for HEAD commit", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "tags": ["repos"], + "operationId": "repos/list-branches-for-head-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-branches-for-head-commit" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/commit_sha" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/branch-short" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/branch-short-items" + } + } + } + } + }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "groot", + "note": "Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/) for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.groot-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "commits" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + "get": { + "summary": "List commit comments", + "description": "Use the `:commit_sha` to specify the commit that will have its comments listed.", + "tags": ["repos"], + "operationId": "repos/list-comments-for-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-commit-comments" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/commit_sha" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/commit-comment" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-comment-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "repos", + "subcategory": "comments" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a commit comment", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "tags": ["repos"], + "operationId": "repos/create-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#create-a-commit-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/commit_sha" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The contents of the comment." + }, + "path": { + "type": "string", + "description": "Relative path of the file to comment on." + }, + "position": { + "type": "integer", + "description": "Line index in the diff to comment on." + }, + "line": { + "type": "integer", + "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on." + } + }, + "required": ["body"] + }, + "example": { + "body": "Great stuff", + "path": "file1.txt", + "position": 4, + "line": 1 + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/commit-comment" }, + "examples": { + "default": { "$ref": "#/components/examples/commit-comment" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/comments/1", + "schema": { "type": "string" } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "comments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + "get": { + "summary": "List pull requests associated with a commit", + "description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint.", + "tags": ["repos"], + "operationId": "repos/list-pull-requests-associated-with-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-pull-requests-associated-with-a-commit" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/commit_sha" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-simple-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "groot", + "note": "Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-04-11-pulls-branches-for-commit/) for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.groot-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "commits" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/commits/{ref}": { + "get": { + "summary": "Get a commit", + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nYou can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.\n\nTo return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": ["repos"], + "operationId": "repos/get-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-commit" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "ref", + "description": "ref+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/commit" }, + "examples": { + "default": { "$ref": "#/components/examples/commit" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" }, + "500": { "$ref": "#/components/responses/internal_error" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "commits" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + "get": { + "summary": "List check runs for a Git reference", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "tags": ["checks"], + "operationId": "checks/list-for-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "ref", + "description": "ref+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { "$ref": "#/components/parameters/check_name" }, + { "$ref": "#/components/parameters/status" }, + { + "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": ["latest", "all"], + "default": "latest" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "check_runs"], + "properties": { + "total_count": { "type": "integer" }, + "check_runs": { + "type": "array", + "items": { "$ref": "#/components/schemas/check-run" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "runs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + "get": { + "summary": "List check suites for a Git reference", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "tags": ["checks"], + "operationId": "checks/list-suites-for-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "ref", + "description": "ref+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "app_id", + "description": "Filters check suites by GitHub App `id`.", + "in": "query", + "required": false, + "schema": { "type": "integer" }, + "example": 1 + }, + { "$ref": "#/components/parameters/check_name" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "check_suites"], + "properties": { + "total_count": { "type": "integer" }, + "check_suites": { + "type": "array", + "items": { "$ref": "#/components/schemas/check-suite" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-suite-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "suites" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/commits/{ref}/status": { + "get": { + "summary": "Get the combined status for a specific reference", + "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`", + "tags": ["repos"], + "operationId": "repos/get-combined-status-for-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-the-combined-status-for-a-specific-reference" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "ref", + "description": "ref+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/combined-commit-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/combined-commit-status" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "statuses" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/commits/{ref}/statuses": { + "get": { + "summary": "List commit statuses for a reference", + "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.", + "tags": ["repos"], + "operationId": "repos/list-commit-statuses-for-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-commit-statuses-for-a-reference" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "ref", + "description": "ref+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/status" } + }, + "examples": { + "default": { "$ref": "#/components/examples/status-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "301": { "$ref": "#/components/responses/moved_permanently" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "statuses" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/community/code_of_conduct": { + "get": { + "summary": "Get the code of conduct for a repository", + "description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.", + "tags": ["codes-of-conduct"], + "operationId": "codes-of-conduct/get-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/codes_of_conduct/#get-the-code-of-conduct-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/code-of-conduct" }, + "examples": { + "default": { + "$ref": "#/components/examples/code-of-conduct-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "scarlet-witch", + "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```" + } + ], + "category": "codes-of-conduct", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/community/profile": { + "get": { + "summary": "Get community profile metrics", + "description": "This endpoint will return all community profile metrics, including an\noverall health score, repository description, the presence of documentation, detected\ncode of conduct, detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe `health_percentage` is `100`. If only one is present, then the\n`health_percentage` is `25`.\n\n`content_reports_enabled` is only returned for organization-owned repositories.", + "tags": ["repos"], + "operationId": "repos/get-community-profile-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-community-profile-metrics" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/community-profile" }, + "examples": { + "default": { + "$ref": "#/components/examples/community-profile" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "community" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/compare/{base}...{head}": { + "get": { + "summary": "Compare two commits", + "description": "Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) to enumerate all commits in the range.\n\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": ["repos"], + "operationId": "repos/compare-commits", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#compare-two-commits" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "base", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "head", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/commit-comparison" }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-comparison" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "500": { "$ref": "#/components/responses/internal_error" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "commits" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/contents/{path}": { + "get": { + "summary": "Get repository content", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", + "tags": ["repos"], + "operationId": "repos/get-content", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-repository-content" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "path", + "description": "path+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "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" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/vnd.github.v3.object": { + "schema": { "$ref": "#/components/schemas/content-tree" } + }, + "application/json": { + "schema": { + "oneOf": [ + { "$ref": "#/components/schemas/content-directory" }, + { "$ref": "#/components/schemas/content-file" }, + { "$ref": "#/components/schemas/content-symlink" }, + { "$ref": "#/components/schemas/content-submodule" } + ] + }, + "examples": { + "response-if-content-is-a-file": { + "$ref": "#/components/examples/content-file-response-if-content-is-a-file" + }, + "response-if-content-is-a-directory": { + "$ref": "#/components/examples/content-file-response-if-content-is-a-directory" + }, + "response-if-content-is-a-symlink": { + "$ref": "#/components/examples/content-file-response-if-content-is-a-symlink" + }, + "response-if-content-is-a-submodule": { + "$ref": "#/components/examples/content-file-response-if-content-is-a-submodule" + } + } + } + } + }, + "302": { "$ref": "#/components/responses/found" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "x-octokit": {} + }, + "put": { + "summary": "Create or update file contents", + "description": "Creates a new file or replaces an existing file in a repository.", + "tags": ["repos"], + "operationId": "repos/create-or-update-file-contents", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#create-or-update-file-contents" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "path", + "description": "path+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The commit message." + }, + "content": { + "type": "string", + "description": "The new file content, using Base64 encoding." + }, + "sha": { + "type": "string", + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced." + }, + "branch": { + "type": "string", + "description": "The branch name. Default: the repository’s default branch (usually `master`)" + }, + "committer": { + "type": "object", + "description": "The person that committed the file. Default: the authenticated user.", + "properties": { + "name": { + "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": { + "type": "string", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted." + }, + "date": { + "type": "string", + "example": "\"2013-01-05T13:13:22+05:00\"" + } + }, + "required": ["name", "email"] + }, + "author": { + "type": "object", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "properties": { + "name": { + "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": { + "type": "string", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted." + }, + "date": { + "type": "string", + "example": "\"2013-01-15T17:13:22+05:00\"" + } + }, + "required": ["name", "email"] + } + }, + "required": ["message", "content"] + }, + "examples": { + "example-for-creating-a-file": { + "summary": "Example for creating a file", + "value": { + "message": "my commit message", + "committer": { + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "content": "bXkgbmV3IGZpbGUgY29udGVudHM=" + } + }, + "example-for-updating-a-file": { + "summary": "Example for updating a file", + "value": { + "message": "a new commit message", + "committer": { + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "content": "bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz", + "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/file-commit" }, + "examples": { + "example-for-updating-a-file": { + "$ref": "#/components/examples/file-commit-example-for-updating-a-file" + } + } + } + } + }, + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/file-commit" }, + "examples": { + "example-for-creating-a-file": { + "$ref": "#/components/examples/file-commit-example-for-creating-a-file" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "409": { "$ref": "#/components/responses/conflict" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a file", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", + "tags": ["repos"], + "operationId": "repos/delete-file", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-a-file" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "path", + "description": "path+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The commit message." + }, + "sha": { + "type": "string", + "description": "The blob SHA of the file being replaced." + }, + "branch": { + "type": "string", + "description": "The branch name. Default: the repository’s default branch (usually `master`)" + }, + "committer": { + "type": "object", + "description": "object containing information about the committer.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author (or committer) of the commit" + }, + "email": { + "type": "string", + "description": "The email of the author (or committer) of the commit" + } + } + }, + "author": { + "type": "object", + "description": "object containing information about the author.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author (or committer) of the commit" + }, + "email": { + "type": "string", + "description": "The email of the author (or committer) of the commit" + } + } + } + }, + "required": ["message", "sha"] + }, + "example": { + "message": "my commit message", + "committer": { + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "sha": "329688480d39049927147c162b9d2deaf885005f" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/file-commit" }, + "examples": { + "default": { "$ref": "#/components/examples/file-commit" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "409": { "$ref": "#/components/responses/conflict" }, + "422": { "$ref": "#/components/responses/validation_failed" }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/contributors": { + "get": { + "summary": "List repository contributors", + "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", + "tags": ["repos"], + "operationId": "repos/list-contributors", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#list-repository-contributors" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "anon", + "description": "Set to `1` or `true` to include anonymous contributors in results.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "Response if repository contains content", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/contributor" } + }, + "examples": { + "response-if-repository-contains-content": { + "$ref": "#/components/examples/contributor-items-response-if-repository-contains-content" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "204": { "description": "Response if repository is empty" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/deployments": { + "get": { + "summary": "List deployments", + "description": "Simple filtering of deployments is available via query parameters:", + "tags": ["repos"], + "operationId": "repos/list-deployments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-deployments" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "sha", + "description": "The SHA recorded at creation time.", + "in": "query", + "required": false, + "schema": { "type": "string", "default": "none" } + }, + { + "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" } + }, + { + "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" } + }, + { + "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" } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/deployment" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "ant-man", + "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "deployments" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a deployment", + "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/rest/reference/repos#statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", + "tags": ["repos"], + "operationId": "repos/create-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#create-a-deployment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The ref to deploy. This can be a branch, tag, or SHA." + }, + "task": { + "type": "string", + "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", + "default": "deploy" + }, + "auto_merge": { + "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": { + "type": "array", + "description": "The [status](https://docs.github.com/rest/reference/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": { + "type": "string", + "description": "JSON payload with extra information about the deployment.", + "default": "" + }, + "environment": { + "type": "string", + "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", + "default": "production" + }, + "description": { + "type": "string", + "description": "Short description of the deployment.", + "default": "", + "nullable": true + }, + "transient_environment": { + "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://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type.", + "default": false + }, + "production_environment": { + "type": "boolean", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type." + }, + "created_at": { + "type": "string", + "example": "\"1776-07-04T00:00:00.000-07:52\"" + } + }, + "required": ["ref"] + }, + "examples": { + "simple-example": { + "summary": "Simple example", + "value": { + "ref": "topic-branch", + "payload": "{ \"deploy\": \"migrate\" }", + "description": "Deploy request from hubot" + } + }, + "advanced-example": { + "summary": "Advanced example", + "value": { + "ref": "topic-branch", + "auto_merge": false, + "payload": "{ \"deploy\": \"migrate\" }", + "description": "Deploy request from hubot", + "required_contexts": ["ci/janky", "security/brakeman"] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/deployment" }, + "examples": { + "simple-example": { + "$ref": "#/components/examples/deployment-simple-example" + }, + "advanced-example": { + "$ref": "#/components/examples/deployment-advanced-example" + } + } + } + } + }, + "202": { + "description": "Merged branch response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { "message": { "type": "string" } } + }, + "examples": { + "merged-branch-response": { + "value": { + "message": "Auto-merged master into topic-branch on deployment." + } + } + } + } + } + }, + "409": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { + "type": "string", + "example": "\"https://docs.github.com/rest/reference/repos#create-a-deployment\"" + } + } + }, + "examples": { + "merge-conflict-response": { + "summary": "Merge conflict response", + "value": { + "message": "Conflict merging master into topic-branch" + } + }, + "failed-commit-status-checks": { + "summary": "Failed commit status checks", + "value": { + "message": "Conflict: Commit status checks failed for topic-branch." + } + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "ant-man", + "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "deployments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/deployments/{deployment_id}": { + "get": { + "summary": "Get a deployment", + "description": "", + "tags": ["repos"], + "operationId": "repos/get-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-deployment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/deployment_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/deployment" }, + "examples": { + "default": { "$ref": "#/components/examples/deployment" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "ant-man", + "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "deployments" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a deployment", + "description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status).\"", + "tags": ["repos"], + "operationId": "repos/delete-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-a-deployment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/deployment_id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "deployments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + "get": { + "summary": "List deployment statuses", + "description": "Users with pull access can view deployment statuses for a deployment:", + "tags": ["repos"], + "operationId": "repos/list-deployment-statuses", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-deployment-statuses" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/deployment_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/deployment-status" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-status-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "flash", + "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```" + }, + { + "required": false, + "name": "ant-man", + "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "deployments" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a deployment status", + "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nGitHub Apps require `read & write` access to \"Deployments\" and `read-only` access to \"Repo contents\" (for private repos). OAuth Apps require the `repo_deployment` scope.", + "tags": ["repos"], + "operationId": "repos/create-deployment-status", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#create-a-deployment-status" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/deployment_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "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://docs.github.com/rest/overview/api-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://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", + "enum": [ + "error", + "failure", + "inactive", + "in_progress", + "queued", + "pending", + "success" + ] + }, + "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": { + "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://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type.", + "default": "" + }, + "description": { + "type": "string", + "description": "A short description of the status. The maximum description length is 140 characters.", + "default": "" + }, + "environment": { + "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://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type.", + "enum": ["production", "staging", "qa"] + }, + "environment_url": { + "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://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type.", + "default": "" + }, + "auto_inactive": { + "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://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type." + } + }, + "required": ["state"] + }, + "example": { + "environment": "production", + "state": "success", + "log_url": "https://example.com/deployment/42/output", + "description": "Deployment finished successfully." + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/deployment-status" }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-status" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", + "schema": { "type": "string" } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "flash", + "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```" + }, + { + "required": false, + "name": "ant-man", + "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "deployments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + "get": { + "summary": "Get a deployment status", + "description": "Users with pull access can view a deployment status for a deployment:", + "tags": ["repos"], + "operationId": "repos/get-deployment-status", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-deployment-status" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/deployment_id" }, + { + "name": "status_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/deployment-status" }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-status" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "flash", + "note": "New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details.\n\nTo access the new `environment` parameter, the two new values for the `state` parameter (`in_progress` and `queued`), and use `auto_inactive` on production deployments during the public beta period, you must provide the following custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.flash-preview+json\n```" + }, + { + "required": false, + "name": "ant-man", + "note": "The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.ant-man-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "deployments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/dispatches": { + "post": { + "summary": "Create a repository dispatch event", + "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nTo give you write access to the repository, you must use a personal access token with the `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", + "tags": ["repos"], + "operationId": "repos/create-dispatch-event", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#create-a-repository-dispatch-event" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["event_type"], + "properties": { + "event_type": { + "type": "string", + "description": "A custom webhook event name." + }, + "client_payload": { + "type": "object", + "description": "JSON payload with extra information about the webhook event that your action or worklow may use.", + "additionalProperties": true + } + } + }, + "example": { + "event_type": "on-demand-test", + "client_payload": { "unit": false, "integration": true } + } + } + } + }, + "responses": { + "204": { "description": "Empty response" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/events": { + "get": { + "summary": "List repository events", + "description": "", + "tags": ["activity"], + "operationId": "activity/list-repo-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-repository-events" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/event" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/forks": { + "get": { + "summary": "List forks", + "description": "", + "tags": ["repos"], + "operationId": "repos/list-forks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-forks" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "sort", + "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["newest", "oldest", "stargazers"], + "default": "newest" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/minimal-repository" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items-2" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "400": { "$ref": "#/components/responses/bad_request" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "forks" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a fork", + "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com).", + "tags": ["repos"], + "operationId": "repos/create-fork", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#create-a-fork" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "organization": { + "type": "string", + "description": "Optional parameter to specify the organization name if forking into an organization." + } + } + } + } + } + }, + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/repository" }, + "examples": { + "default": { "$ref": "#/components/examples/repository" } + } + } + } + }, + "400": { "$ref": "#/components/responses/bad_request" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "forks" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/git/blobs": { + "post": { + "summary": "Create a blob", + "description": "", + "tags": ["git"], + "operationId": "git/create-blob", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#create-a-blob" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The new blob's content." + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" + } + }, + "required": ["content"] + }, + "example": { + "content": "Content of the blob", + "encoding": "utf-8" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/short-blob" }, + "examples": { + "default": { "$ref": "#/components/examples/short-blob" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "schema": { "type": "string" } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "409": { "$ref": "#/components/responses/conflict" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "blobs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + "get": { + "summary": "Get a blob", + "description": "The `content` in the response will always be Base64 encoded.\n\n_Note_: This API supports blobs up to 100 megabytes in size.", + "tags": ["git"], + "operationId": "git/get-blob", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#get-a-blob" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "file_sha", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/blob" }, + "examples": { + "default": { "$ref": "#/components/examples/blob" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "blobs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/git/commits": { + "post": { + "summary": "Create a commit", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": ["git"], + "operationId": "git/create-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#create-a-commit" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The commit message" + }, + "tree": { + "type": "string", + "description": "The SHA of the tree object this commit points to" + }, + "parents": { + "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": { + "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": { + "type": "string", + "description": "The name of the author (or committer) of the commit" + }, + "email": { + "type": "string", + "description": "The email of the author (or committer) of the commit" + }, + "date": { + "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": { + "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": { + "type": "string", + "description": "The name of the author (or committer) of the commit" + }, + "email": { + "type": "string", + "description": "The email of the author (or committer) of the commit" + }, + "date": { + "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": { + "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": ["message", "tree"] + }, + "example": { + "message": "my commit message", + "author": { + "name": "Mona Octocat", + "email": "octocat@github.com", + "date": "2008-07-09T16:13:30+12:00" + }, + "parents": ["7d1b31e74ee336d15cbd21741bc88a537ed063a0"], + "tree": "827efc6d56897b048c772eb4087f854f46256132", + "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/git-commit" }, + "examples": { + "default": { "$ref": "#/components/examples/git-commit" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "schema": { "type": "string" } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "commits" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + "get": { + "summary": "Get a commit", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": ["git"], + "operationId": "git/get-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#get-a-commit" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/commit_sha" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/git-commit" }, + "examples": { + "default": { "$ref": "#/components/examples/git-commit-2" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "commits" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + "get": { + "summary": "List matching references", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "tags": ["git"], + "operationId": "git/list-matching-refs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#list-matching-references" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "ref", + "description": "ref+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/git-ref" } + }, + "examples": { + "default": { "$ref": "#/components/examples/git-ref-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "refs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/git/ref/{ref}": { + "get": { + "summary": "Get a reference", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "tags": ["git"], + "operationId": "git/get-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#get-a-reference" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "ref", + "description": "ref+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/git-ref" }, + "examples": { + "default": { "$ref": "#/components/examples/git-ref" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "refs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/git/refs": { + "post": { + "summary": "Create a reference", + "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", + "tags": ["git"], + "operationId": "git/create-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#create-a-reference" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "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": { + "type": "string", + "description": "The SHA1 value for this reference." + }, + "key": { + "type": "string", + "example": "\"refs/heads/newbranch\"" + } + }, + "required": ["ref", "sha"] + }, + "example": { + "ref": "refs/heads/featureA", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/git-ref" }, + "examples": { + "default": { "$ref": "#/components/examples/git-ref" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", + "schema": { "type": "string" } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "refs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/git/refs/{ref}": { + "patch": { + "summary": "Update a reference", + "description": "", + "tags": ["git"], + "operationId": "git/update-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#update-a-reference" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "ref", + "description": "ref+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "description": "The SHA1 value to set this reference to" + }, + "force": { + "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 + } + }, + "required": ["sha"] + }, + "example": { + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "force": true + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/git-ref" }, + "examples": { + "default": { "$ref": "#/components/examples/git-ref" } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "refs" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a reference", + "description": "", + "tags": ["git"], + "operationId": "git/delete-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#delete-a-reference" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "ref", + "description": "ref+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "204": { "description": "Empty response" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "refs" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/git/tags": { + "post": { + "summary": "Create a tag object", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": ["git"], + "operationId": "git/create-tag", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#create-a-tag-object" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag": { + "type": "string", + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\")." + }, + "message": { + "type": "string", + "description": "The tag message." + }, + "object": { + "type": "string", + "description": "The SHA of the git object this is tagging." + }, + "type": { + "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", "blob"] + }, + "tagger": { + "type": "object", + "description": "An object with information about the individual creating the tag.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author of the tag" + }, + "email": { + "type": "string", + "description": "The email of the author of the tag" + }, + "date": { + "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`." + } + } + } + }, + "required": ["tag", "message", "object", "type"] + }, + "example": { + "tag": "v0.0.1", + "message": "initial version", + "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", + "type": "commit", + "tagger": { + "name": "Monalisa Octocat", + "email": "octocat@github.com", + "date": "2011-06-17T14:53:35-07:00" + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/git-tag" }, + "examples": { + "default": { "$ref": "#/components/examples/git-tag" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "schema": { "type": "string" } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "tags" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + "get": { + "summary": "Get a tag", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": ["git"], + "operationId": "git/get-tag", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#get-a-tag" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "tag_sha", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/git-tag" }, + "examples": { + "default": { "$ref": "#/components/examples/git-tag" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "tags" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/git/trees": { + "post": { + "summary": "Create a tree", + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference).\"", + "tags": ["git"], + "operationId": "git/create-tree", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#create-a-tree" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tree": { + "type": "array", + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file referenced in the tree." + }, + "mode": { + "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", + "040000", + "160000", + "120000" + ] + }, + "type": { + "type": "string", + "description": "Either `blob`, `tree`, or `commit`.", + "enum": ["blob", "tree", "commit"] + }, + "sha": { + "type": "string", + "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", + "nullable": true + }, + "content": { + "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": { + "type": "string", + "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n" + } + }, + "required": ["tree"] + }, + "example": { + "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", + "tree": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "sha": "44b4fc6d56897b048c772eb4087f854f46256132" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/git-tree" }, + "examples": { + "default": { "$ref": "#/components/examples/git-tree" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", + "schema": { "type": "string" } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "trees" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + "get": { + "summary": "Get a tree", + "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.", + "tags": ["git"], + "operationId": "git/get-tree", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/git#get-a-tree" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "tree_sha", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "recursive", + "description": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `\"true\"`, and `\"false\"`. Omit this parameter to prevent recursively returning objects or subtrees.", + "in": "query", + "required": false, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/git-tree" }, + "examples": { + "default-response": { + "$ref": "#/components/examples/git-tree-default-response" + }, + "response-recursively-retrieving-a-tree": { + "$ref": "#/components/examples/git-tree-response-recursively-retrieving-a-tree" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "git", + "subcategory": "trees" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/hooks": { + "get": { + "summary": "List repository webhooks", + "description": "", + "tags": ["repos"], + "operationId": "repos/list-webhooks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-repository-webhooks" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/hook" } + }, + "examples": { + "default": { "$ref": "#/components/examples/hook-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a repository webhook", + "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.", + "tags": ["repos"], + "operationId": "repos/create-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#create-a-repository-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`." + }, + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params).", + "properties": { + "url": { + "$ref": "#/components/schemas/webhook-config-url" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + }, + "token": { "type": "string", "example": "\"abc\"" }, + "digest": { "type": "string", "example": "\"sha256\"" } + }, + "required": ["url"] + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", + "default": ["push"], + "items": { "type": "string" } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + } + }, + "required": ["config"] + }, + "example": { + "name": "web", + "active": true, + "events": ["push", "pull_request"], + "config": { + "url": "https://example.com/webhook", + "content_type": "json", + "insecure_ssl": "0" + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/hook" }, + "examples": { + "default": { "$ref": "#/components/examples/hook" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "schema": { "type": "string" } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}": { + "get": { + "summary": "Get a repository webhook", + "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository).\"", + "tags": ["repos"], + "operationId": "repos/get-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-repository-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/hook" }, + "examples": { + "default": { "$ref": "#/components/examples/hook" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a repository webhook", + "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository).\"", + "tags": ["repos"], + "operationId": "repos/update-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#update-a-repository-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params).", + "properties": { + "url": { + "$ref": "#/components/schemas/webhook-config-url" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + }, + "address": { + "type": "string", + "example": "\"bar@example.com\"" + }, + "room": { + "type": "string", + "example": "\"The Serious Room\"" + } + }, + "required": ["url"] + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", + "default": ["push"], + "items": { "type": "string" } + }, + "add_events": { + "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": { + "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": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + } + } + }, + "example": { "active": true, "add_events": ["pull_request"] } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/hook" }, + "examples": { + "default": { "$ref": "#/components/examples/hook" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a repository webhook", + "description": "", + "tags": ["repos"], + "operationId": "repos/delete-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-a-repository-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + "get": { + "summary": "Get a webhook configuration for a repository", + "description": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook).\"\n\nAccess tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission.", + "tags": ["repos"], + "operationId": "repos/get-webhook-config-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos#get-a-webhook-configuration-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/webhook-config" }, + "examples": { + "default": { "$ref": "#/components/examples/webhook-config" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a webhook configuration for a repository", + "description": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook).\"\n\nAccess tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission.", + "tags": ["repos"], + "operationId": "repos/update-webhook-config-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos#update-a-webhook-configuration-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "url": { "$ref": "#/components/schemas/webhook-config-url" }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + } + }, + "example": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } + } + } + } + }, + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/webhook-config" }, + "examples": { + "default": { "$ref": "#/components/examples/webhook-config" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + "post": { + "summary": "Ping a repository webhook", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", + "tags": ["repos"], + "operationId": "repos/ping-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#ping-a-repository-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + "post": { + "summary": "Test the push repository webhook", + "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", + "tags": ["repos"], + "operationId": "repos/test-push-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#test-the-push-repository-webhook" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/hook-id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "webhooks" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/import": { + "get": { + "summary": "Get an import status", + "description": "View the progress of an import.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", + "tags": ["migrations"], + "operationId": "migrations/get-import-status", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#get-an-import-status" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/import" }, + "examples": { + "default": { "$ref": "#/components/examples/import" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "migrations", + "subcategory": "source-imports" + }, + "x-octokit": {} + }, + "put": { + "summary": "Start an import", + "description": "Start a source import to a GitHub repository using GitHub Importer.", + "tags": ["migrations"], + "operationId": "migrations/start-import", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#start-an-import" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "vcs_url": { + "type": "string", + "description": "The URL of the originating repository." + }, + "vcs": { + "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", "mercurial", "tfvc"] + }, + "vcs_username": { + "type": "string", + "description": "If authentication is required, the username to provide to `vcs_url`." + }, + "vcs_password": { + "type": "string", + "description": "If authentication is required, the password to provide to `vcs_url`." + }, + "tfvc_project": { + "type": "string", + "description": "For a tfvc import, the name of the project that is being imported." + } + }, + "required": ["vcs_url"] + }, + "example": { + "vcs": "subversion", + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "vcs_username": "octocat", + "vcs_password": "secret" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/import" }, + "examples": { + "default": { "$ref": "#/components/examples/import-2" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/spraints/socm/import", + "schema": { "type": "string" } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "migrations", + "subcategory": "source-imports" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an import", + "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.", + "tags": ["migrations"], + "operationId": "migrations/update-import", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#update-an-import" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "vcs_username": { + "type": "string", + "description": "The username to provide to the originating repository." + }, + "vcs_password": { + "type": "string", + "description": "The password to provide to the originating repository." + }, + "vcs": { "type": "string", "example": "\"git\"" }, + "tfvc_project": { + "type": "string", + "example": "\"project1\"" + } + } + }, + "examples": { + "example-1": { + "summary": "Example 1", + "value": { + "vcs_username": "octocat", + "vcs_password": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/import" }, + "examples": { + "example-1": { + "$ref": "#/components/examples/import-example-1" + }, + "example-2": { + "$ref": "#/components/examples/import-example-2" + }, + "response": { + "$ref": "#/components/examples/import-response" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "migrations", + "subcategory": "source-imports" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Cancel an import", + "description": "Stop an import for a repository.", + "tags": ["migrations"], + "operationId": "migrations/cancel-import", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#cancel-an-import" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "migrations", + "subcategory": "source-imports" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/import/authors": { + "get": { + "summary": "Get commit authors", + "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information.", + "tags": ["migrations"], + "operationId": "migrations/get-commit-authors", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#get-commit-authors" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/since-user" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/porter-author" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/porter-author-items" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "migrations", + "subcategory": "source-imports" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/import/authors/{author_id}": { + "patch": { + "summary": "Map a commit author", + "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.", + "tags": ["migrations"], + "operationId": "migrations/map-commit-author", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#map-a-commit-author" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "author_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "The new Git author email." + }, + "name": { + "type": "string", + "description": "The new Git author name." + }, + "remote_id": { + "type": "string", + "example": "\"can't touch this\"" + } + } + }, + "example": { + "email": "hubot@github.com", + "name": "Hubot the Robot" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/porter-author" }, + "examples": { + "default": { "$ref": "#/components/examples/porter-author" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "migrations", + "subcategory": "source-imports" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/import/large_files": { + "get": { + "summary": "Get large files", + "description": "List files larger than 100MB found during the import", + "tags": ["migrations"], + "operationId": "migrations/get-large-files", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#get-large-files" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/porter-large-file" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/porter-large-file-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "migrations", + "subcategory": "source-imports" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/import/lfs": { + "patch": { + "summary": "Update Git LFS preference", + "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/).", + "tags": ["migrations"], + "operationId": "migrations/set-lfs-preference", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#update-git-lfs-preference" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "use_lfs": { + "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"] + } + }, + "required": ["use_lfs"] + }, + "example": { "use_lfs": "opt_in" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/import" }, + "examples": { + "default": { "$ref": "#/components/examples/import" } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "migrations", + "subcategory": "source-imports" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/installation": { + "get": { + "summary": "Get a repository installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/get-repo-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps/#get-a-repository-installation-for-the-authenticated-app" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/installation" }, + "examples": { + "default": { "$ref": "#/components/examples/installation" } + } + } + } + }, + "301": { "$ref": "#/components/responses/moved_permanently" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/interaction-limits": { + "get": { + "summary": "Get interaction restrictions for a repository", + "description": "Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.", + "tags": ["interactions"], + "operationId": "interactions/get-restrictions-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interaction-limit-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/interaction-limit-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "interactions", + "subcategory": "repos" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set interaction restrictions for a repository", + "description": "Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", + "tags": ["interactions"], + "operationId": "interactions/set-restrictions-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/interaction-limit" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interaction-limit-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/interaction-limit-2" + } + } + } + } + }, + "409": { "description": "Conflict" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "interactions", + "subcategory": "repos" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove interaction restrictions for a repository", + "description": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", + "tags": ["interactions"], + "operationId": "interactions/remove-restrictions-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "204": { "description": "Empty response" }, + "409": { "description": "Conflict" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "interactions", + "subcategory": "repos" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/invitations": { + "get": { + "summary": "List repository invitations", + "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.", + "tags": ["repos"], + "operationId": "repos/list-invitations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-repository-invitations" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-invitation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-invitation-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "invitations" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/invitations/{invitation_id}": { + "patch": { + "summary": "Update a repository invitation", + "description": "", + "tags": ["repos"], + "operationId": "repos/update-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#update-a-repository-invitation" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/invitation_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permissions": { + "type": "string", + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", + "enum": ["read", "write", "maintain", "triage", "admin"] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-invitation" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-invitation" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "invitations" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a repository invitation", + "description": "", + "tags": ["repos"], + "operationId": "repos/delete-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-a-repository-invitation" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/invitation_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "invitations" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues": { + "get": { + "summary": "List repository issues", + "description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", + "tags": ["issues"], + "operationId": "issues/list-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/issues/#list-repository-issues" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "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" } + }, + { + "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": ["open", "closed", "all"], + "default": "open" + } + }, + { + "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" } + }, + { + "name": "creator", + "description": "The user that created the issue.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + { + "name": "mentioned", + "description": "A user that's mentioned in the issue.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + { "$ref": "#/components/parameters/labels" }, + { + "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["created", "updated", "comments"], + "default": "created" + } + }, + { "$ref": "#/components/parameters/direction" }, + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/issue-simple" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-simple-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "301": { "$ref": "#/components/responses/moved_permanently" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "issues", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an issue", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "tags": ["issues"], + "operationId": "issues/create", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/issues/#create-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the issue." + }, + "body": { + "type": "string", + "description": "The contents of the issue." + }, + "assignee": { + "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.**_", + "nullable": true + }, + "milestone": { + "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._", + "nullable": true + }, + "labels": { + "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": { + "oneOf": [ + { "type": "string" }, + { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "name": { "type": "string" }, + "description": { "type": "string" }, + "color": { "type": "string" } + } + } + ] + } + }, + "assignees": { + "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" } + } + }, + "required": ["title"] + }, + "example": { + "title": "Found a bug", + "body": "I'm having a problem with this.", + "assignees": ["octocat"], + "milestone": 1, + "labels": ["bug"] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/issue" }, + "examples": { + "default": { "$ref": "#/components/examples/issue" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "schema": { "type": "string" } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" }, + "422": { "$ref": "#/components/responses/validation_failed" }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/comments": { + "get": { + "summary": "List issue comments for a repository", + "description": "By default, Issue Comments are ordered by ascending ID.", + "tags": ["issues"], + "operationId": "issues/list-comments-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#list-issue-comments-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/sort" }, + { + "name": "direction", + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", + "in": "query", + "required": false, + "schema": { "type": "string", "enum": ["asc", "desc"] } + }, + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/issue-comment" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-comment-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "issues", + "subcategory": "comments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + "get": { + "summary": "Get an issue comment", + "description": "", + "tags": ["issues"], + "operationId": "issues/get-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#get-an-issue-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/issue-comment" }, + "examples": { + "default": { "$ref": "#/components/examples/issue-comment" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "issues", + "subcategory": "comments" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an issue comment", + "description": "", + "tags": ["issues"], + "operationId": "issues/update-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#update-an-issue-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The contents of the comment." + } + }, + "required": ["body"] + }, + "example": { "body": "Me too" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/issue-comment" }, + "examples": { + "default": { "$ref": "#/components/examples/issue-comment" } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "comments" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an issue comment", + "description": "", + "tags": ["issues"], + "operationId": "issues/delete-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#delete-an-issue-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "comments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + "get": { + "summary": "List reactions for an issue comment", + "description": "List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments).", + "tags": ["reactions"], + "operationId": "reactions/list-for-issue-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#list-reactions-for-an-issue-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/reaction" } + }, + "examples": { + "default": { "$ref": "#/components/examples/reaction-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create reaction for an issue comment", + "description": "Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment.", + "tags": ["reactions"], + "operationId": "reactions/create-for-issue-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#create-reaction-for-an-issue-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": ["content"] + }, + "example": { "content": "heart" } + } + } + }, + "responses": { + "200": { + "description": "Reaction exists", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/reaction" }, + "examples": { + "default": { "$ref": "#/components/examples/reaction" } + } + } + } + }, + "201": { + "description": "Reaction created", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/reaction" }, + "examples": { + "default": { "$ref": "#/components/examples/reaction" } + } + } + } + }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete an issue comment reaction", + "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments).", + "tags": ["reactions"], + "operationId": "reactions/delete-for-issue-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#delete-an-issue-comment-reaction" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" }, + { "$ref": "#/components/parameters/reaction-id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/events": { + "get": { + "summary": "List issue events for a repository", + "description": "", + "tags": ["issues"], + "operationId": "issues/list-events-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#list-issue-events-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/issue-event" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-event-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "starfox", + "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" + } + ], + "category": "issues", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/events/{event_id}": { + "get": { + "summary": "Get an issue event", + "description": "", + "tags": ["issues"], + "operationId": "issues/get-event", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#get-an-issue-event" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "event_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/issue-event" }, + "examples": { + "default": { "$ref": "#/components/examples/issue-event" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "starfox", + "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" + } + ], + "category": "issues", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}": { + "get": { + "summary": "Get an issue", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", + "tags": ["issues"], + "operationId": "issues/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/issues/#get-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/issue" }, + "examples": { + "default": { "$ref": "#/components/examples/issue" } + } + } + } + }, + "301": { "$ref": "#/components/responses/moved_permanently" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "issues", + "subcategory": null + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an issue", + "description": "Issue owners and users with push access can edit an issue.", + "tags": ["issues"], + "operationId": "issues/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/issues/#update-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the issue." + }, + "body": { + "type": "string", + "description": "The contents of the issue." + }, + "assignee": { + "type": "string", + "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**" + }, + "state": { + "type": "string", + "description": "State of the issue. Either `open` or `closed`.", + "enum": ["open", "closed"] + }, + "milestone": { + "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": { + "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": { + "oneOf": [ + { "type": "string" }, + { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "name": { "type": "string" }, + "description": { "type": "string" }, + "color": { "type": "string" } + } + } + ] + } + }, + "assignees": { + "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" } + } + } + }, + "example": { + "title": "Found a bug", + "body": "I'm having a problem with this.", + "assignees": ["octocat"], + "milestone": 1, + "state": "open", + "labels": ["bug"] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/issue" }, + "examples": { + "default": { "$ref": "#/components/examples/issue" } + } + } + } + }, + "301": { "$ref": "#/components/responses/moved_permanently" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" }, + "422": { "$ref": "#/components/responses/validation_failed" }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + "post": { + "summary": "Add assignees to an issue", + "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", + "tags": ["issues"], + "operationId": "issues/add-assignees", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#add-assignees-to-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignees": { + "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" } + } + } + }, + "example": { "assignees": ["hubot", "other_user"] } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/issue-simple" }, + "examples": { + "default": { "$ref": "#/components/examples/issue-simple" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "assignees" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove assignees from an issue", + "description": "Removes one or more assignees from an issue.", + "tags": ["issues"], + "operationId": "issues/remove-assignees", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignees": { + "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" } + } + } + }, + "example": { "assignees": ["hubot", "other_user"] } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/issue-simple" }, + "examples": { + "default": { "$ref": "#/components/examples/issue-simple" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "assignees" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + "get": { + "summary": "List issue comments", + "description": "Issue Comments are ordered by ascending ID.", + "tags": ["issues"], + "operationId": "issues/list-comments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#list-issue-comments" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" }, + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/issue-comment" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-comment-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "issues", + "subcategory": "comments" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an issue comment", + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "tags": ["issues"], + "operationId": "issues/create-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#create-an-issue-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The contents of the comment." + } + }, + "required": ["body"] + }, + "example": { "body": "Me too" } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/issue-comment" }, + "examples": { + "default": { "$ref": "#/components/examples/issue-comment" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "schema": { "type": "string" } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "comments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/events": { + "get": { + "summary": "List issue events", + "description": "", + "tags": ["issues"], + "operationId": "issues/list-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#list-issue-events" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-event-for-issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-event-for-issue-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "410": { "$ref": "#/components/responses/gone" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "starfox", + "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" + } + ], + "category": "issues", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + "get": { + "summary": "List labels for an issue", + "description": "", + "tags": ["issues"], + "operationId": "issues/list-labels-on-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#list-labels-for-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/label" } + }, + "examples": { + "default": { "$ref": "#/components/examples/label-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "410": { "$ref": "#/components/responses/gone" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "labels" + }, + "x-octokit": {} + }, + "post": { + "summary": "Add labels to an issue", + "description": "", + "tags": ["issues"], + "operationId": "issues/add-labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#add-labels-to-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "labels": { + "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" } + } + }, + "required": ["labels"] + }, + "example": { "labels": ["bug", "enhancement"] } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/label" } + }, + "examples": { + "default": { "$ref": "#/components/examples/label-items" } + } + } + } + }, + "410": { "$ref": "#/components/responses/gone" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "labels" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set labels for an issue", + "description": "Removes any previous labels and sets the new labels for an issue.", + "tags": ["issues"], + "operationId": "issues/set-labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#set-labels-for-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "labels": { + "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" } + } + } + }, + "example": { "labels": ["bug", "enhancement"] } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/label" } + }, + "examples": { + "default": { "$ref": "#/components/examples/label-items" } + } + } + } + }, + "410": { "$ref": "#/components/responses/gone" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "labels" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove all labels from an issue", + "description": "", + "tags": ["issues"], + "operationId": "issues/remove-all-labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#remove-all-labels-from-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" } + ], + "responses": { + "204": { "description": "Empty response" }, + "410": { "$ref": "#/components/responses/gone" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "labels" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + "delete": { + "summary": "Remove a label from an issue", + "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", + "tags": ["issues"], + "operationId": "issues/remove-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#remove-a-label-from-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/label" } + }, + "examples": { + "default": { "$ref": "#/components/examples/label-items-2" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "labels" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + "put": { + "summary": "Lock an issue", + "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "tags": ["issues"], + "operationId": "issues/lock", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/issues/#lock-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "lock_reason": { + "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", "resolved", "spam"] + } + } + } + } + } + }, + "responses": { + "204": { "description": "Empty response" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Unlock an issue", + "description": "Users with push access can unlock an issue's conversation.", + "tags": ["issues"], + "operationId": "issues/unlock", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/issues/#unlock-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" } + ], + "responses": { + "204": { "description": "Empty response" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + "get": { + "summary": "List reactions for an issue", + "description": "List the reactions to an [issue](https://docs.github.com/rest/reference/issues).", + "tags": ["reactions"], + "operationId": "reactions/list-for-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#list-reactions-for-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/reaction" } + }, + "examples": { + "default": { "$ref": "#/components/examples/reaction-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create reaction for an issue", + "description": "Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue.", + "tags": ["reactions"], + "operationId": "reactions/create-for-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#create-reaction-for-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": ["content"] + }, + "example": { "content": "heart" } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/reaction" }, + "examples": { + "default": { "$ref": "#/components/examples/reaction" } + } + } + } + }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete an issue reaction", + "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/rest/reference/issues/).", + "tags": ["reactions"], + "operationId": "reactions/delete-for-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#delete-an-issue-reaction" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" }, + { "$ref": "#/components/parameters/reaction-id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + "get": { + "summary": "List timeline events for an issue", + "description": "", + "tags": ["issues"], + "operationId": "issues/list-events-for-timeline", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#list-timeline-events-for-an-issue" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/issue_number" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-event-for-issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-event-for-issue-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "mockingbird", + "note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```" + }, + { + "required": false, + "name": "starfox", + "note": "Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events).\n\nTo receive the `project_card` attribute, project boards must be [enabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.starfox-preview+json\n```" + } + ], + "category": "issues", + "subcategory": "timeline" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/keys": { + "get": { + "summary": "List deploy keys", + "description": "", + "tags": ["repos"], + "operationId": "repos/list-deploy-keys", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-deploy-keys" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/deploy-key" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/deploy-key-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "keys" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a deploy key", + "description": "You can create a read-only deploy key.", + "tags": ["repos"], + "operationId": "repos/create-deploy-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#create-a-deploy-key" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "A name for the key." + }, + "key": { + "type": "string", + "description": "The contents of the key." + }, + "read_only": { + "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": ["key"] + }, + "example": { + "title": "octocat@octomac", + "key": "ssh-rsa AAA...", + "read_only": true + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/deploy-key" }, + "examples": { + "default": { "$ref": "#/components/examples/deploy-key" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "schema": { "type": "string" } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "keys" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/keys/{key_id}": { + "get": { + "summary": "Get a deploy key", + "description": "", + "tags": ["repos"], + "operationId": "repos/get-deploy-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-deploy-key" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/key_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/deploy-key" }, + "examples": { + "default": { "$ref": "#/components/examples/deploy-key" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "keys" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a deploy key", + "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", + "tags": ["repos"], + "operationId": "repos/delete-deploy-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-a-deploy-key" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/key_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "keys" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/labels": { + "get": { + "summary": "List labels for a repository", + "description": "", + "tags": ["issues"], + "operationId": "issues/list-labels-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#list-labels-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/label" } + }, + "examples": { + "default": { "$ref": "#/components/examples/label-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "labels" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a label", + "description": "", + "tags": ["issues"], + "operationId": "issues/create-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#create-a-label" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "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": { + "type": "string", + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`." + }, + "description": { + "type": "string", + "description": "A short description of the label." + } + }, + "required": ["name"] + }, + "example": { + "name": "bug", + "description": "Something isn't working", + "color": "f29513" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/label" }, + "examples": { + "default": { "$ref": "#/components/examples/label" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "schema": { "type": "string" } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "labels" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/labels/{name}": { + "get": { + "summary": "Get a label", + "description": "", + "tags": ["issues"], + "operationId": "issues/get-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#get-a-label" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/label" }, + "examples": { + "default": { "$ref": "#/components/examples/label" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "labels" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a label", + "description": "", + "tags": ["issues"], + "operationId": "issues/update-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#update-a-label" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "new_name": { + "type": "string", + "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/)." + }, + "color": { + "type": "string", + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`." + }, + "description": { + "type": "string", + "description": "A short description of the label." + } + } + }, + "example": { + "new_name": "bug :bug:", + "description": "Small bug fix required", + "color": "b01f26" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/label" }, + "examples": { + "default": { "$ref": "#/components/examples/label-2" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "labels" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a label", + "description": "", + "tags": ["issues"], + "operationId": "issues/delete-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#delete-a-label" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "labels" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/languages": { + "get": { + "summary": "List repository languages", + "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.", + "tags": ["repos"], + "operationId": "repos/list-languages", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#list-repository-languages" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/language" }, + "examples": { + "default": { "$ref": "#/components/examples/language" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/license": { + "get": { + "summary": "Get the license for a repository", + "description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.", + "tags": ["licenses"], + "operationId": "licenses/get-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/licenses/#get-the-license-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/license-content" }, + "examples": { + "default": { "$ref": "#/components/examples/license-content" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "licenses", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/merges": { + "post": { + "summary": "Merge a branch", + "description": "", + "tags": ["repos"], + "operationId": "repos/merge", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#merge-a-branch" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "base": { + "type": "string", + "description": "The name of the base branch that the head will be merged into." + }, + "head": { + "type": "string", + "description": "The head to merge. This can be a branch name or a commit SHA1." + }, + "commit_message": { + "type": "string", + "description": "Commit message to use for the merge commit. If omitted, a default message will be used." + } + }, + "required": ["base", "head"] + }, + "example": { + "base": "master", + "head": "cool_feature", + "commit_message": "Shipped cool_feature!" + } + } + } + }, + "responses": { + "201": { + "description": "Successful Response (The resulting merge commit)", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/commit" }, + "examples": { + "default": { "$ref": "#/components/examples/commit" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { + "type": "string", + "example": "\"https://docs.github.com/rest/reference/repos#perform-a-merge\"" + } + } + }, + "examples": { + "missing-base-response": { + "summary": "Missing base response", + "value": { "message": "Base does not exist" } + }, + "missing-head-response": { + "summary": "Missing head response", + "value": { "message": "Head does not exist" } + } + } + } + } + }, + "409": { + "description": "Merge conflict response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { + "type": "string", + "example": "\"https://docs.github.com/rest/reference/repos#perform-a-merge\"" + } + } + }, + "examples": { + "merge-conflict-response": { + "value": { "message": "Merge Conflict" } + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "merging" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/milestones": { + "get": { + "summary": "List milestones", + "description": "", + "tags": ["issues"], + "operationId": "issues/list-milestones", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#list-milestones" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "state", + "description": "The state of the milestone. Either `open`, `closed`, or `all`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["open", "closed", "all"], + "default": "open" + } + }, + { + "name": "sort", + "description": "What to sort results by. Either `due_on` or `completeness`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["due_on", "completeness"], + "default": "due_on" + } + }, + { + "name": "direction", + "description": "The direction of the sort. Either `asc` or `desc`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["asc", "desc"], + "default": "asc" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/milestone" } + }, + "examples": { + "default": { "$ref": "#/components/examples/milestone-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "milestones" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a milestone", + "description": "", + "tags": ["issues"], + "operationId": "issues/create-milestone", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#create-a-milestone" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the milestone." + }, + "state": { + "type": "string", + "description": "The state of the milestone. Either `open` or `closed`.", + "enum": ["open", "closed"], + "default": "open" + }, + "description": { + "type": "string", + "description": "A description of the milestone." + }, + "due_on": { + "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": ["title"] + }, + "example": { + "title": "v1.0", + "state": "open", + "description": "Tracking milestone for version 1.0", + "due_on": "2012-10-09T23:39:01Z" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/milestone" }, + "examples": { + "default": { "$ref": "#/components/examples/milestone" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "schema": { "type": "string" } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "milestones" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/milestones/{milestone_number}": { + "get": { + "summary": "Get a milestone", + "description": "", + "tags": ["issues"], + "operationId": "issues/get-milestone", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#get-a-milestone" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/milestone_number" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/milestone" }, + "examples": { + "default": { "$ref": "#/components/examples/milestone" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "milestones" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a milestone", + "description": "", + "tags": ["issues"], + "operationId": "issues/update-milestone", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#update-a-milestone" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/milestone_number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the milestone." + }, + "state": { + "type": "string", + "description": "The state of the milestone. Either `open` or `closed`.", + "enum": ["open", "closed"], + "default": "open" + }, + "description": { + "type": "string", + "description": "A description of the milestone." + }, + "due_on": { + "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`." + } + } + }, + "example": { + "title": "v1.0", + "state": "open", + "description": "Tracking milestone for version 1.0", + "due_on": "2012-10-09T23:39:01Z" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/milestone" }, + "examples": { + "default": { "$ref": "#/components/examples/milestone" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "milestones" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a milestone", + "description": "", + "tags": ["issues"], + "operationId": "issues/delete-milestone", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#delete-a-milestone" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/milestone_number" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "milestones" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + "get": { + "summary": "List labels for issues in a milestone", + "description": "", + "tags": ["issues"], + "operationId": "issues/list-labels-for-milestone", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/issues#list-labels-for-issues-in-a-milestone" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/milestone_number" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/label" } + }, + "examples": { + "default": { "$ref": "#/components/examples/label-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "issues", + "subcategory": "labels" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/notifications": { + "get": { + "summary": "List repository notifications for the authenticated user", + "description": "List all notifications for the current user.", + "tags": ["activity"], + "operationId": "activity/list-repo-notifications-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/all" }, + { "$ref": "#/components/parameters/participating" }, + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/before" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/thread" } + }, + "examples": { + "default": { "$ref": "#/components/examples/thread-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "x-octokit": {} + }, + "put": { + "summary": "Mark repository notifications as read", + "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "tags": ["activity"], + "operationId": "activity/mark-repo-notifications-as-read", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#mark-repository-notifications-as-read" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "last_read_at": { + "type": "string", + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp." + } + } + } + } + } + }, + "responses": { "202": { "description": "response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pages": { + "get": { + "summary": "Get a GitHub Pages site", + "description": "", + "tags": ["repos"], + "operationId": "repos/get-pages", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-github-pages-site" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/page" }, + "examples": { + "default": { "$ref": "#/components/examples/page" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "pages" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a GitHub Pages site", + "description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"", + "tags": ["repos"], + "operationId": "repos/create-pages-site", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#create-a-github-pages-site" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The source branch and directory used to publish your Pages site.", + "properties": { + "source": { + "type": "object", + "description": "The source branch and directory used to publish your Pages site.", + "properties": { + "branch": { + "type": "string", + "description": "The repository branch used to publish your site's source files." + }, + "path": { + "type": "string", + "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", + "enum": ["/", "/docs"], + "default": "/" + } + }, + "required": ["branch"] + } + }, + "required": ["source"] + }, + "example": { "source": { "branch": "main", "path": "/docs" } } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/page" }, + "examples": { + "default": { "$ref": "#/components/examples/page" } + } + } + } + }, + "409": { "$ref": "#/components/responses/conflict" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "switcheroo", + "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "pages" + }, + "x-octokit": {} + }, + "put": { + "summary": "Update information about a GitHub Pages site", + "description": "Updates information for a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).", + "tags": ["repos"], + "operationId": "repos/update-information-about-pages-site", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#update-information-about-a-github-pages-site" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cname": { + "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/).\"", + "nullable": true + }, + "source": { + "anyOf": [ + { + "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", "master /docs"] + }, + { + "type": "object", + "description": "Update the source for the repository. Must include the branch name and path.", + "properties": { + "branch": { + "type": "string", + "description": "The repository branch used to publish your site's source files." + }, + "path": { + "type": "string", + "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.", + "enum": ["/", "/docs"] + } + }, + "required": ["branch", "path"] + } + ] + } + }, + "required": ["source"] + }, + "example": { + "cname": "octocatblog.com", + "source": { "branch": "main", "path": "/" } + } + } + } + }, + "responses": { + "204": { "description": "Empty response" }, + "400": { "$ref": "#/components/responses/bad_request" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "pages" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a GitHub Pages site", + "description": "", + "tags": ["repos"], + "operationId": "repos/delete-pages-site", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-a-github-pages-site" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "switcheroo", + "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```" + } + ], + "category": "repos", + "subcategory": "pages" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pages/builds": { + "get": { + "summary": "List GitHub Pages builds", + "description": "", + "tags": ["repos"], + "operationId": "repos/list-pages-builds", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-github-pages-builds" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/page-build" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/page-build-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "pages" + }, + "x-octokit": {} + }, + "post": { + "summary": "Request a GitHub Pages build", + "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.", + "tags": ["repos"], + "operationId": "repos/request-pages-build", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#request-a-github-pages-build" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/page-build-status" }, + "examples": { + "default": { + "$ref": "#/components/examples/page-build-status" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "pages" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pages/builds/latest": { + "get": { + "summary": "Get latest Pages build", + "description": "", + "tags": ["repos"], + "operationId": "repos/get-latest-pages-build", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-latest-pages-build" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/page-build" }, + "examples": { + "default": { "$ref": "#/components/examples/page-build" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "pages" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pages/builds/{build_id}": { + "get": { + "summary": "Get GitHub Pages build", + "description": "", + "tags": ["repos"], + "operationId": "repos/get-pages-build", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-github-pages-build" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "build_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/page-build" }, + "examples": { + "default": { "$ref": "#/components/examples/page-build" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "pages" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/projects": { + "get": { + "summary": "List repository projects", + "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "tags": ["projects"], + "operationId": "projects/list-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/projects/#list-repository-projects" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "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": ["open", "closed", "all"], + "default": "open" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/project" } + }, + "examples": { + "default": { "$ref": "#/components/examples/project-items-2" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a repository project", + "description": "Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "tags": ["projects"], + "operationId": "projects/create-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/projects/#create-a-repository-project" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the project." + }, + "body": { + "type": "string", + "description": "The description of the project." + } + }, + "required": ["name"] + }, + "example": { + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site." + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/project" }, + "examples": { + "default": { "$ref": "#/components/examples/project-3" } + } + } + } + }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "410": { "$ref": "#/components/responses/gone" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls": { + "get": { + "summary": "List pull requests", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": ["pulls"], + "operationId": "pulls/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/pulls/#list-pull-requests" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "state", + "description": "Either `open`, `closed`, or `all` to filter by state.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["open", "closed", "all"], + "default": "open" + } + }, + { + "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" } + }, + { + "name": "base", + "description": "Filter pulls by base branch name. Example: `gh-pages`.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + { + "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": ["created", "updated", "popularity", "long-running"], + "default": "created" + } + }, + { + "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"] } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-simple-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a pull request", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "tags": ["pulls"], + "operationId": "pulls/create", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/pulls/#create-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the new pull request." + }, + "head": { + "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": { + "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": { + "type": "string", + "description": "The contents of the pull request." + }, + "maintainer_can_modify": { + "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": { + "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." + }, + "issue": { "type": "integer", "example": 1 } + }, + "required": ["head", "base"] + }, + "example": { + "title": "Amazing new feature", + "body": "Please pull these awesome changes in!", + "head": "octocat:new-feature", + "base": "master" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/pull-request" }, + "examples": { + "default": { "$ref": "#/components/examples/pull-request" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "schema": { "type": "string" } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/comments": { + "get": { + "summary": "List review comments in a repository", + "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", + "tags": ["pulls"], + "operationId": "pulls/list-review-comments-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#list-review-comments-in-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/sort" }, + { + "name": "direction", + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "in": "query", + "required": false, + "schema": { "type": "string", "enum": ["asc", "desc"] } + }, + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-review-comment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-comment-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "comfort-fade", + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." + }, + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "pulls", + "subcategory": "comments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + "get": { + "summary": "Get a review comment for a pull request", + "description": "Provides details for a review comment.", + "tags": ["pulls"], + "operationId": "pulls/get-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#get-a-review-comment-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-comment-2" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "comfort-fade", + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." + }, + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "pulls", + "subcategory": "comments" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a review comment for a pull request", + "description": "Enables you to edit a review comment.", + "tags": ["pulls"], + "operationId": "pulls/update-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#update-a-review-comment-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The text of the reply to the review comment." + } + }, + "required": ["body"] + }, + "example": { "body": "I like this too!" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-comment-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "comfort-fade", + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." + } + ], + "category": "pulls", + "subcategory": "comments" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a review comment for a pull request", + "description": "Deletes a review comment.", + "tags": ["pulls"], + "operationId": "pulls/delete-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#delete-a-review-comment-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": "comments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + "get": { + "summary": "List reactions for a pull request review comment", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments).", + "tags": ["reactions"], + "operationId": "reactions/list-for-pull-request-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/reaction" } + }, + "examples": { + "default": { "$ref": "#/components/examples/reaction-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create reaction for a pull request review comment", + "description": "Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment.", + "tags": ["reactions"], + "operationId": "reactions/create-for-pull-request-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": ["content"] + }, + "example": { "content": "heart" } + } + } + }, + "responses": { + "200": { + "description": "Reaction exists", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/reaction" }, + "examples": { + "default": { "$ref": "#/components/examples/reaction" } + } + } + } + }, + "201": { + "description": "Reaction created", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/reaction" }, + "examples": { + "default": { "$ref": "#/components/examples/reaction" } + } + } + } + }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete a pull request comment reaction", + "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments).", + "tags": ["reactions"], + "operationId": "reactions/delete-for-pull-request-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#delete-a-pull-request-comment-reaction" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/comment_id" }, + { "$ref": "#/components/parameters/reaction-id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}": { + "get": { + "summary": "Get a pull request", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "tags": ["pulls"], + "operationId": "pulls/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/pulls/#get-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" } + ], + "responses": { + "200": { + "description": "Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/pull-request" }, + "examples": { + "default": { "$ref": "#/components/examples/pull-request" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "404": { "$ref": "#/components/responses/not_found" }, + "500": { "$ref": "#/components/responses/internal_error" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": null + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a pull request", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.", + "tags": ["pulls"], + "operationId": "pulls/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/pulls/#update-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the pull request." + }, + "body": { + "type": "string", + "description": "The contents of the pull request." + }, + "state": { + "type": "string", + "description": "State of this Pull Request. Either `open` or `closed`.", + "enum": ["open", "closed"] + }, + "base": { + "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": { + "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." + } + } + }, + "example": { + "title": "new title", + "body": "updated body", + "state": "open", + "base": "master" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/pull-request" }, + "examples": { + "default": { "$ref": "#/components/examples/pull-request" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + "get": { + "summary": "List review comments on a pull request", + "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", + "tags": ["pulls"], + "operationId": "pulls/list-review-comments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#list-review-comments-on-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" }, + { "$ref": "#/components/parameters/sort" }, + { + "name": "direction", + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "in": "query", + "required": false, + "schema": { "type": "string", "enum": ["asc", "desc"] } + }, + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-review-comment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-comment-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "comfort-fade", + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." + }, + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "pulls", + "subcategory": "comments" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a review comment for a pull request", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "tags": ["pulls"], + "operationId": "pulls/create-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The text of the review comment." + }, + "commit_id": { + "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": { + "type": "string", + "description": "The relative path to the file that necessitates a comment." + }, + "position": { + "type": "integer", + "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above." + }, + "side": { + "type": "string", + "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "enum": ["LEFT", "RIGHT"] + }, + "line": { + "type": "integer", + "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." + }, + "start_line": { + "type": "integer", + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." + }, + "start_side": { + "type": "string", + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "enum": ["LEFT", "RIGHT", "side"] + }, + "in_reply_to": { "type": "integer", "example": 2 } + }, + "required": ["body", "path"] + }, + "examples": { + "example-for-a-single-line-comment": { + "summary": "Example for a single-line comment", + "value": { + "body": "Let's add this deleted line back.", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "path": "file1.txt", + "line": 5, + "side": "LEFT" + } + }, + "example-for-a-multi-line-comment": { + "summary": "Example for a multi-line comment", + "value": { + "body": "Great stuff!", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "path": "file1.txt", + "start_line": 1, + "start_side": "RIGHT", + "line": 2, + "side": "RIGHT" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review-comment" + }, + "examples": { + "example-for-a-multi-line-comment": { + "$ref": "#/components/examples/pull-request-review-comment-example-for-a-multi-line-comment" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "schema": { "type": "string" } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "comfort-fade", + "note": "Multi-line comments in a pull request diff is currently available for developers to preview. During the preview period, these response fields may change without advance notice. See the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for more information.\n\nTo create multi-line comments or see multi-line comments with the new supported fields during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.comfort-fade-preview+json\n```\n\nTo show multi-line comment-supported fields in the response, use the `comfort-fade` preview header and the `line` parameter.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute." + } + ], + "category": "pulls", + "subcategory": "comments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + "post": { + "summary": "Create a reply for a review comment", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "tags": ["pulls"], + "operationId": "pulls/create-reply-for-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#create-a-reply-for-a-review-comment" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" }, + { "$ref": "#/components/parameters/comment_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The text of the review comment." + } + }, + "required": ["body"] + }, + "example": { "body": "Great stuff!" } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-comment" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "schema": { "type": "string" } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "pulls", + "subcategory": "comments" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + "get": { + "summary": "List commits on a pull request", + "description": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint.", + "tags": ["pulls"], + "operationId": "pulls/list-commits", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/pulls/#list-commits-on-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/commit" } + }, + "examples": { + "default": { "$ref": "#/components/examples/commit-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + "get": { + "summary": "List pull requests files", + "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.", + "tags": ["pulls"], + "operationId": "pulls/list-files", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/pulls/#list-pull-requests-files" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/diff-entry" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/diff-entry-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "422": { "$ref": "#/components/responses/validation_failed" }, + "500": { "$ref": "#/components/responses/internal_error" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + "get": { + "summary": "Check if a pull request has been merged", + "description": "", + "tags": ["pulls"], + "operationId": "pulls/check-if-merged", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/pulls/#check-if-a-pull-request-has-been-merged" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" } + ], + "responses": { + "204": { "description": "Response if pull request has been merged" }, + "404": { + "description": "Response if pull request has not been merged" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": null + }, + "x-octokit": {} + }, + "put": { + "summary": "Merge a pull request", + "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "tags": ["pulls"], + "operationId": "pulls/merge", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/pulls/#merge-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commit_title": { + "type": "string", + "description": "Title for the automatic commit message." + }, + "commit_message": { + "type": "string", + "description": "Extra detail to append to automatic commit message." + }, + "sha": { + "type": "string", + "description": "SHA that pull request head must match to allow merge." + }, + "merge_method": { + "type": "string", + "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", + "enum": ["merge", "squash", "rebase"] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response if merge was successful", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-result" + }, + "examples": { + "response-if-merge-was-successful": { + "$ref": "#/components/examples/pull-request-merge-result-response-if-merge-was-successful" + } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "405": { + "description": "Response if merge cannot be performed", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + }, + "examples": { + "response-if-merge-cannot-be-performed": { + "value": { "message": "Pull Request is not mergeable" } + } + } + } + } + }, + "409": { + "description": "Response if sha was provided and pull request head did not match", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + }, + "examples": { + "response-if-sha-was-provided-and-pull-request-head-did-not-match": { + "value": { + "message": "Head branch was modified. Review and try the merge again." + } + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + "get": { + "summary": "List requested reviewers for a pull request", + "description": "", + "tags": ["pulls"], + "operationId": "pulls/list-requested-reviewers", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review-request" + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-pull-request-review-request" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": "review-requests" + }, + "x-octokit": {} + }, + "post": { + "summary": "Request reviewers for a pull request", + "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)\" for details.", + "tags": ["pulls"], + "operationId": "pulls/request-reviewers", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "An array of user `login`s that will be requested.", + "items": { "type": "string" } + }, + "team_reviewers": { + "type": "array", + "description": "An array of team `slug`s that will be requested.", + "items": { "type": "string" } + } + } + }, + "example": { + "reviewers": ["octocat", "hubot", "other_user"], + "team_reviewers": ["justice-league"] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-request" + } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "description": "Response if user is not a collaborator" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": "review-requests" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove requested reviewers from a pull request", + "description": "", + "tags": ["pulls"], + "operationId": "pulls/remove-requested-reviewers", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "An array of user `login`s that will be removed.", + "items": { "type": "string" } + }, + "team_reviewers": { + "type": "array", + "description": "An array of team `slug`s that will be removed.", + "items": { "type": "string" } + } + } + }, + "example": { + "reviewers": ["octocat", "hubot", "other_user"], + "team_reviewers": ["justice-league"] + } + } + } + }, + "responses": { + "200": { "description": "response" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": "review-requests" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + "get": { + "summary": "List reviews for a pull request", + "description": "The list of reviews returns in chronological order.", + "tags": ["pulls"], + "operationId": "pulls/list-reviews", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#list-reviews-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "The list of reviews returns in chronological order.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-review" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": "reviews" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a review for a pull request", + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", + "tags": ["pulls"], + "operationId": "pulls/create-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#create-a-review-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commit_id": { + "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": { + "type": "string", + "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review." + }, + "event": { + "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://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.", + "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"] + }, + "comments": { + "type": "array", + "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The relative path to the file that necessitates a review comment." + }, + "position": { + "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": { + "type": "string", + "description": "Text of the review comment." + }, + "line": { "type": "integer", "example": 28 }, + "side": { "type": "string", "example": "RIGHT" }, + "start_line": { "type": "integer", "example": 26 }, + "start_side": { "type": "string", "example": "LEFT" } + }, + "required": ["path", "body"] + } + } + } + }, + "example": { + "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", + "body": "This is close to perfect! Please address the suggested inline change.", + "event": "REQUEST_CHANGES", + "comments": [ + { + "path": "file.md", + "position": 6, + "body": "Please add more information here, and fix this typo." + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review" + } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": "reviews" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + "get": { + "summary": "Get a review for a pull request", + "description": "", + "tags": ["pulls"], + "operationId": "pulls/get-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#get-a-review-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" }, + { "$ref": "#/components/parameters/review_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-4" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": "reviews" + }, + "x-octokit": {} + }, + "put": { + "summary": "Update a review for a pull request", + "description": "Update the review summary comment with new text.", + "tags": ["pulls"], + "operationId": "pulls/update-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#update-a-review-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" }, + { "$ref": "#/components/parameters/review_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The body text of the pull request review." + } + }, + "required": ["body"] + }, + "example": { + "body": "This is close to perfect! Please address the suggested inline change. And add more about this." + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-5" + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": "reviews" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a pending review for a pull request", + "description": "", + "tags": ["pulls"], + "operationId": "pulls/delete-pending-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#delete-a-pending-review-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" }, + { "$ref": "#/components/parameters/review_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": "reviews" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + "get": { + "summary": "List comments for a pull request review", + "description": "List comments for a specific pull request review.", + "tags": ["pulls"], + "operationId": "pulls/list-comments-for-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#list-comments-for-a-pull-request-review" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" }, + { "$ref": "#/components/parameters/review_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/review-comment" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/review-comment-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": "reviews" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + "put": { + "summary": "Dismiss a review for a pull request", + "description": "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.", + "tags": ["pulls"], + "operationId": "pulls/dismiss-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#dismiss-a-review-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" }, + { "$ref": "#/components/parameters/review_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message for the pull request review dismissal" + }, + "event": { "type": "string", "example": "\"APPROVE\"" } + }, + "required": ["message"] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-3" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": "reviews" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + "post": { + "summary": "Submit a review for a pull request", + "description": "", + "tags": ["pulls"], + "operationId": "pulls/submit-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" }, + { "$ref": "#/components/parameters/review_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The body text of the pull request review" + }, + "event": { + "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", "COMMENT"] + } + }, + "required": ["event"] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-4" + } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "pulls", + "subcategory": "reviews" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + "put": { + "summary": "Update a pull request branch", + "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", + "tags": ["pulls"], + "operationId": "pulls/update-branch", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/pulls/#update-a-pull-request-branch" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/pull-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "expected_head_sha": { + "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](https://docs.github.com/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." + } + } + }, + "example": { + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + }, + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "url": { "type": "string" } + } + }, + "example": { + "message": "Updating pull request branch.", + "url": "https://github.com/repos/octocat/Hello-World/pulls/53" + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "lydian", + "note": "Updating the pull request branch with latest upstream changes is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.lydian-preview+json\n```" + } + ], + "category": "pulls", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/readme": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": ["repos"], + "operationId": "repos/get-readme", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "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" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/content-file" }, + "examples": { + "default": { "$ref": "#/components/examples/content-file" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/releases": { + "get": { + "summary": "List releases", + "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", + "tags": ["repos"], + "operationId": "repos/list-releases", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-releases" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/release" } + }, + "examples": { + "default": { "$ref": "#/components/examples/release-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "releases" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a release", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "tags": ["repos"], + "operationId": "repos/create-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#create-a-release" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag_name": { + "type": "string", + "description": "The name of the tag." + }, + "target_commitish": { + "type": "string", + "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`)." + }, + "name": { + "type": "string", + "description": "The name of the release." + }, + "body": { + "type": "string", + "description": "Text describing the contents of the tag." + }, + "draft": { + "type": "boolean", + "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", + "default": false + }, + "prerelease": { + "type": "boolean", + "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", + "default": false + } + }, + "required": ["tag_name"] + }, + "example": { + "tag_name": "v1.0.0", + "target_commitish": "master", + "name": "v1.0.0", + "body": "Description of the release", + "draft": false, + "prerelease": false + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/release" }, + "examples": { + "default": { "$ref": "#/components/examples/release" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/releases/1", + "schema": { "type": "string" } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "releases" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + "get": { + "summary": "Get a release asset", + "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "tags": ["repos"], + "operationId": "repos/get-release-asset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-release-asset" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/asset_id" } + ], + "responses": { + "200": { + "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/release-asset" }, + "examples": { + "default": { "$ref": "#/components/examples/release-asset" } + } + } + } + }, + "302": { "$ref": "#/components/responses/found" }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "releases" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a release asset", + "description": "Users with push access to the repository can edit a release asset.", + "tags": ["repos"], + "operationId": "repos/update-release-asset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#update-a-release-asset" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/asset_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The file name of the asset." + }, + "label": { + "type": "string", + "description": "An alternate short description of the asset. Used in place of the filename." + }, + "state": { "type": "string", "example": "\"uploaded\"" } + } + }, + "example": { "name": "foo-1.0.0-osx.zip", "label": "Mac binary" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/release-asset" }, + "examples": { + "default": { "$ref": "#/components/examples/release-asset" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "releases" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a release asset", + "description": "", + "tags": ["repos"], + "operationId": "repos/delete-release-asset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-a-release-asset" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/asset_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "releases" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/releases/latest": { + "get": { + "summary": "Get the latest release", + "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.", + "tags": ["repos"], + "operationId": "repos/get-latest-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-the-latest-release" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/release" }, + "examples": { + "default": { "$ref": "#/components/examples/release" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "releases" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/releases/tags/{tag}": { + "get": { + "summary": "Get a release by tag name", + "description": "Get a published release with the specified tag.", + "tags": ["repos"], + "operationId": "repos/get-release-by-tag", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-release-by-tag-name" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "tag", + "description": "tag+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/release" }, + "examples": { + "default": { "$ref": "#/components/examples/release" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "releases" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/releases/{release_id}": { + "get": { + "summary": "Get a release", + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia).", + "tags": ["repos"], + "operationId": "repos/get-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-release" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/release_id" } + ], + "responses": { + "200": { + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia).", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/release" }, + "examples": { + "default": { "$ref": "#/components/examples/release" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "releases" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a release", + "description": "Users with push access to the repository can edit a release.", + "tags": ["repos"], + "operationId": "repos/update-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#update-a-release" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/release_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag_name": { + "type": "string", + "description": "The name of the tag." + }, + "target_commitish": { + "type": "string", + "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`)." + }, + "name": { + "type": "string", + "description": "The name of the release." + }, + "body": { + "type": "string", + "description": "Text describing the contents of the tag." + }, + "draft": { + "type": "boolean", + "description": "`true` makes the release a draft, and `false` publishes the release." + }, + "prerelease": { + "type": "boolean", + "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release." + } + } + }, + "example": { + "tag_name": "v1.0.0", + "target_commitish": "master", + "name": "v1.0.0", + "body": "Description of the release", + "draft": false, + "prerelease": false + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/release" }, + "examples": { + "default": { "$ref": "#/components/examples/release" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "releases" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a release", + "description": "Users with push access to the repository can delete a release.", + "tags": ["repos"], + "operationId": "repos/delete-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#delete-a-release" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/release_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "releases" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/releases/{release_id}/assets": { + "get": { + "summary": "List release assets", + "description": "", + "tags": ["repos"], + "operationId": "repos/list-release-assets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-release-assets" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/release_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/release-asset" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/release-asset-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "releases" + }, + "x-octokit": {} + }, + "post": { + "summary": "Upload a release asset", + "description": "This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#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\nthe response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#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,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.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.", + "tags": ["repos"], + "operationId": "repos/upload-release-asset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#upload-a-release-asset" + }, + "servers": [ + { + "url": "{origin}", + "variables": { + "origin": { + "default": "https://uploads.github.com", + "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" + } + } + } + ], + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/release_id" }, + { "name": "name", "in": "query", "schema": { "type": "string" } }, + { "name": "label", "in": "query", "schema": { "type": "string" } } + ], + "requestBody": { + "content": { + "*/*": { + "schema": { "type": "string", "description": "The raw file data" } + } + } + }, + "responses": { + "201": { + "description": "Response for successful upload", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/release-asset" }, + "examples": { + "response-for-successful-upload": { + "$ref": "#/components/examples/release-asset-response-for-successful-upload" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "releases" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/secret-scanning/alerts": { + "get": { + "summary": "List secret scanning alerts for a repository", + "description": "Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": ["secret-scanning"], + "operationId": "secret-scanning/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "state", + "in": "query", + "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", + "required": false, + "schema": { "type": "string", "enum": ["open", "resolved"] } + }, + { "$ref": "#/components/parameters/page" }, + { "$ref": "#/components/parameters/per_page" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-alert" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-list" + } + } + } + } + }, + "404": { + "description": "Repository is public or secret scanning is disabled for the repository" + }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "secret-scanning", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + "get": { + "summary": "Get a secret scanning alert", + "description": "Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", + "tags": ["secret-scanning"], + "operationId": "secret-scanning/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/alert_number" } + ], + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-open" + } + } + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "secret-scanning", + "subcategory": null + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a secret scanning alert", + "description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", + "operationId": "secret-scanning/update-alert", + "tags": ["secret-scanning"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/alert_number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + } + }, + "required": ["state"] + }, + "example": { "state": "resolved", "resolution": "false_positive" } + } + } + }, + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-resolved" + } + } + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "422": { "description": "State does not match the resolution" }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "secret-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/stargazers": { + "get": { + "summary": "List stargazers", + "description": "Lists the people that have starred the repository.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", + "tags": ["activity"], + "operationId": "activity/list-stargazers-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-stargazers" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/simple-user-items-default-response" + } + } + }, + "application/vnd.github.v3.star+json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/stargazer" } + }, + "examples": { + "alternative-response-with-star-creation-timestamps": { + "$ref": "#/components/examples/stargazer-items-alternative-response-with-star-creation-timestamps" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "starring" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/stats/code_frequency": { + "get": { + "summary": "Get the weekly commit activity", + "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", + "tags": ["repos"], + "operationId": "repos/get-code-frequency-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-the-weekly-commit-activity" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-frequency-stat" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-frequency-stat-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "statistics" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/stats/commit_activity": { + "get": { + "summary": "Get the last year of commit activity", + "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.", + "tags": ["repos"], + "operationId": "repos/get-commit-activity-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-the-last-year-of-commit-activity" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/commit-activity" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-activity-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "statistics" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/stats/contributors": { + "get": { + "summary": "Get all contributor commit activity", + "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "tags": ["repos"], + "operationId": "repos/get-contributors-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-all-contributor-commit-activity" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/contributor-activity" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/contributor-activity-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "statistics" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/stats/participation": { + "get": { + "summary": "Get the weekly commit count", + "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.", + "tags": ["repos"], + "operationId": "repos/get-participation-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-the-weekly-commit-count" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "The array order is oldest week (index 0) to most recent week.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/participation-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/participation-stats" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "statistics" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/stats/punch_card": { + "get": { + "summary": "Get the hourly commit count for each day", + "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "tags": ["repos"], + "operationId": "repos/get-punch-card-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-the-hourly-commit-count-for-each-day" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-frequency-stat" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-frequency-stat-items-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "statistics" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/statuses/{sha}": { + "post": { + "summary": "Create a commit status", + "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.", + "tags": ["repos"], + "operationId": "repos/create-commit-status", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#create-a-commit-status" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "sha", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", + "enum": ["error", "failure", "pending", "success"] + }, + "target_url": { + "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": { + "type": "string", + "description": "A short description of the status." + }, + "context": { + "type": "string", + "description": "A string label to differentiate this status from the status of other systems.", + "default": "default" + } + }, + "required": ["state"] + }, + "example": { + "state": "success", + "target_url": "https://example.com/build/status", + "description": "The build succeeded!", + "context": "continuous-integration/jenkins" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/status" }, + "examples": { + "default": { "$ref": "#/components/examples/status" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { "type": "string" } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "statuses" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/subscribers": { + "get": { + "summary": "List watchers", + "description": "Lists the people watching the specified repository.", + "tags": ["activity"], + "operationId": "activity/list-watchers-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-watchers" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "watching" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/subscription": { + "get": { + "summary": "Get a repository subscription", + "description": "", + "tags": ["activity"], + "operationId": "activity/get-repo-subscription", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#get-a-repository-subscription" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "Response if you subscribe to the repository", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-subscription" + }, + "examples": { + "response-if-you-subscribe-to-the-repository": { + "$ref": "#/components/examples/repository-subscription-response-if-you-subscribe-to-the-repository" + } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { + "description": "Response if you don't subscribe to the repository" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "watching" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set a repository subscription", + "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely.", + "tags": ["activity"], + "operationId": "activity/set-repo-subscription", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#set-a-repository-subscription" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "subscribed": { + "type": "boolean", + "description": "Determines if notifications should be received from this repository." + }, + "ignored": { + "type": "boolean", + "description": "Determines if all notifications should be blocked from this repository." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-subscription" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-subscription" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "watching" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a repository subscription", + "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription).", + "tags": ["activity"], + "operationId": "activity/delete-repo-subscription", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#delete-a-repository-subscription" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "watching" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/tags": { + "get": { + "summary": "List repository tags", + "description": "", + "tags": ["repos"], + "operationId": "repos/list-tags", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#list-repository-tags" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/tag" } + }, + "examples": { + "default": { "$ref": "#/components/examples/tag-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/tarball/{ref}": { + "get": { + "summary": "Download a repository archive (tar)", + "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", + "tags": ["repos"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#download-a-repository-archive" + }, + "operationId": "repos/download-tarball-archive", + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "ref", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "302": { + "description": "response", + "headers": { + "Location": { + "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", + "schema": { "type": "string" } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "x-octokit": { + "changes": [ + { + "type": "OPERATION", + "date": "2020-09-17", + "before": { "operationId": "repos/download-archive" } + } + ] + } + } + }, + "/repos/{owner}/{repo}/teams": { + "get": { + "summary": "List repository teams", + "description": "", + "tags": ["repos"], + "operationId": "repos/list-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#list-repository-teams" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team" } + }, + "examples": { + "default": { "$ref": "#/components/examples/team-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/topics": { + "get": { + "summary": "Get all repository topics", + "description": "", + "tags": ["repos"], + "operationId": "repos/get-all-topics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#get-all-repository-topics" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/topic" }, + "examples": { + "default": { "$ref": "#/components/examples/topic" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "mercy", + "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + }, + "put": { + "summary": "Replace all repository topics", + "description": "", + "tags": ["repos"], + "operationId": "repos/replace-all-topics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#replace-all-repository-topics" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "names": { + "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" } + } + }, + "required": ["names"] + }, + "example": { "names": ["octocat", "atom", "electron", "api"] } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/topic" }, + "examples": { + "default": { "$ref": "#/components/examples/topic" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "mercy", + "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/traffic/clones": { + "get": { + "summary": "Get repository clones", + "description": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", + "tags": ["repos"], + "operationId": "repos/get-clones", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-repository-clones" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/clone-traffic" }, + "examples": { + "default": { "$ref": "#/components/examples/clone-traffic" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "traffic" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/traffic/popular/paths": { + "get": { + "summary": "Get top referral paths", + "description": "Get the top 10 popular contents over the last 14 days.", + "tags": ["repos"], + "operationId": "repos/get-top-paths", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-top-referral-paths" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/content-traffic" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-traffic-items" + } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "traffic" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/traffic/popular/referrers": { + "get": { + "summary": "Get top referral sources", + "description": "Get the top 10 referrers over the last 14 days.", + "tags": ["repos"], + "operationId": "repos/get-top-referrers", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-top-referral-sources" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/referrer-traffic" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/referrer-traffic-items" + } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "traffic" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/traffic/views": { + "get": { + "summary": "Get page views", + "description": "Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", + "tags": ["repos"], + "operationId": "repos/get-views", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-page-views" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { "$ref": "#/components/parameters/per" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/view-traffic" }, + "examples": { + "default": { "$ref": "#/components/examples/view-traffic" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "traffic" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/transfer": { + "post": { + "summary": "Transfer a repository", + "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).", + "tags": ["repos"], + "operationId": "repos/transfer", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#transfer-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "new_owner": { + "type": "string", + "description": "**Required:** The username or organization name the repository will be transferred to." + }, + "team_ids": { + "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" } + } + } + }, + "example": { "new_owner": "github", "team_ids": [12, 345] } + } + } + }, + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/repository" }, + "examples": { + "default": { "$ref": "#/components/examples/repository" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/vulnerability-alerts": { + "get": { + "summary": "Check if vulnerability alerts are enabled for a repository", + "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "tags": ["repos"], + "operationId": "repos/check-vulnerability-alerts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#check-if-vulnerability-alerts-are-enabled-for-a-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "204": { + "description": "Response if repository is enabled with vulnerability alerts" + }, + "404": { + "description": "Response if repository is not enabled with vulnerability alerts" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "dorian", + "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + }, + "put": { + "summary": "Enable vulnerability alerts", + "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "tags": ["repos"], + "operationId": "repos/enable-vulnerability-alerts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#enable-vulnerability-alerts" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "dorian", + "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Disable vulnerability alerts", + "description": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "tags": ["repos"], + "operationId": "repos/disable-vulnerability-alerts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#disable-vulnerability-alerts" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "dorian", + "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/zipball/{ref}": { + "get": { + "summary": "Download a repository archive (zip)", + "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", + "tags": ["repos"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#download-a-repository-archive" + }, + "operationId": "repos/download-zipball-archive", + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" }, + { + "name": "ref", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "302": { + "description": "response", + "headers": { + "Location": { + "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", + "schema": { "type": "string" } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "contents" + }, + "x-octokit": { + "changes": [ + { + "type": "OPERATION", + "date": "2020-09-17", + "before": { "operationId": "repos/download-archive" } + } + ] + } + } + }, + "/repos/{template_owner}/{template_repo}/generate": { + "post": { + "summary": "Create a repository using a template", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "tags": ["repos"], + "operationId": "repos/create-using-template", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#create-a-repository-using-a-template" + }, + "parameters": [ + { + "name": "template_owner", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "template_repo", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "owner": { + "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": { + "type": "string", + "description": "The name of the new repository." + }, + "description": { + "type": "string", + "description": "A short description of the new repository." + }, + "include_all_branches": { + "type": "boolean", + "description": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.", + "default": false + }, + "private": { + "type": "boolean", + "description": "Either `true` to create a new private repository or `false` to create a new public one.", + "default": false + } + }, + "required": ["name"] + }, + "example": { + "owner": "octocat", + "name": "Hello-World", + "description": "This is your first repository", + "include_all_branches": false, + "private": false + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/repository" }, + "examples": { + "default": { "$ref": "#/components/examples/repository-3" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World", + "schema": { "type": "string" } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "baptiste", + "note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/repositories": { + "get": { + "summary": "List public repositories", + "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "tags": ["repos"], + "operationId": "repos/list-public", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#list-public-repositories" + }, + "parameters": [{ "$ref": "#/components/parameters/since-repo" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/minimal-repository" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/public-repository-items" + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { "type": "string" } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/scim/v2/enterprises/{enterprise}/Groups": { + "get": { + "summary": "List provisioned SCIM groups for an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/list-provisioned-groups-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/start_index" }, + { "$ref": "#/components/parameters/count" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-group-list-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group-list" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "x-octokit": {} + }, + "post": { + "summary": "Provision a SCIM enterprise group and invite users", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nProvision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.", + "operationId": "enterprise-admin/provision-and-invite-enterprise-group", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { "type": "string" } + }, + "displayName": { + "type": "string", + "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to." + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The SCIM user ID for a user." + } + }, + "required": ["value"] + } + } + }, + "required": ["schemas", "displayName"] + }, + "example": { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"], + "displayName": "octo-org", + "members": [ + { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" }, + { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" } + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "x-octokit": {} + } + }, + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + "get": { + "summary": "Get SCIM provisioning information for an enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/scim_group_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set SCIM information for a provisioned enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nReplaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/scim_group_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { "type": "string" } + }, + "displayName": { + "type": "string", + "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to." + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The SCIM user ID for a user." + } + }, + "required": ["value"] + } + } + }, + "required": ["schemas", "displayName"] + }, + "example": { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"], + "displayName": "octo-org", + "members": [ + { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" }, + { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an attribute for a SCIM enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nAllows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "operationId": "enterprise-admin/update-attribute-for-enterprise-group", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/scim_group_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { "type": "string" } + }, + "Operations": { + "type": "array", + "description": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "items": { "type": "object" } + } + }, + "required": ["schemas", "Operations"] + }, + "example": { + "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"], + "Operations": [ + { + "op": "remove", + "path": "members", + "value": [ + { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group-2" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a SCIM group from an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/delete-scim-group-from-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/scim_group_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "x-octokit": {} + } + }, + "/scim/v2/enterprises/{enterprise}/Users": { + "get": { + "summary": "List SCIM provisioned identities for an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nRetrieves a paginated list of all provisioned enterprise members, including pending invitations.\n\nWhen a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:\n - When a user with a SCIM-provisioned external identity is removed from an enterprise, the account's metadata is preserved to allow the user to re-join the organization in the future.\n - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted).\n - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO.\n\nThe returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:\n\n1. The user is granted access by the IdP and is not a member of the GitHub enterprise.\n\n1. The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account.\n\n1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub account:\n - If the user signs in, their GitHub account is linked to this entry.\n - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place.", + "operationId": "enterprise-admin/list-provisioned-identities-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#list-scim-provisioned-identities-for-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/start_index" }, + { "$ref": "#/components/parameters/count" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-user-list-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-user-list" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "x-octokit": {} + }, + "post": { + "summary": "Provision and invite a SCIM enterprise user", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nProvision enterprise membership for a user, and send organization invitation emails to the email address.\n\nYou can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent.", + "operationId": "enterprise-admin/provision-and-invite-enterprise-user", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user" + }, + "parameters": [{ "$ref": "#/components/parameters/enterprise" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { "type": "string" } + }, + "userName": { + "type": "string", + "description": "The username for the user." + }, + "name": { + "type": "object", + "properties": { + "givenName": { + "type": "string", + "description": "The first name of the user." + }, + "familyName": { + "type": "string", + "description": "The last name of the user." + } + }, + "required": ["givenName", "familyName"] + }, + "emails": { + "type": "array", + "description": "List of user emails.", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The email address." + }, + "type": { + "type": "string", + "description": "The type of email address." + }, + "primary": { + "type": "boolean", + "description": "Whether this email address is the primary address." + } + }, + "required": ["value", "type", "primary"] + } + }, + "groups": { + "type": "array", + "description": "List of SCIM group IDs the user is a member of.", + "items": { + "type": "object", + "properties": { "value": { "type": "string" } } + } + } + }, + "required": ["schemas", "userName", "name", "emails"] + }, + "example": { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], + "userName": "mona.octocat@okta.example.com", + "name": { "familyName": "Octocat", "givenName": "Mona" }, + "emails": [ + { + "value": "mona.octocat@okta.example.com", + "type": "work", + "primary": true + } + ], + "groups": [{ "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" }] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-user" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-user" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "x-octokit": {} + } + }, + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + "get": { + "summary": "Get SCIM provisioning information for an enterprise user", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/scim_user_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-user" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-user" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set SCIM information for a provisioned enterprise user", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nReplaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-an-enterprise-scim-user) endpoint instead.\n\nYou must at least provide the required values for the user: `userName`, `name`, and `emails`.\n\n**Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`.", + "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/scim_user_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { "type": "string" } + }, + "userName": { + "type": "string", + "description": "The username for the user." + }, + "name": { + "type": "object", + "properties": { + "givenName": { + "type": "string", + "description": "The first name of the user." + }, + "familyName": { + "type": "string", + "description": "The last name of the user." + } + }, + "required": ["givenName", "familyName"] + }, + "emails": { + "type": "array", + "description": "List of user emails.", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The email address." + }, + "type": { + "type": "string", + "description": "The type of email address." + }, + "primary": { + "type": "boolean", + "description": "Whether this email address is the primary address." + } + }, + "required": ["value", "type", "primary"] + } + }, + "groups": { + "type": "array", + "description": "List of SCIM group IDs the user is a member of.", + "items": { + "type": "object", + "properties": { "value": { "type": "string" } } + } + } + }, + "required": ["schemas", "userName", "name", "emails"] + }, + "example": { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], + "userName": "mona.octocat@okta.example.com", + "name": { "familyName": "Octocat", "givenName": "Mona" }, + "emails": [ + { + "value": "mona.octocat@okta.example.com", + "type": "work", + "primary": true + } + ], + "groups": [{ "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" }] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-user" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-user" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an attribute for a SCIM enterprise user", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nAllows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n**Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated `:scim_user_id`.\n\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```", + "operationId": "enterprise-admin/update-attribute-for-enterprise-user", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/scim_user_id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { "type": "string" } + }, + "Operations": { + "type": "array", + "description": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "items": { "type": "object" } + } + }, + "required": ["schemas", "Operations"] + }, + "example": { + "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"], + "Operations": [ + { + "op": "add", + "path": "emails", + "value": [ + { "value": "monalisa@octocat.github.com", "type": "home" } + ] + }, + { + "op": "replace", + "path": "name.givenName", + "value": "Monalisa" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-user" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-user-2" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a SCIM user from an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/delete-user-from-enterprise", + "tags": ["enterprise-admin"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/enterprise-admin#delete-a-scim-user-from-an-enterprise" + }, + "parameters": [ + { "$ref": "#/components/parameters/enterprise" }, + { "$ref": "#/components/parameters/scim_user_id" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [], + "category": "enterprise-admin", + "subcategory": "scim" + }, + "x-octokit": {} + } + }, + "/scim/v2/organizations/{org}/Users": { + "get": { + "summary": "List SCIM provisioned identities", + "description": "Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned.\n\nWhen a user with a SAML-provisioned external identity leaves (or is removed from) an organization, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:\n - When a user with a SCIM-provisioned external identity is removed from an organization, the account's metadata is preserved to allow the user to re-join the organization in the future.\n - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted).\n - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO.\n\nThe returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:\n\n1. The user is granted access by the IdP and is not a member of the GitHub organization.\n\n1. The user attempts to access the GitHub organization and initiates the SAML SSO process, and is not currently signed in to their GitHub account.\n\n1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub account:\n - If the user signs in, their GitHub account is linked to this entry.\n - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place.", + "tags": ["scim"], + "operationId": "scim/list-provisioned-identities", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/scim/#list-scim-provisioned-identities" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { + "name": "startIndex", + "description": "Used for pagination: the index of the first result to return.", + "in": "query", + "required": false, + "schema": { "type": "integer" } + }, + { + "name": "count", + "description": "Used for pagination: the number of results to return.", + "in": "query", + "required": false, + "schema": { "type": "integer" } + }, + { + "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:\n\n`?filter=userName%20eq%20\\\"Octocat\\\"`.\n\nTo filter results for for the identity with the email `octocat@github.com`, you would use this query:\n\n`?filter=emails%20eq%20\\\"octocat@github.com\\\"`.", + "in": "query", + "required": false, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-user-list" }, + "examples": { + "response-with-filter": { + "$ref": "#/components/examples/scim-user-list-response-with-filter" + }, + "response-without-filter": { + "$ref": "#/components/examples/scim-user-list-response-without-filter" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "400": { "$ref": "#/components/responses/scim_bad_request" }, + "403": { "$ref": "#/components/responses/scim_forbidden" }, + "404": { "$ref": "#/components/responses/scim_not_found" } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "scim", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Provision and invite a SCIM user", + "description": "Provision organization membership for a user, and send an activation email to the email address.", + "tags": ["scim"], + "operationId": "scim/provision-and-invite-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/scim/#provision-and-invite-a-scim-user" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "201": { + "description": "response", + "content": { + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-user" }, + "examples": { + "default": { "$ref": "#/components/examples/scim-user" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "400": { "$ref": "#/components/responses/scim_bad_request" }, + "403": { "$ref": "#/components/responses/scim_forbidden" }, + "404": { "$ref": "#/components/responses/scim_not_found" }, + "409": { "$ref": "#/components/responses/scim_conflict" }, + "500": { "$ref": "#/components/responses/scim_internal_error" } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "userName": { + "description": "Configured by the admin. Could be an email, login, or username", + "example": "someone@example.com", + "type": "string" + }, + "displayName": { + "description": "The name of the user, suitable for display to end-users", + "example": "Jon Doe", + "type": "string" + }, + "name": { + "type": "object", + "properties": { + "givenName": { "type": "string" }, + "familyName": { "type": "string" }, + "formatted": { "type": "string" } + }, + "required": ["givenName", "familyName"], + "example": { "givenName": "Jane", "familyName": "User" } + }, + "emails": { + "description": "user emails", + "example": [ + { "value": "someone@example.com", "primary": true }, + { "value": "another@example.com", "primary": false } + ], + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "value": { "type": "string" }, + "primary": { "type": "boolean" }, + "type": { "type": "string" } + }, + "required": ["value"] + } + }, + "schemas": { "type": "array", "items": { "type": "string" } }, + "externalId": { "type": "string" }, + "groups": { "type": "array", "items": { "type": "string" } }, + "active": { "type": "boolean" } + }, + "required": ["userName", "name", "emails"] + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "scim", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/scim/v2/organizations/{org}/Users/{scim_user_id}": { + "get": { + "summary": "Get SCIM provisioning information for a user", + "description": "", + "tags": ["scim"], + "operationId": "scim/get-provisioning-information-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/scim/#get-scim-provisioning-information-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/scim_user_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-user" }, + "examples": { + "default": { "$ref": "#/components/examples/scim-user" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/scim_forbidden" }, + "404": { "$ref": "#/components/responses/scim_not_found" } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "scim", + "subcategory": null + }, + "x-octokit": {} + }, + "put": { + "summary": "Update a provisioned organization membership", + "description": "Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead.\n\nYou must at least provide the required values for the user: `userName`, `name`, and `emails`.\n\n**Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`.", + "tags": ["scim"], + "operationId": "scim/set-information-for-provisioned-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/scim/#set-scim-information-for-a-provisioned-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/scim_user_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-user" }, + "examples": { + "default": { "$ref": "#/components/examples/scim-user" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/scim_forbidden" }, + "404": { "$ref": "#/components/responses/scim_not_found" } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { "type": "array", "items": { "type": "string" } }, + "displayName": { + "description": "The name of the user, suitable for display to end-users", + "example": "Jon Doe", + "type": "string" + }, + "externalId": { "type": "string" }, + "groups": { "type": "array", "items": { "type": "string" } }, + "active": { "type": "boolean" }, + "userName": { + "description": "Configured by the admin. Could be an email, login, or username", + "example": "someone@example.com", + "type": "string" + }, + "name": { + "type": "object", + "properties": { + "givenName": { "type": "string" }, + "familyName": { "type": "string" }, + "formatted": { "type": "string" } + }, + "required": ["givenName", "familyName"], + "example": { "givenName": "Jane", "familyName": "User" } + }, + "emails": { + "description": "user emails", + "example": [ + { "value": "someone@example.com", "primary": true }, + { "value": "another@example.com", "primary": false } + ], + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "type": { "type": "string" }, + "value": { "type": "string" }, + "primary": { "type": "boolean" } + }, + "required": ["value"] + } + } + }, + "required": ["userName", "name", "emails"] + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "scim", + "subcategory": null + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an attribute for a SCIM user", + "description": "Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n**Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`.\n\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```", + "tags": ["scim"], + "operationId": "scim/update-attribute-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/scim/#update-an-attribute-for-a-scim-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/scim_user_id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-user" }, + "examples": { + "default": { "$ref": "#/components/examples/scim-user" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "400": { "$ref": "#/components/responses/scim_bad_request" }, + "403": { "$ref": "#/components/responses/scim_forbidden" }, + "404": { "$ref": "#/components/responses/scim_not_found" }, + "429": { + "description": "Too many requests", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "schemas": { "type": "array", "items": { "type": "string" } }, + "Operations": { + "description": "Set of operations to be performed", + "example": [ + { "op": "replace", "value": { "active": false } } + ], + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": ["add", "remove", "replace"] + }, + "path": { "type": "string" }, + "value": { + "oneOf": [ + { + "type": "object", + "properties": { + "active": { + "type": "boolean", + "nullable": true + }, + "userName": { + "type": "string", + "nullable": true + }, + "externalId": { + "type": "string", + "nullable": true + }, + "givenName": { + "type": "string", + "nullable": true + }, + "familyName": { + "type": "string", + "nullable": true + } + } + }, + { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { "type": "string" }, + "primary": { "type": "boolean" } + } + } + }, + { "type": "string" } + ] + } + }, + "required": ["op"] + } + } + }, + "required": ["Operations"], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "scim", + "subcategory": null + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a SCIM user from an organization", + "description": "", + "tags": ["scim"], + "operationId": "scim/delete-user-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/scim/#delete-a-scim-user-from-an-organization" + }, + "parameters": [ + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/scim_user_id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/scim_forbidden" }, + "404": { "$ref": "#/components/responses/scim_not_found" } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "previews": [], + "category": "scim", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/search/code": { + "get": { + "summary": "Search code", + "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\n#### Considerations for code search\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.", + "tags": ["search"], + "operationId": "search/code", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/search/#search-code" + }, + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/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" } + }, + { + "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://docs.github.com/rest/reference/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { "type": "string", "enum": ["indexed"] } + }, + { "$ref": "#/components/parameters/order" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "incomplete_results", "items"], + "properties": { + "total_count": { "type": "integer" }, + "incomplete_results": { "type": "boolean" }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-search-result-item-paginated" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "search", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/search/commits": { + "get": { + "summary": "Search commits", + "description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", + "tags": ["search"], + "operationId": "search/commits", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/search/#search-commits" + }, + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/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" } + }, + { + "name": "sort", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["author-date", "committer-date"] + } + }, + { "$ref": "#/components/parameters/order" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "incomplete_results", "items"], + "properties": { + "total_count": { "type": "integer" }, + "incomplete_results": { "type": "boolean" }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/commit-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-search-result-item-paginated" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "cloak", + "note": "The Commit Search API is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2017-01-05-commit-search-api/) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.cloak-preview\n```" + } + ], + "category": "search", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/search/issues": { + "get": { + "summary": "Search issues and pull requests", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "tags": ["search"], + "operationId": "search/issues-and-pull-requests", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/search/#search-issues-and-pull-requests" + }, + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/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" } + }, + { + "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://docs.github.com/rest/reference/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "comments", + "reactions", + "reactions-+1", + "reactions--1", + "reactions-smile", + "reactions-thinking_face", + "reactions-heart", + "reactions-tada", + "interactions", + "created", + "updated" + ] + } + }, + { "$ref": "#/components/parameters/order" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "incomplete_results", "items"], + "properties": { + "total_count": { "type": "integer" }, + "incomplete_results": { "type": "boolean" }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-search-result-item-paginated" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "search", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/search/labels": { + "get": { + "summary": "Search labels", + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", + "tags": ["search"], + "operationId": "search/labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/search/#search-labels" + }, + "parameters": [ + { + "name": "repository_id", + "description": "The id of the repository.", + "in": "query", + "required": true, + "schema": { "type": "integer" } + }, + { + "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://docs.github.com/rest/reference/search#constructing-a-search-query).", + "in": "query", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "sort", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { "type": "string", "enum": ["created", "updated"] } + }, + { "$ref": "#/components/parameters/order" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "incomplete_results", "items"], + "properties": { + "total_count": { "type": "integer" }, + "incomplete_results": { "type": "boolean" }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/label-search-result-item-paginated" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "search", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/search/repositories": { + "get": { + "summary": "Search repositories", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.\n\nWhen you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:\n\n`q=topic:ruby+topic:rails`", + "tags": ["search"], + "operationId": "search/repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/search/#search-repositories" + }, + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/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" } + }, + { + "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://docs.github.com/rest/reference/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["stars", "forks", "help-wanted-issues", "updated"] + } + }, + { "$ref": "#/components/parameters/order" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "incomplete_results", "items"], + "properties": { + "total_count": { "type": "integer" }, + "incomplete_results": { "type": "boolean" }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repo-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repo-search-result-item-paginated" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "422": { "$ref": "#/components/responses/validation_failed" }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "mercy", + "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" + } + ], + "category": "search", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/search/topics": { + "get": { + "summary": "Search topics", + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See \"[Searching topics](https://help.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", + "tags": ["search"], + "operationId": "search/topics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/search/#search-topics" + }, + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query).", + "in": "query", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "incomplete_results", "items"], + "properties": { + "total_count": { "type": "integer" }, + "incomplete_results": { "type": "boolean" }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/topic-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/topic-search-result-item-paginated" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "mercy", + "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" + } + ], + "category": "search", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/search/users": { + "get": { + "summary": "Search users", + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.", + "tags": ["search"], + "operationId": "search/users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/search/#search-users" + }, + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/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" } + }, + { + "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://docs.github.com/rest/reference/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["followers", "repositories", "joined"] + } + }, + { "$ref": "#/components/parameters/order" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "incomplete_results", "items"], + "properties": { + "total_count": { "type": "integer" }, + "incomplete_results": { "type": "boolean" }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/user-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-search-result-item-paginated" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "422": { "$ref": "#/components/responses/validation_failed" }, + "503": { "$ref": "#/components/responses/service_unavailable" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "search", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/teams/{team_id}": { + "get": { + "summary": "Get a team (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint.", + "tags": ["teams"], + "operationId": "teams/get-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#get-a-team-legacy" + }, + "parameters": [{ "$ref": "#/components/parameters/team-id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-full" }, + "examples": { + "default": { "$ref": "#/components/examples/team-full" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + }, + "patch": { + "summary": "Update a team (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", + "tags": ["teams"], + "operationId": "teams/update-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#update-a-team-legacy" + }, + "parameters": [{ "$ref": "#/components/parameters/team-id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "privacy": { + "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": { + "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", "admin"], + "default": "pull" + }, + "parent_team_id": { + "type": "integer", + "description": "The ID of a team to set as the parent team.", + "nullable": true + } + }, + "required": ["name"] + }, + "example": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-full" }, + "examples": { + "default": { "$ref": "#/components/examples/team-full" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a team (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "tags": ["teams"], + "operationId": "teams/delete-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#delete-a-team-legacy" + }, + "parameters": [{ "$ref": "#/components/parameters/team-id" }], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/discussions": { + "get": { + "summary": "List discussions (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint.\n\nList all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["teams"], + "operationId": "teams/list-discussions-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#list-discussions-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/direction" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team-discussion" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-discussion-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussions" + }, + "deprecated": true, + "x-octokit": {} + }, + "post": { + "summary": "Create a discussion (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "tags": ["teams"], + "operationId": "teams/create-discussion-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#create-a-discussion-legacy" + }, + "parameters": [{ "$ref": "#/components/parameters/team-id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The discussion post's title." + }, + "body": { + "type": "string", + "description": "The discussion post's body text." + }, + "private": { + "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 + } + }, + "required": ["title", "body"] + }, + "example": { + "title": "Our first team post", + "body": "Hi! This is an area for us to collaborate as a team." + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-discussion" }, + "examples": { + "default": { "$ref": "#/components/examples/team-discussion" } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussions" + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/discussions/{discussion_number}": { + "get": { + "summary": "Get a discussion (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["teams"], + "operationId": "teams/get-discussion-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#get-a-discussion-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/discussion-number" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-discussion" }, + "examples": { + "default": { "$ref": "#/components/examples/team-discussion" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussions" + }, + "deprecated": true, + "x-octokit": {} + }, + "patch": { + "summary": "Update a discussion (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["teams"], + "operationId": "teams/update-discussion-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#update-a-discussion-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/discussion-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The discussion post's title." + }, + "body": { + "type": "string", + "description": "The discussion post's body text." + } + } + }, + "example": { "title": "Welcome to our first team post" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-discussion" }, + "examples": { + "default": { + "$ref": "#/components/examples/team-discussion-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussions" + }, + "deprecated": true, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a discussion (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["teams"], + "operationId": "teams/delete-discussion-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#delete-a-discussion-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/discussion-number" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussions" + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/discussions/{discussion_number}/comments": { + "get": { + "summary": "List discussion comments (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint.\n\nList all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["teams"], + "operationId": "teams/list-discussion-comments-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#list-discussion-comments-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/direction" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team-discussion-comment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-discussion-comment-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" + }, + "deprecated": true, + "x-octokit": {} + }, + "post": { + "summary": "Create a discussion comment (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "tags": ["teams"], + "operationId": "teams/create-discussion-comment-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#create-a-discussion-comment-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/discussion-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The discussion comment's body text." + } + }, + "required": ["body"] + }, + "example": { "body": "Do you like apples?" } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-discussion-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-discussion-comment" + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + "get": { + "summary": "Get a discussion comment (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["teams"], + "operationId": "teams/get-discussion-comment-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#get-a-discussion-comment-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/comment-number" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-discussion-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-discussion-comment" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" + }, + "deprecated": true, + "x-octokit": {} + }, + "patch": { + "summary": "Update a discussion comment (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["teams"], + "operationId": "teams/update-discussion-comment-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#update-a-discussion-comment-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/comment-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The discussion comment's body text." + } + }, + "required": ["body"] + }, + "example": { "body": "Do you like pineapples?" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-discussion-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-discussion-comment-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" + }, + "deprecated": true, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a discussion comment (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["teams"], + "operationId": "teams/delete-discussion-comment-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#delete-a-discussion-comment-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/comment-number" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "discussion-comments" + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + "get": { + "summary": "List reactions for a team discussion comment (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["reactions"], + "operationId": "reactions/list-for-team-discussion-comment-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/comment-number" }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/reaction" } + }, + "examples": { + "default": { "$ref": "#/components/examples/reaction-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-21", + "deprecationDate": "2020-02-26", + "category": "reactions", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + }, + "post": { + "summary": "Create reaction for a team discussion comment (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.", + "tags": ["reactions"], + "operationId": "reactions/create-for-team-discussion-comment-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/discussion-number" }, + { "$ref": "#/components/parameters/comment-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": ["content"] + }, + "example": { "content": "heart" } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/reaction" }, + "examples": { + "default": { "$ref": "#/components/examples/reaction" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-21", + "deprecationDate": "2020-02-26", + "category": "reactions", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/discussions/{discussion_number}/reactions": { + "get": { + "summary": "List reactions for a team discussion (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["reactions"], + "operationId": "reactions/list-for-team-discussion-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/discussion-number" }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/reaction" } + }, + "examples": { + "default": { "$ref": "#/components/examples/reaction-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-21", + "deprecationDate": "2020-02-26", + "category": "reactions", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + }, + "post": { + "summary": "Create reaction for a team discussion (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.", + "tags": ["reactions"], + "operationId": "reactions/create-for-team-discussion-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/discussion-number" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": ["content"] + }, + "example": { "content": "heart" } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/reaction" }, + "examples": { + "default": { "$ref": "#/components/examples/reaction" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-21", + "deprecationDate": "2020-02-26", + "category": "reactions", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/invitations": { + "get": { + "summary": "List pending team invitations (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", + "tags": ["teams"], + "operationId": "teams/list-pending-invitations-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#list-pending-team-invitations-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-invitation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-invitation-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/members": { + "get": { + "summary": "List team members (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "tags": ["teams"], + "operationId": "teams/list-members-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#list-team-members-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { + "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": ["member", "maintainer", "all"], + "default": "all" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/members/{username}": { + "get": { + "summary": "Get team member (Legacy)", + "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "tags": ["teams"], + "operationId": "teams/get-member-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#get-team-member-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Response if user is a member" }, + "404": { "description": "Response if user is not a member" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true, + "x-octokit": {} + }, + "put": { + "summary": "Add team member (Legacy)", + "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "tags": ["teams"], + "operationId": "teams/add-member-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#add-team-member-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Empty response" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { + "description": "Response if team synchronization is set up" + }, + "422": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { "type": "string" }, + "field": { "type": "string" }, + "resource": { "type": "string" } + } + } + }, + "documentation_url": { + "type": "string", + "example": "\"https://docs.github.com/rest\"" + } + } + }, + "examples": { + "response-if-you-attempt-to-add-an-organization-to-a-team": { + "summary": "Response if you attempt to add an organization to a team", + "value": { + "message": "Cannot add an organization as a member.", + "errors": [ + { + "code": "org", + "field": "user", + "resource": "TeamMember" + } + ] + } + }, + "response-if-you-attempt-to-add-a-user-to-a-team-when-they-are-not-a-member-of-at-least-one-other-team-in-the-same-organization": { + "summary": "Response if you attempt to add a user to a team when they are not a member of at least one other team in the same organization", + "value": { + "message": "User isn't a member of this organization. Please invite them first.", + "errors": [ + { + "code": "unaffiliated", + "field": "user", + "resource": "TeamMember" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true, + "x-octokit": {} + }, + "delete": { + "summary": "Remove team member (Legacy)", + "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "tags": ["teams"], + "operationId": "teams/remove-member-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#remove-team-member-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "description": "Response if team synchronization is setup" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/memberships/{username}": { + "get": { + "summary": "Get team membership for a user (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", + "tags": ["teams"], + "operationId": "teams/get-membership-for-user-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-membership" }, + "examples": { + "response-if-user-has-an-active-membership-with-team": { + "$ref": "#/components/examples/team-membership-response-if-user-has-an-active-membership-with-team" + }, + "response-if-user-is-a-team-maintainer": { + "$ref": "#/components/examples/team-membership-response-if-user-is-a-team-maintainer" + }, + "response-if-user-has-a-pending-membership-with-team": { + "$ref": "#/components/examples/team-membership-response-if-user-has-a-pending-membership-with-team" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true, + "x-octokit": {} + }, + "put": { + "summary": "Add or update team membership for a user (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "tags": ["teams"], + "operationId": "teams/add-or-update-membership-for-user-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/username" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "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"], + "default": "member" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-membership" }, + "examples": { + "response-if-users-membership-with-team-is-now-active": { + "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-active" + }, + "response-if-users-membership-with-team-is-now-pending": { + "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending" + } + } + } + } + }, + "403": { + "description": "Response if team synchronization is set up" + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { + "description": "Response if you attempt to add an organization to a team", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { "type": "string" }, + "field": { "type": "string" }, + "resource": { "type": "string" } + } + } + }, + "documentation_url": { + "type": "string", + "example": "\"https://help.github.com/articles/github-and-trade-controls\"" + } + } + }, + "examples": { + "response-if-you-attempt-to-add-an-organization-to-a-team": { + "value": { + "message": "Cannot add an organization as a member.", + "errors": [ + { + "code": "org", + "field": "user", + "resource": "TeamMember" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true, + "x-octokit": {} + }, + "delete": { + "summary": "Remove team membership for a user (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "tags": ["teams"], + "operationId": "teams/remove-membership-for-user-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/username" } + ], + "responses": { + "204": { "description": "Empty response" }, + "403": { "description": "Response if team synchronization is set up" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/projects": { + "get": { + "summary": "List team projects (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", + "tags": ["teams"], + "operationId": "teams/list-projects-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#list-team-projects-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team-project" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-project-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/projects/{project_id}": { + "get": { + "summary": "Check team permissions for a project (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", + "tags": ["teams"], + "operationId": "teams/check-permissions-for-project-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#check-team-permissions-for-a-project-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/project-id" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/team-project" }, + "examples": { + "default": { "$ref": "#/components/examples/team-project" } + } + } + } + }, + "404": { + "description": "Response if project is not managed by this team" + }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + }, + "put": { + "summary": "Add or update team project permissions (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", + "tags": ["teams"], + "operationId": "teams/add-or-update-project-permissions-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#add-or-update-team-project-permissions-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/project-id" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "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://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "enum": ["read", "write", "admin"] + } + } + } + } + } + }, + "responses": { + "204": { "description": "Empty response" }, + "403": { + "description": "Response if the project is not owned by the organization", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + }, + "examples": { + "response-if-the-project-is-not-owned-by-the-organization": { + "value": { + "message": "Must have admin rights to Repository.", + "documentation_url": "https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions" + } + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a project from a team (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", + "tags": ["teams"], + "operationId": "teams/remove-project-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#remove-a-project-from-a-team-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/project-id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/repos": { + "get": { + "summary": "List team repositories (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint.", + "tags": ["teams"], + "operationId": "teams/list-repos-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#list-team-repositories-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/minimal-repository" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/repos/{owner}/{repo}": { + "get": { + "summary": "Check team permissions for a repository (Legacy)", + "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", + "tags": ["teams"], + "operationId": "teams/check-permissions-for-repo-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#check-team-permissions-for-a-repository-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "Alternative response with extra repository information", + "content": { + "application/vnd.github.v3.repository+json": { + "schema": { "$ref": "#/components/schemas/team-repository" }, + "examples": { + "alternative-response-with-extra-repository-information": { + "$ref": "#/components/examples/team-repository-alternative-response-with-extra-repository-information" + } + } + } + } + }, + "204": { + "description": "Response if repository is managed by this team" + }, + "404": { + "description": "Response if repository is not managed by this team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + }, + "put": { + "summary": "Add or update team repository permissions (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "tags": ["teams"], + "operationId": "teams/add-or-update-repo-permissions-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#add-or-update-team-repository-permissions-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "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.", + "enum": ["pull", "push", "admin"] + } + } + } + } + } + }, + "responses": { + "204": { "description": "Empty response" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a repository from a team (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", + "tags": ["teams"], + "operationId": "teams/remove-repo-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#remove-a-repository-from-a-team-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/team-sync/group-mappings": { + "get": { + "summary": "List IdP groups for a team (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nList IdP groups connected to a team on GitHub.", + "tags": ["teams"], + "operationId": "teams/list-idp-groups-for-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team-legacy" + }, + "parameters": [{ "$ref": "#/components/parameters/team-id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/group-mapping" }, + "examples": { + "default": { "$ref": "#/components/examples/group-mapping-3" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "team-sync" + }, + "deprecated": true, + "x-octokit": {} + }, + "patch": { + "summary": "Create or update IdP group connections (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.", + "tags": ["teams"], + "operationId": "teams/create-or-update-idp-group-connections-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections-legacy" + }, + "parameters": [{ "$ref": "#/components/parameters/team-id" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "groups": { + "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": { + "type": "string", + "description": "ID of the IdP group." + }, + "group_name": { + "type": "string", + "description": "Name of the IdP group." + }, + "group_description": { + "type": "string", + "description": "Description of the IdP group." + }, + "id": { + "type": "string", + "example": "\"caceab43fc9ffa20081c\"" + }, + "name": { + "type": "string", + "example": "\"external-team-6c13e7288ef7\"" + }, + "description": { + "type": "string", + "example": "\"moar cheese pleese\"" + } + }, + "required": [ + "group_id", + "group_name", + "group_description" + ] + } + }, + "synced_at": { + "type": "string", + "example": "\"I am not a timestamp\"" + } + }, + "required": ["groups"] + }, + "example": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "description": "The people who configure your octoworld.", + "group_description": "string" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/group-mapping" }, + "examples": { + "default": { "$ref": "#/components/examples/group-mapping-2" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "team-sync" + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/teams/{team_id}/teams": { + "get": { + "summary": "List child teams (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint.", + "tags": ["teams"], + "operationId": "teams/list-child-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#list-child-teams-legacy" + }, + "parameters": [ + { "$ref": "#/components/parameters/team-id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "Response if child teams exist", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team" } + }, + "examples": { + "response-if-child-teams-exist": { + "$ref": "#/components/examples/team-items-response-if-child-teams-exist" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": null + }, + "deprecated": true, + "x-octokit": {} + } + }, + "/user": { + "get": { + "summary": "Get the authenticated user", + "description": "If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information.\n\nIf the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.", + "tags": ["users"], + "operationId": "users/get-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/users/#get-the-authenticated-user" + }, + "parameters": [], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { "$ref": "#/components/schemas/private-user" }, + { "$ref": "#/components/schemas/public-user" } + ] + }, + "examples": { + "response-with-public-and-private-profile-information": { + "$ref": "#/components/examples/private-user-response-with-public-and-private-profile-information" + }, + "response-with-public-profile-information": { + "$ref": "#/components/examples/private-user-response-with-public-profile-information" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": null + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update the authenticated user", + "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.", + "tags": ["users"], + "operationId": "users/update-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/users/#update-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The new name of the user.", + "type": "string", + "example": "Omar Jahandar" + }, + "email": { + "description": "The publicly visible email address of the user.", + "type": "string", + "example": "omar@example.com" + }, + "blog": { + "description": "The new blog URL of the user.", + "type": "string", + "example": "blog.example.com" + }, + "twitter_username": { + "description": "The new Twitter username of the user.", + "type": "string", + "example": "therealomarj", + "nullable": true + }, + "company": { + "description": "The new company of the user.", + "type": "string", + "example": "Acme corporation" + }, + "location": { + "description": "The new location of the user.", + "type": "string", + "example": "Berlin, Germany" + }, + "hireable": { + "description": "The new hiring availability of the user.", + "type": "boolean" + }, + "bio": { + "description": "The new short biography of the user.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/private-user" }, + "examples": { + "default": { "$ref": "#/components/examples/private-user" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/user/blocks": { + "get": { + "summary": "List users blocked by the authenticated user", + "description": "List the users you've blocked on your personal account.", + "tags": ["users"], + "operationId": "users/list-blocked-by-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user" + }, + "parameters": [], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "blocking" + }, + "x-octokit": {} + } + }, + "/user/blocks/{username}": { + "get": { + "summary": "Check if a user is blocked by the authenticated user", + "description": "", + "tags": ["users"], + "operationId": "users/check-blocked", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user" + }, + "parameters": [{ "$ref": "#/components/parameters/username" }], + "responses": { + "204": { "description": "If the user is blocked:" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { + "description": "If the user is not blocked:", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "blocking" + }, + "x-octokit": {} + }, + "put": { + "summary": "Block a user", + "description": "", + "tags": ["users"], + "operationId": "users/block", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#block-a-user" + }, + "parameters": [{ "$ref": "#/components/parameters/username" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "blocking" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Unblock a user", + "description": "", + "tags": ["users"], + "operationId": "users/unblock", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#unblock-a-user" + }, + "parameters": [{ "$ref": "#/components/parameters/username" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "blocking" + }, + "x-octokit": {} + } + }, + "/user/email/visibility": { + "patch": { + "summary": "Set primary email visibility for the authenticated user", + "description": "Sets the visibility for your primary email addresses.", + "tags": ["users"], + "operationId": "users/set-primary-email-visibility-for-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "email": { + "description": "An email address associated with the GitHub user account to manage.", + "type": "string", + "example": "org@example.com" + }, + "visibility": { + "description": "Denotes whether an email is publically visible.", + "type": "string", + "enum": ["public", "private"] + } + }, + "required": ["email", "visibility"], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/email" } + }, + "examples": { + "default": { "$ref": "#/components/examples/email-items-3" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "emails" + }, + "x-octokit": {} + } + }, + "/user/emails": { + "get": { + "summary": "List email addresses for the authenticated user", + "description": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.", + "tags": ["users"], + "operationId": "users/list-emails-for-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/email" } + }, + "examples": { + "default": { "$ref": "#/components/examples/email-items-2" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "emails" + }, + "x-octokit": {} + }, + "post": { + "summary": "Add an email address for the authenticated user", + "description": "This endpoint is accessible with the `user` scope.", + "tags": ["users"], + "operationId": "users/add-email-for-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "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", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + }, + "example": [] + } + }, + "required": ["emails"], + "example": { + "emails": ["octocat@github.com", "mona@github.com"] + } + }, + { + "type": "array", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + } + }, + { "type": "string" } + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/email" } + }, + "examples": { + "default": { "$ref": "#/components/examples/email-items" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "emails" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an email address for the authenticated user", + "description": "This endpoint is accessible with the `user` scope.", + "tags": ["users"], + "operationId": "users/delete-email-for-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "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.", + "properties": { + "emails": { + "description": "Email addresses associated with the GitHub user account.", + "type": "array", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + } + } + }, + "example": { + "emails": ["octocat@github.com", "mona@github.com"] + }, + "required": ["emails"] + }, + { + "type": "array", + "items": { + "type": "string", + "example": "username@example.com", + "minItems": 1 + } + }, + { "type": "string" } + ] + } + } + } + }, + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "emails" + }, + "x-octokit": {} + } + }, + "/user/followers": { + "get": { + "summary": "List followers of the authenticated user", + "description": "Lists the people following the authenticated user.", + "tags": ["users"], + "operationId": "users/list-followers-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-followers-of-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "followers" + }, + "x-octokit": {} + } + }, + "/user/following": { + "get": { + "summary": "List the people the authenticated user follows", + "description": "Lists the people who the authenticated user follows.", + "tags": ["users"], + "operationId": "users/list-followed-by-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "followers" + }, + "x-octokit": {} + } + }, + "/user/following/{username}": { + "get": { + "summary": "Check if a person is followed by the authenticated user", + "description": "", + "tags": ["users"], + "operationId": "users/check-person-is-followed-by-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user" + }, + "parameters": [{ "$ref": "#/components/parameters/username" }], + "responses": { + "204": { + "description": "Response if the person is followed by the authenticated user" + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { + "description": "Response if the person is not followed by the authenticated user", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "followers" + }, + "x-octokit": {} + }, + "put": { + "summary": "Follow a user", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nFollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", + "tags": ["users"], + "operationId": "users/follow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#follow-a-user" + }, + "parameters": [{ "$ref": "#/components/parameters/username" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "followers" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Unfollow a user", + "description": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", + "tags": ["users"], + "operationId": "users/unfollow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#unfollow-a-user" + }, + "parameters": [{ "$ref": "#/components/parameters/username" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "followers" + }, + "x-octokit": {} + } + }, + "/user/gpg_keys": { + "get": { + "summary": "List GPG keys for the authenticated user", + "description": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["users"], + "operationId": "users/list-gpg-keys-for-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/gpg-key" } + }, + "examples": { + "default": { "$ref": "#/components/examples/gpg-key-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "gpg-keys" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a GPG key for the authenticated user", + "description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "users/create-gpg-key-for-authenticated", + "tags": ["users"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#create-a-gpg-key-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "armored_public_key": { + "description": "A GPG key in ASCII-armored format.", + "type": "string" + } + }, + "type": "object", + "required": ["armored_public_key"] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gpg-key" }, + "examples": { + "default": { "$ref": "#/components/examples/gpg-key" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "gpg-keys" + }, + "x-octokit": {} + } + }, + "/user/gpg_keys/{gpg_key_id}": { + "get": { + "summary": "Get a GPG key for the authenticated user", + "description": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["users"], + "operationId": "users/get-gpg-key-for-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user" + }, + "parameters": [{ "$ref": "#/components/parameters/gpg_key_id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gpg-key" }, + "examples": { + "default": { "$ref": "#/components/examples/gpg-key" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "gpg-keys" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a GPG key for the authenticated user", + "description": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["users"], + "operationId": "users/delete-gpg-key-for-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user" + }, + "parameters": [{ "$ref": "#/components/parameters/gpg_key_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "gpg-keys" + }, + "x-octokit": {} + } + }, + "/user/installations": { + "get": { + "summary": "List app installations accessible to the user access token", + "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", + "tags": ["apps"], + "operationId": "apps/list-installations-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "You can find the permissions for the installation under the `permissions` key.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "installations"], + "properties": { + "total_count": { "type": "integer" }, + "installations": { + "type": "array", + "items": { "$ref": "#/components/schemas/installation" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/base-installation-for-auth-user-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "415": { "$ref": "#/components/responses/preview_header_missing" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "installations" + }, + "x-octokit": {} + } + }, + "/user/installations/{installation_id}/repositories": { + "get": { + "summary": "List repositories accessible to the user access token", + "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.", + "tags": ["apps"], + "operationId": "apps/list-installation-repos-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-user-access-token" + }, + "parameters": [ + { "$ref": "#/components/parameters/installation_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "The access the user has to each repository is included in the hash under the `permissions` key.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["total_count", "repositories"], + "properties": { + "total_count": { "type": "integer" }, + "repository_selection": { "type": "string" }, + "repositories": { + "type": "array", + "items": { "$ref": "#/components/schemas/repository" } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": false, + "name": "mercy", + "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "x-octokit": {} + } + }, + "/user/installations/{installation_id}/repositories/{repository_id}": { + "put": { + "summary": "Add a repository to an app installation", + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/add-repo-to-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation" + }, + "parameters": [ + { "$ref": "#/components/parameters/installation_id" }, + { "$ref": "#/components/parameters/repository_id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "installations" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a repository from an app installation", + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/remove-repo-from-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation" + }, + "parameters": [ + { "$ref": "#/components/parameters/installation_id" }, + { "$ref": "#/components/parameters/repository_id" } + ], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "installations" + }, + "x-octokit": {} + } + }, + "/user/interaction-limits": { + "get": { + "summary": "Get interaction restrictions for your public repositories", + "description": "Shows which type of GitHub user can interact with your public repositories and when the restriction expires. If there are no restrictions, you will see an empty response.", + "tags": ["interactions"], + "operationId": "interactions/get-restrictions-for-your-public-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories" + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interaction-limit-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/interaction-limit-user" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "interactions", + "subcategory": "user" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set interaction restrictions for your public repositories", + "description": "Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.", + "tags": ["interactions"], + "operationId": "interactions/set-restrictions-for-your-public-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/interaction-limit" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interaction-limit-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/interaction-limit-user" + } + } + } + } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "interactions", + "subcategory": "user" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove interaction restrictions from your public repositories", + "description": "Removes any interaction restrictions from your public repositories.", + "tags": ["interactions"], + "operationId": "interactions/remove-restrictions-for-your-public-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories" + }, + "responses": { "204": { "description": "Empty response" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "interactions", + "subcategory": "user" + }, + "x-octokit": {} + } + }, + "/user/issues": { + "get": { + "summary": "List user account issues assigned to the authenticated user", + "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", + "tags": ["issues"], + "operationId": "issues/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/issues/#list-user-account-issues-assigned-to-the-authenticated-user" + }, + "parameters": [ + { + "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "default": "assigned" + } + }, + { + "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": ["open", "closed", "all"], + "default": "open" + } + }, + { "$ref": "#/components/parameters/labels" }, + { + "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["created", "updated", "comments"], + "default": "created" + } + }, + { "$ref": "#/components/parameters/direction" }, + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/issue" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-with-repo-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions." + } + ], + "category": "issues", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/user/keys": { + "get": { + "summary": "List public SSH keys for the authenticated user", + "description": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["users"], + "operationId": "users/list-public-ssh-keys-for-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/key" } + }, + "examples": { + "default": { "$ref": "#/components/examples/key-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "keys" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a public SSH key for the authenticated user", + "description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "users/create-public-ssh-key-for-authenticated", + "tags": ["users"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "A descriptive name for the new key.", + "type": "string", + "example": "Personal MacBook Air" + }, + "key": { + "description": "The public SSH key to add to your GitHub account.", + "type": "string", + "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) " + } + }, + "required": ["key"], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/key" }, + "examples": { + "default": { "$ref": "#/components/examples/key" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "keys" + }, + "x-octokit": {} + } + }, + "/user/keys/{key_id}": { + "get": { + "summary": "Get a public SSH key for the authenticated user", + "description": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["users"], + "operationId": "users/get-public-ssh-key-for-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user" + }, + "parameters": [{ "$ref": "#/components/parameters/key_id" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/key" }, + "examples": { + "default": { "$ref": "#/components/examples/key" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "keys" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a public SSH key for the authenticated user", + "description": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": ["users"], + "operationId": "users/delete-public-ssh-key-for-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user" + }, + "parameters": [{ "$ref": "#/components/parameters/key_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "keys" + }, + "x-octokit": {} + } + }, + "/user/marketplace_purchases": { + "get": { + "summary": "List subscriptions for the authenticated user", + "description": "Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/).", + "tags": ["apps"], + "operationId": "apps/list-subscriptions-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/user-marketplace-purchase" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-marketplace-purchase-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "marketplace" + }, + "x-octokit": {} + } + }, + "/user/marketplace_purchases/stubbed": { + "get": { + "summary": "List subscriptions for the authenticated user (stubbed)", + "description": "Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/).", + "tags": ["apps"], + "operationId": "apps/list-subscriptions-for-authenticated-user-stubbed", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user-stubbed" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/user-marketplace-purchase" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-marketplace-purchase-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": "marketplace" + }, + "x-octokit": {} + } + }, + "/user/memberships/orgs": { + "get": { + "summary": "List organization memberships for the authenticated user", + "description": "", + "tags": ["orgs"], + "operationId": "orgs/list-memberships-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user" + }, + "parameters": [ + { + "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"] } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/org-membership" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-membership-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + } + }, + "/user/memberships/orgs/{org}": { + "get": { + "summary": "Get an organization membership for the authenticated user", + "description": "", + "tags": ["orgs"], + "operationId": "orgs/get-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/org-membership" }, + "examples": { + "default": { "$ref": "#/components/examples/org-membership" } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update an organization membership for the authenticated user", + "description": "", + "tags": ["orgs"], + "operationId": "orgs/update-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user" + }, + "parameters": [{ "$ref": "#/components/parameters/org" }], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", + "enum": ["active"] + } + }, + "required": ["state"] + }, + "example": { "state": "active" } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/org-membership" }, + "examples": { + "default": { + "$ref": "#/components/examples/org-membership-2" + } + } + } + } + }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "x-octokit": {} + } + }, + "/user/migrations": { + "get": { + "summary": "List user migrations", + "description": "Lists all migrations a user has started.", + "tags": ["migrations"], + "operationId": "migrations/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#list-user-migrations" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/migration" } + }, + "examples": { + "default": { "$ref": "#/components/examples/migration-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "wyandotte", + "note": "To access the Migrations API, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.wyandotte-preview+json\n```" + } + ], + "category": "migrations", + "subcategory": "users" + }, + "x-octokit": {} + }, + "post": { + "summary": "Start a user migration", + "description": "Initiates the generation of a user migration archive.", + "tags": ["migrations"], + "operationId": "migrations/start-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#start-a-user-migration" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "lock_repositories": { + "description": "Lock the repositories being migrated at the start of the migration", + "example": true, + "readOnly": false, + "type": "boolean" + }, + "exclude_attachments": { + "description": "Do not include attachments in the migration", + "example": true, + "readOnly": false, + "type": "boolean" + }, + "exclude": { + "description": "Exclude attributes from the API response to improve performance", + "example": ["repositories"], + "readOnly": false, + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": ["repositories"], + "example": "repositories", + "type": "string" + } + }, + "repositories": { + "type": "array", + "items": { + "description": "Repository path, owner and name", + "example": "acme/widgets", + "type": "string" + } + } + }, + "required": ["repositories"], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/migration" }, + "examples": { + "default": { "$ref": "#/components/examples/migration-2" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "migrations", + "subcategory": "users" + }, + "x-octokit": {} + } + }, + "/user/migrations/{migration_id}": { + "get": { + "summary": "Get a user migration status", + "description": "Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:\n\n* `pending` - the migration hasn't started yet.\n* `exporting` - the migration is in progress.\n* `exported` - the migration finished successfully.\n* `failed` - the migration failed.\n\nOnce the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive).", + "tags": ["migrations"], + "operationId": "migrations/get-status-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#get-a-user-migration-status" + }, + "parameters": [ + { "$ref": "#/components/parameters/migration_id" }, + { + "name": "exclude", + "in": "query", + "required": false, + "schema": { "type": "array", "items": { "type": "string" } } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/migration" }, + "examples": { + "default": { "$ref": "#/components/examples/migration" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "wyandotte", + "note": "To access the Migrations API, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.wyandotte-preview+json\n```" + } + ], + "category": "migrations", + "subcategory": "users" + }, + "x-octokit": {} + } + }, + "/user/migrations/{migration_id}/archive": { + "get": { + "summary": "Download a user migration archive", + "description": "Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:\n\n* attachments\n* bases\n* commit\\_comments\n* issue\\_comments\n* issue\\_events\n* issues\n* milestones\n* organizations\n* projects\n* protected\\_branches\n* pull\\_request\\_reviews\n* pull\\_requests\n* releases\n* repositories\n* review\\_comments\n* schema\n* users\n\nThe archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data.", + "tags": ["migrations"], + "operationId": "migrations/get-archive-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive" + }, + "parameters": [{ "$ref": "#/components/parameters/migration_id" }], + "responses": { + "302": { "description": "response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "wyandotte", + "note": "To access the Migrations API, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.wyandotte-preview+json\n```" + } + ], + "category": "migrations", + "subcategory": "users" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a user migration archive", + "description": "Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.", + "tags": ["migrations"], + "operationId": "migrations/delete-archive-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#delete-a-user-migration-archive" + }, + "parameters": [{ "$ref": "#/components/parameters/migration_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "wyandotte", + "note": "To access the Migrations API, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.wyandotte-preview+json\n```" + } + ], + "category": "migrations", + "subcategory": "users" + }, + "x-octokit": {} + } + }, + "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + "delete": { + "summary": "Unlock a user repository", + "description": "Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.", + "tags": ["migrations"], + "operationId": "migrations/unlock-repo-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#unlock-a-user-repository" + }, + "parameters": [ + { "$ref": "#/components/parameters/migration_id" }, + { "$ref": "#/components/parameters/repo_name" } + ], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "wyandotte", + "note": "To access the Migrations API, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.wyandotte-preview+json\n```" + } + ], + "category": "migrations", + "subcategory": "users" + }, + "x-octokit": {} + } + }, + "/user/migrations/{migration_id}/repositories": { + "get": { + "summary": "List repositories for a user migration", + "description": "Lists all the repositories for this user migration.", + "tags": ["migrations"], + "operationId": "migrations/list-repos-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration" + }, + "parameters": [ + { "$ref": "#/components/parameters/migration_id" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/minimal-repository" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "wyandotte", + "note": "To access the Migrations API, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.wyandotte-preview+json\n```" + } + ], + "category": "migrations", + "subcategory": "users" + }, + "x-octokit": {} + } + }, + "/user/orgs": { + "get": { + "summary": "List organizations for the authenticated user", + "description": "List organizations for the authenticated user.\n\n**OAuth scope requirements**\n\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.", + "tags": ["orgs"], + "operationId": "orgs/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/orgs/#list-organizations-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "orgs", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/user/projects": { + "post": { + "summary": "Create a user project", + "description": "", + "tags": ["projects"], + "operationId": "projects/create-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/projects/#create-a-user-project" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the project", + "example": "Week One Sprint", + "type": "string" + }, + "body": { + "description": "Body of the project", + "example": "This project represents the sprint of the first week in January", + "type": "string", + "nullable": true + } + }, + "required": ["name"], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/project" }, + "examples": { + "default": { "$ref": "#/components/examples/project" } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed_simple" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/user/public_emails": { + "get": { + "summary": "List public email addresses for the authenticated user", + "description": "Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.", + "tags": ["users"], + "operationId": "users/list-public-emails-for-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/email" } + }, + "examples": { + "default": { "$ref": "#/components/examples/email-items-2" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "emails" + }, + "x-octokit": {} + } + }, + "/user/repos": { + "get": { + "summary": "List repositories for the authenticated user", + "description": "Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.", + "tags": ["repos"], + "operationId": "repos/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#list-repositories-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "visibility", + "description": "Can be one of `all`, `public`, or `private`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["all", "public", "private"], + "default": "all" + } + }, + { + "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" + } + }, + { + "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": ["all", "owner", "public", "private", "member"], + "default": "all" + } + }, + { + "name": "sort", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["created", "updated", "pushed", "full_name"], + "default": "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"] } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" }, + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/before" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/repository" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-items-default-response" + } + } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a repository for the authenticated user", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "tags": ["repos"], + "operationId": "repos/create-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#create-a-repository-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "description": { + "description": "A short description of the repository.", + "type": "string" + }, + "homepage": { + "description": "A URL with more information about the repository.", + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "team_id": { + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", + "type": "integer" + }, + "auto_init": { + "description": "Whether the repository is initialized with a minimal README.", + "default": false, + "type": "boolean" + }, + "gitignore_template": { + "description": "The desired language or platform to apply to the .gitignore.", + "example": "Haskell", + "type": "string" + }, + "license_template": { + "description": "The license keyword of the open source license for this repository.", + "example": "mit", + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + } + }, + "required": ["name"], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/repository" }, + "examples": { + "default": { "$ref": "#/components/examples/repository" } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World", + "schema": { "type": "string" } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "400": { "$ref": "#/components/responses/bad_request" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": false, + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + }, + { + "required": false, + "name": "baptiste", + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/user/repository_invitations": { + "get": { + "summary": "List repository invitations for the authenticated user", + "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.", + "tags": ["repos"], + "operationId": "repos/list-invitations-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#list-repository-invitations-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-invitation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-invitation-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "repos", + "subcategory": "invitations" + }, + "x-octokit": {} + } + }, + "/user/repository_invitations/{invitation_id}": { + "patch": { + "summary": "Accept a repository invitation", + "description": "", + "tags": ["repos"], + "operationId": "repos/accept-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#accept-a-repository-invitation" + }, + "parameters": [{ "$ref": "#/components/parameters/invitation_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "409": { "$ref": "#/components/responses/conflict" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "repos", + "subcategory": "invitations" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Decline a repository invitation", + "description": "", + "tags": ["repos"], + "operationId": "repos/decline-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#decline-a-repository-invitation" + }, + "parameters": [{ "$ref": "#/components/parameters/invitation_id" }], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" }, + "409": { "$ref": "#/components/responses/conflict" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "repos", + "subcategory": "invitations" + }, + "x-octokit": {} + } + }, + "/user/starred": { + "get": { + "summary": "List repositories starred by the authenticated user", + "description": "Lists repositories the authenticated user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", + "tags": ["activity"], + "operationId": "activity/list-repos-starred-by-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/sort" }, + { "$ref": "#/components/parameters/direction" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/repository" } + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/repository-items-default-response" + } + } + }, + "application/vnd.github.v3.star+json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/starred-repository" } + }, + "examples": { + "alternative-response-with-star-creation-timestamps": { + "$ref": "#/components/examples/starred-repository-items-alternative-response-with-star-creation-timestamps" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "starring" + }, + "x-octokit": {} + } + }, + "/user/starred/{owner}/{repo}": { + "get": { + "summary": "Check if a repository is starred by the authenticated user", + "description": "", + "tags": ["activity"], + "operationId": "activity/check-repo-is-starred-by-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "204": { + "description": "Response if this repository is starred by you" + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { + "description": "Response if this repository is not starred by you", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "starring" + }, + "x-octokit": {} + }, + "put": { + "summary": "Star a repository for the authenticated user", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "tags": ["activity"], + "operationId": "activity/star-repo-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#star-a-repository-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "starring" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Unstar a repository for the authenticated user", + "description": "", + "tags": ["activity"], + "operationId": "activity/unstar-repo-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#unstar-a-repository-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "204": { "description": "Empty response" }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "starring" + }, + "x-octokit": {} + } + }, + "/user/subscriptions": { + "get": { + "summary": "List repositories watched by the authenticated user", + "description": "Lists repositories the authenticated user is watching.", + "tags": ["activity"], + "operationId": "activity/list-watched-repos-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-repositories-watched-by-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/minimal-repository" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "401": { "$ref": "#/components/responses/requires_authentication" }, + "403": { "$ref": "#/components/responses/forbidden" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "watching" + }, + "x-octokit": {} + } + }, + "/user/teams": { + "get": { + "summary": "List teams for the authenticated user", + "description": "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/).", + "tags": ["teams"], + "operationId": "teams/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/teams/#list-teams-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/team-full" } + }, + "examples": { + "default": { "$ref": "#/components/examples/team-full-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "304": { "$ref": "#/components/responses/not_modified" }, + "403": { "$ref": "#/components/responses/forbidden" }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "teams", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/users": { + "get": { + "summary": "List users", + "description": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users.", + "tags": ["users"], + "operationId": "users/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/users/#list-users" + }, + "parameters": [ + { "$ref": "#/components/parameters/since-user" }, + { "$ref": "#/components/parameters/per_page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { "type": "string" } + } + } + }, + "304": { "$ref": "#/components/responses/not_modified" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "users", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/users/{username}": { + "get": { + "summary": "Get a user", + "description": "Provides publicly available information about someone with a GitHub account.\n\nGitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)\" for details about authentication. For an example response, see 'Response with GitHub plan information' below\"\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/rest/reference/users#emails)\".", + "tags": ["users"], + "operationId": "users/get-by-username", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/users/#get-a-user" + }, + "parameters": [{ "$ref": "#/components/parameters/username" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { "$ref": "#/components/schemas/private-user" }, + { "$ref": "#/components/schemas/public-user" } + ] + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/public-user-default-response" + }, + "response-with-git-hub-plan-information": { + "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" + } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "users", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/users/{username}/events": { + "get": { + "summary": "List events for the authenticated user", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "tags": ["activity"], + "operationId": "activity/list-events-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-events-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/event" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/users/{username}/events/orgs/{org}": { + "get": { + "summary": "List organization events for the authenticated user", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "tags": ["activity"], + "operationId": "activity/list-org-events-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-organization-events-for-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/org" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/event" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/users/{username}/events/public": { + "get": { + "summary": "List public events for a user", + "description": "", + "tags": ["activity"], + "operationId": "activity/list-public-events-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-public-events-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/event" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/users/{username}/followers": { + "get": { + "summary": "List followers of a user", + "description": "Lists the people following the specified user.", + "tags": ["users"], + "operationId": "users/list-followers-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-followers-of-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "users", + "subcategory": "followers" + }, + "x-octokit": {} + } + }, + "/users/{username}/following": { + "get": { + "summary": "List the people a user follows", + "description": "Lists the people who the specified user follows.", + "tags": ["users"], + "operationId": "users/list-following-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-the-people-a-user-follows" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "users", + "subcategory": "followers" + }, + "x-octokit": {} + } + }, + "/users/{username}/following/{target_user}": { + "get": { + "summary": "Check if a user follows another user", + "description": "", + "tags": ["users"], + "operationId": "users/check-following-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#check-if-a-user-follows-another-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { + "name": "target_user", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "204": { + "description": "Response if the user follows the target user" + }, + "404": { + "description": "Response if the user does not follow the target user" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "users", + "subcategory": "followers" + }, + "x-octokit": {} + } + }, + "/users/{username}/gists": { + "get": { + "summary": "List gists for a user", + "description": "Lists public gists for the specified user:", + "tags": ["gists"], + "operationId": "gists/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/gists/#list-gists-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/since" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/base-gist" } + }, + "examples": { + "default": { "$ref": "#/components/examples/base-gist-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/users/{username}/gpg_keys": { + "get": { + "summary": "List GPG keys for a user", + "description": "Lists the GPG keys for a user. This information is accessible by anyone.", + "tags": ["users"], + "operationId": "users/list-gpg-keys-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-gpg-keys-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/gpg-key" } + }, + "examples": { + "default": { "$ref": "#/components/examples/gpg-key-items" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "users", + "subcategory": "gpg-keys" + }, + "x-octokit": {} + } + }, + "/users/{username}/hovercard": { + "get": { + "summary": "Get contextual information for a user", + "description": "Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:\n\n```shell\n curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n```", + "tags": ["users"], + "operationId": "users/get-context-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/users/#get-contextual-information-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { + "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": ["organization", "repository", "issue", "pull_request"] + } + }, + { + "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" } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/hovercard" }, + "examples": { + "default": { "$ref": "#/components/examples/hovercard" } + } + } + } + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/users/{username}/installation": { + "get": { + "summary": "Get a user installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": ["apps"], + "operationId": "apps/get-user-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/apps/#get-a-user-installation-for-the-authenticated-app" + }, + "parameters": [{ "$ref": "#/components/parameters/username" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/installation" }, + "examples": { + "default": { "$ref": "#/components/examples/installation" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/users/{username}/keys": { + "get": { + "summary": "List public keys for a user", + "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.", + "tags": ["users"], + "operationId": "users/list-public-keys-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-public-keys-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/key-simple" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/key-simple-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "users", + "subcategory": "keys" + }, + "x-octokit": {} + } + }, + "/users/{username}/orgs": { + "get": { + "summary": "List organizations for a user", + "description": "List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", + "tags": ["orgs"], + "operationId": "orgs/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/orgs/#list-organizations-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/users/{username}/projects": { + "get": { + "summary": "List user projects", + "description": "", + "tags": ["projects"], + "operationId": "projects/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/projects/#list-user-projects" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { + "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": ["open", "closed", "all"], + "default": "open" + } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/project" } + }, + "examples": { + "default": { "$ref": "#/components/examples/project-items-3" } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + }, + "415": { "$ref": "#/components/responses/preview_header_missing" }, + "422": { "$ref": "#/components/responses/validation_failed" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/users/{username}/received_events": { + "get": { + "summary": "List events received by the authenticated user", + "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "tags": ["activity"], + "operationId": "activity/list-received-events-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-events-received-by-the-authenticated-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/event" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/users/{username}/received_events/public": { + "get": { + "summary": "List public events received by a user", + "description": "", + "tags": ["activity"], + "operationId": "activity/list-received-public-events-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/event" } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/users/{username}/repos": { + "get": { + "summary": "List repositories for a user", + "description": "Lists public repositories for the specified user.", + "tags": ["repos"], + "operationId": "repos/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/repos/#list-repositories-for-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { + "name": "type", + "description": "Can be one of `all`, `owner`, `member`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["all", "owner", "member"], + "default": "owner" + } + }, + { + "name": "sort", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["created", "updated", "pushed", "full_name"], + "default": "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"] } + }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/minimal-repository" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/users/{username}/settings/billing/actions": { + "get": { + "summary": "Get GitHub Actions billing for a user", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `user` scope.", + "operationId": "billing/get-github-actions-billing-user", + "tags": ["billing"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/billing/#get-github-actions-billing-for-a-user" + }, + "parameters": [{ "$ref": "#/components/parameters/username" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-billing-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-billing-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "billing", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/users/{username}/settings/billing/packages": { + "get": { + "summary": "Get GitHub Packages billing for a user", + "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `user` scope.", + "operationId": "billing/get-github-packages-billing-user", + "tags": ["billing"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/billing/#get-github-packages-billing-for-a-user" + }, + "parameters": [{ "$ref": "#/components/parameters/username" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/packages-billing-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/packages-billing-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "billing", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/users/{username}/settings/billing/shared-storage": { + "get": { + "summary": "Get shared storage billing for a user", + "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `user` scope.", + "operationId": "billing/get-shared-storage-billing-user", + "tags": ["billing"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/v3/billing/#get-shared-storage-billing-for-a-user" + }, + "parameters": [{ "$ref": "#/components/parameters/username" }], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/combined-billing-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/combined-billing-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "billing", + "subcategory": null + }, + "x-octokit": {} + } + }, + "/users/{username}/starred": { + "get": { + "summary": "List repositories starred by a user", + "description": "Lists repositories a user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", + "tags": ["activity"], + "operationId": "activity/list-repos-starred-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/sort" }, + { "$ref": "#/components/parameters/direction" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/repository" } + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/repository-items-default-response" + } + } + }, + "application/vnd.github.v3.star+json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/starred-repository" } + }, + "examples": { + "alternative-response-with-star-creation-timestamps": { + "$ref": "#/components/examples/starred-repository-items-alternative-response-with-star-creation-timestamps" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "starring" + }, + "x-octokit": {} + } + }, + "/users/{username}/subscriptions": { + "get": { + "summary": "List repositories watched by a user", + "description": "Lists repositories a user is watching.", + "tags": ["activity"], + "operationId": "activity/list-repos-watched-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/activity#list-repositories-watched-by-a-user" + }, + "parameters": [ + { "$ref": "#/components/parameters/username" }, + { "$ref": "#/components/parameters/per_page" }, + { "$ref": "#/components/parameters/page" } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "$ref": "#/components/schemas/minimal-repository" } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { "Link": { "$ref": "#/components/headers/link" } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "watching" + }, + "x-octokit": {} + } + }, + "/zen": { + "get": { + "summary": "Get the Zen of GitHub", + "description": "Get a random sentence from the Zen of GitHub", + "tags": ["meta"], + "operationId": "meta/get-zen", + "responses": { + "200": { + "description": "response", + "content": { "text/plain": { "schema": { "type": "string" } } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "meta" + }, + "x-octokit": {} + } + } + }, + "components": { + "schemas": { + "simple-user": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { "type": "string", "example": "octocat" }, + "id": { "type": "integer", "example": 1 }, + "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { "type": "string", "example": "User" }, + "site_admin": { "type": "boolean" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "integration": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "owner": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { "type": "string" }, + "checks": { "type": "string" }, + "metadata": { "type": "string" }, + "contents": { "type": "string" }, + "deployments": { "type": "string" } + }, + "additionalProperties": { "type": "string" }, + "example": { "issues": "read", "deployments": "write" } + }, + "events": { + "description": "The list of events for the GitHub app", + "example": ["label", "deployment"], + "type": "array", + "items": { "type": "string" } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "example": 5, + "type": "integer" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "client_secret": { + "type": "string", + "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + }, + "webhook_secret": { + "type": "string", + "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + }, + "pem": { + "type": "string", + "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ], + "additionalProperties": true + }, + "basic-error": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + }, + "validation-error-simple": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": ["message", "documentation_url"], + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" }, + "errors": { "type": "array", "items": { "type": "string" } } + } + }, + "webhook-config-url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" + }, + "webhook-config-content-type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" + }, + "webhook-config-secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" + }, + "webhook-config-insecure-ssl": { + "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.**", + "example": "\"0\"" + }, + "webhook-config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", + "type": "object", + "properties": { + "url": { "$ref": "#/components/schemas/webhook-config-url" }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { "$ref": "#/components/schemas/webhook-config-secret" }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + } + } + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise account", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { "type": "string", "format": "uri" } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "account": { + "nullable": true, + "anyOf": [ + { "$ref": "#/components/schemas/simple-user" }, + { "$ref": "#/components/schemas/enterprise" } + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": ["all", "selected"] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/installations/1/access_tokens" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/installation/repositories" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/organizations/github/settings/installations/1" + }, + "app_id": { "type": "integer", "example": 1 }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { "type": "string", "example": "Organization" }, + "permissions": { + "type": "object", + "example": { "issues": "read", "deployments": "write" }, + "properties": { + "deployments": { "type": "string" }, + "checks": { "type": "string" }, + "metadata": { "type": "string" }, + "contents": { "type": "string" }, + "pull_requests": { "type": "string" }, + "statuses": { "type": "string" }, + "issues": { "type": "string", "example": "\"read\"" }, + "organization_administration": { + "type": "string", + "example": "\"read\"" + } + } + }, + "events": { "type": "array", "items": { "type": "string" } }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" }, + "single_file_name": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "has_multiple_single_files": { "type": "boolean", "example": true }, + "single_file_paths": { + "type": "array", + "items": { "type": "string" }, + "example": ["config.yml", ".github/issue_TEMPLATE.md"] + }, + "app_slug": { "type": "string", "example": "github-actions" }, + "suspended_by": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "contact_email": { + "type": "string", + "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", + "nullable": true + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at" + ] + }, + "app-permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user-to-server access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "content_references": { + "type": "string", + "description": "The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.", + "enum": ["read", "write", "admin"] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`.", + "enum": ["read"] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.", + "enum": ["write"] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.", + "enum": ["read"] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.", + "enum": ["read", "write", "admin"] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.", + "enum": ["read", "write"] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "license-simple": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { "type": "string", "example": "mit" }, + "name": { "type": "string", "example": "MIT License" }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { "type": "string", "nullable": true, "example": "MIT" }, + "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, + "html_url": { "type": "string", "format": "uri" } + }, + "required": ["key", "name", "url", "spdx_id", "node_id"] + }, + "repository": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "license": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/license-simple" }] + }, + "forks": { "type": "integer" }, + "permissions": { + "type": "object", + "properties": { + "admin": { "type": "boolean" }, + "pull": { "type": "boolean" }, + "triage": { "type": "boolean" }, + "push": { "type": "boolean" }, + "maintain": { "type": "boolean" } + }, + "required": ["admin", "pull", "push"] + }, + "owner": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { "type": "boolean" }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { "type": "string", "nullable": true }, + "forks_count": { "type": "integer", "example": 9 }, + "stargazers_count": { "type": "integer", "example": 80 }, + "watchers_count": { "type": "integer", "example": 80 }, + "size": { "type": "integer", "example": 108 }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { "type": "integer", "example": 0 }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { "type": "array", "items": { "type": "string" } }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { "type": "boolean" }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "name": { "type": "string" }, + "full_name": { "type": "string" }, + "owner": { + "type": "object", + "properties": { + "login": { "type": "string" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "avatar_url": { "type": "string" }, + "gravatar_id": { "type": "string" }, + "url": { "type": "string" }, + "html_url": { "type": "string" }, + "followers_url": { "type": "string" }, + "following_url": { "type": "string" }, + "gists_url": { "type": "string" }, + "starred_url": { "type": "string" }, + "subscriptions_url": { "type": "string" }, + "organizations_url": { "type": "string" }, + "repos_url": { "type": "string" }, + "events_url": { "type": "string" }, + "received_events_url": { "type": "string" }, + "type": { "type": "string" }, + "site_admin": { "type": "boolean" } + } + }, + "private": { "type": "boolean" }, + "html_url": { "type": "string" }, + "description": { "type": "string" }, + "fork": { "type": "boolean" }, + "url": { "type": "string" }, + "archive_url": { "type": "string" }, + "assignees_url": { "type": "string" }, + "blobs_url": { "type": "string" }, + "branches_url": { "type": "string" }, + "collaborators_url": { "type": "string" }, + "comments_url": { "type": "string" }, + "commits_url": { "type": "string" }, + "compare_url": { "type": "string" }, + "contents_url": { "type": "string" }, + "contributors_url": { "type": "string" }, + "deployments_url": { "type": "string" }, + "downloads_url": { "type": "string" }, + "events_url": { "type": "string" }, + "forks_url": { "type": "string" }, + "git_commits_url": { "type": "string" }, + "git_refs_url": { "type": "string" }, + "git_tags_url": { "type": "string" }, + "git_url": { "type": "string" }, + "issue_comment_url": { "type": "string" }, + "issue_events_url": { "type": "string" }, + "issues_url": { "type": "string" }, + "keys_url": { "type": "string" }, + "labels_url": { "type": "string" }, + "languages_url": { "type": "string" }, + "merges_url": { "type": "string" }, + "milestones_url": { "type": "string" }, + "notifications_url": { "type": "string" }, + "pulls_url": { "type": "string" }, + "releases_url": { "type": "string" }, + "ssh_url": { "type": "string" }, + "stargazers_url": { "type": "string" }, + "statuses_url": { "type": "string" }, + "subscribers_url": { "type": "string" }, + "subscription_url": { "type": "string" }, + "tags_url": { "type": "string" }, + "teams_url": { "type": "string" }, + "trees_url": { "type": "string" }, + "clone_url": { "type": "string" }, + "mirror_url": { "type": "string" }, + "hooks_url": { "type": "string" }, + "svn_url": { "type": "string" }, + "homepage": { "type": "string" }, + "language": { "type": "string" }, + "forks_count": { "type": "integer" }, + "stargazers_count": { "type": "integer" }, + "watchers_count": { "type": "integer" }, + "size": { "type": "integer" }, + "default_branch": { "type": "string" }, + "open_issues_count": { "type": "integer" }, + "is_template": { "type": "boolean" }, + "topics": { "type": "array", "items": { "type": "string" } }, + "has_issues": { "type": "boolean" }, + "has_projects": { "type": "boolean" }, + "has_wiki": { "type": "boolean" }, + "has_pages": { "type": "boolean" }, + "has_downloads": { "type": "boolean" }, + "archived": { "type": "boolean" }, + "disabled": { "type": "boolean" }, + "visibility": { "type": "string" }, + "pushed_at": { "type": "string" }, + "created_at": { "type": "string" }, + "updated_at": { "type": "string" }, + "permissions": { + "type": "object", + "properties": { + "admin": { "type": "boolean" }, + "push": { "type": "boolean" }, + "pull": { "type": "boolean" } + } + }, + "allow_rebase_merge": { "type": "boolean" }, + "temp_clone_token": { "type": "string" }, + "allow_squash_merge": { "type": "boolean" }, + "delete_branch_on_merge": { "type": "boolean" }, + "allow_merge_commit": { "type": "boolean" }, + "subscribers_count": { "type": "integer" }, + "network_count": { "type": "integer" } + } + }, + "temp_clone_token": { "type": "string" }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { "type": "integer" }, + "network_count": { "type": "integer" }, + "open_issues": { "type": "integer" }, + "watchers": { "type": "integer" }, + "master_branch": { "type": "string" }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "installation-token": { + "title": "Installation Token", + "description": "Authentication token for a GitHub App installed on a user or org.", + "type": "object", + "properties": { + "token": { "type": "string" }, + "expires_at": { "type": "string" }, + "permissions": { + "type": "object", + "properties": { + "issues": { "type": "string" }, + "contents": { "type": "string" }, + "metadata": { "type": "string", "example": "read" }, + "single_file": { "type": "string", "example": "read" } + } + }, + "repository_selection": { + "type": "string", + "enum": ["all", "selected"] + }, + "repositories": { + "type": "array", + "items": { "$ref": "#/components/schemas/repository" } + }, + "single_file": { "type": "string", "example": "README.md" }, + "has_multiple_single_files": { "type": "boolean", "example": true }, + "single_file_paths": { + "type": "array", + "items": { "type": "string" }, + "example": ["config.yml", ".github/issue_TEMPLATE.md"] + } + }, + "required": ["token", "expires_at"] + }, + "validation-error": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": ["message", "documentation_url"], + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": ["code"], + "properties": { + "resource": { "type": "string" }, + "field": { "type": "string" }, + "message": { "type": "string" }, + "code": { "type": "string" }, + "index": { "type": "integer" }, + "value": { + "oneOf": [ + { "type": "string", "nullable": true }, + { "type": "integer", "nullable": true }, + { + "type": "array", + "nullable": true, + "items": { "type": "string" } + } + ] + } + } + } + } + } + }, + "application-grant": { + "title": "Application Grant", + "description": "The authorization associated with an OAuth Access.", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 1 }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/applications/grants/1" + }, + "app": { + "type": "object", + "properties": { + "client_id": { "type": "string" }, + "name": { "type": "string" }, + "url": { "type": "string", "format": "uri" } + }, + "required": ["client_id", "name", "url"] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "scopes": { + "type": "array", + "items": { "type": "string" }, + "example": ["public_repo"] + }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + } + }, + "required": ["app", "id", "scopes", "url", "created_at", "updated_at"] + }, + "scoped-installation": { + "title": "Scoped Installation", + "type": "object", + "properties": { + "permissions": { "$ref": "#/components/schemas/app-permissions" }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": ["all", "selected"] + }, + "single_file_name": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "has_multiple_single_files": { "type": "boolean", "example": true }, + "single_file_paths": { + "type": "array", + "items": { "type": "string" }, + "example": ["config.yml", ".github/issue_TEMPLATE.md"] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "account": { "$ref": "#/components/schemas/simple-user" } + }, + "required": [ + "permissions", + "repository_selection", + "single_file_name", + "repositories_url", + "account" + ] + }, + "authorization": { + "title": "Authorization", + "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "url": { "type": "string", "format": "uri" }, + "scopes": { + "description": "A list of scopes that this authorization is in.", + "type": "array", + "items": { "type": "string" }, + "nullable": true + }, + "token": { "type": "string" }, + "token_last_eight": { "type": "string", "nullable": true }, + "hashed_token": { "type": "string", "nullable": true }, + "app": { + "type": "object", + "properties": { + "client_id": { "type": "string" }, + "name": { "type": "string" }, + "url": { "type": "string", "format": "uri" } + }, + "required": ["client_id", "name", "url"] + }, + "note": { "type": "string", "nullable": true }, + "note_url": { "type": "string", "format": "uri", "nullable": true }, + "updated_at": { "type": "string", "format": "date-time" }, + "created_at": { "type": "string", "format": "date-time" }, + "fingerprint": { "type": "string", "nullable": true }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "installation": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/scoped-installation" }] + } + }, + "required": [ + "app", + "id", + "note", + "note_url", + "scopes", + "token", + "hashed_token", + "token_last_eight", + "fingerprint", + "url", + "created_at", + "updated_at" + ] + }, + "code-of-conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { "type": "string", "example": "contributor_covenant" }, + "name": { "type": "string", "example": "Contributor Covenant" }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + }, + "html_url": { "type": "string", "format": "uri", "nullable": true } + }, + "required": ["url", "html_url", "key", "name"] + }, + "content-reference-attachment": { + "title": "ContentReferenceAttachment", + "description": "Content Reference attachments allow you to provide context around URLs posted in comments", + "type": "object", + "properties": { + "id": { + "description": "The ID of the attachment", + "example": 21, + "type": "integer" + }, + "title": { + "description": "The title of the attachment", + "example": "Title of the attachment", + "type": "string", + "maxLength": 1024 + }, + "body": { + "description": "The body of the attachment", + "example": "Body of the attachment", + "type": "string", + "maxLength": 262144 + }, + "node_id": { + "description": "The node_id of the content attachment", + "example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=", + "type": "string" + } + }, + "required": ["id", "title", "body"] + }, + "enabled-organizations": { + "type": "string", + "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": ["all", "none", "selected"] + }, + "allowed-actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": ["all", "local_only", "selected"] + }, + "selected-actions-url": { + "type": "string", + "description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`." + }, + "actions-enterprise-permissions": { + "type": "object", + "properties": { + "enabled_organizations": { + "$ref": "#/components/schemas/enabled-organizations" + }, + "selected_organizations_url": { + "type": "string", + "description": "The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`." + }, + "allowed_actions": { "$ref": "#/components/schemas/allowed-actions" }, + "selected_actions_url": { + "$ref": "#/components/schemas/selected-actions-url" + } + }, + "required": ["enabled_organizations", "allowed_actions"] + }, + "organization-simple": { + "title": "Organization Simple", + "description": "Organization Simple", + "type": "object", + "properties": { + "login": { "type": "string", "example": "github" }, + "id": { "type": "integer", "example": 1 }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "selected-actions": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { "type": "string" } + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "runner-groups-enterprise": { + "type": "object", + "properties": { + "id": { "type": "number" }, + "name": { "type": "string" }, + "visibility": { "type": "string" }, + "default": { "type": "boolean" }, + "selected_organizations_url": { "type": "string" }, + "runners_url": { "type": "string" }, + "allows_public_repositories": { "type": "boolean" } + }, + "required": [ + "id", + "name", + "visibility", + "allows_public_repositories", + "default", + "runners_url" + ] + }, + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { "type": "boolean" }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": ["read-only", "custom"] + } + } + } + } + }, + "required": ["id", "name", "os", "status", "busy", "labels"] + }, + "runner-application": { + "title": "Runner Application", + "description": "Runner Application", + "type": "object", + "properties": { + "os": { "type": "string" }, + "architecture": { "type": "string" }, + "download_url": { "type": "string" }, + "filename": { "type": "string" } + }, + "required": ["os", "architecture", "download_url", "filename"] + }, + "authentication-token": { + "title": "Authentication Token", + "description": "Authentication Token", + "type": "object", + "properties": { + "token": { + "description": "The token used for authentication", + "type": "string", + "example": "v1.1f699f1069f60xxx" + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "example": "2016-07-11T22:14:10Z" + }, + "permissions": { + "type": "object", + "example": { "issues": "read", "deployments": "write" } + }, + "repositories": { + "description": "The repositories this token has access to", + "type": "array", + "items": { "$ref": "#/components/schemas/repository" } + }, + "single_file": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": ["all", "selected"] + } + }, + "required": ["token", "expires_at"] + }, + "audit-log-event": { + "type": "object", + "properties": { + "@timestamp": { + "type": "integer", + "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "action": { + "type": "string", + "description": "The name of the action that was performed, for example `user.login` or `repo.create`." + }, + "active": { "type": "boolean" }, + "active_was": { "type": "boolean" }, + "actor": { + "type": "string", + "description": "The actor who performed the action." + }, + "blocked_user": { + "type": "string", + "description": "The username of the account being blocked." + }, + "business": { "type": "string" }, + "config": { "type": "array" }, + "config_was": { "type": "array" }, + "content_type": { "type": "string" }, + "created_at": { + "type": "integer", + "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "deploy_key_fingerprint": { "type": "string" }, + "emoji": { "type": "string" }, + "events": { "type": "array" }, + "events_were": { "type": "array" }, + "explanation": { "type": "string" }, + "fingerprint": { "type": "string" }, + "hook_id": { "type": "integer" }, + "limited_availability": { "type": "boolean" }, + "message": { "type": "string" }, + "name": { "type": "string" }, + "old_user": { "type": "string" }, + "openssh_public_key": { "type": "string" }, + "org": { "type": "string" }, + "previous_visibility": { "type": "string" }, + "read_only": { "type": "boolean" }, + "repo": { + "type": "string", + "description": "The name of the repository." + }, + "repository": { + "type": "string", + "description": "The name of the repository." + }, + "repository_public": { "type": "boolean" }, + "target_login": { "type": "string" }, + "team": { "type": "string" }, + "transport_protocol": { + "type": "integer", + "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "transport_protocol_name": { + "type": "string", + "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "user": { + "type": "string", + "description": "The user that was affected by the action performed (if available)." + }, + "visibility": { + "type": "string", + "description": "The repository visibility, for example `public` or `private`." + } + } + }, + "actions-billing-usage": { + "type": "object", + "properties": { + "total_minutes_used": { + "type": "integer", + "description": "The sum of the free and paid GitHub Actions minutes used." + }, + "total_paid_minutes_used": { + "type": "integer", + "description": "The total paid GitHub Actions minutes used." + }, + "included_minutes": { + "type": "integer", + "description": "The amount of free GitHub Actions minutes available." + }, + "minutes_used_breakdown": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "integer", + "description": "Total minutes used on Ubuntu runner machines." + }, + "MACOS": { + "type": "integer", + "description": "Total minutes used on macOS runner machines." + }, + "WINDOWS": { + "type": "integer", + "description": "Total minutes used on Windows runner machines." + } + } + } + }, + "required": [ + "total_minutes_used", + "total_paid_minutes_used", + "included_minutes", + "minutes_used_breakdown" + ] + }, + "packages-billing-usage": { + "type": "object", + "properties": { + "total_gigabytes_bandwidth_used": { + "type": "integer", + "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." + }, + "total_paid_gigabytes_bandwidth_used": { + "type": "integer", + "description": "Total paid storage space (GB) for GitHuub Packages." + }, + "included_gigabytes_bandwidth": { + "type": "integer", + "description": "Free storage space (GB) for GitHub Packages." + } + }, + "required": [ + "total_gigabytes_bandwidth_used", + "total_paid_gigabytes_bandwidth_used", + "included_gigabytes_bandwidth" + ] + }, + "combined-billing-usage": { + "type": "object", + "properties": { + "days_left_in_billing_cycle": { + "type": "integer", + "description": "Numbers of days left in billing cycle." + }, + "estimated_paid_storage_for_month": { + "type": "integer", + "description": "Estimated storage space (GB) used in billing cycle." + }, + "estimated_storage_for_month": { + "type": "integer", + "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." + } + }, + "required": [ + "days_left_in_billing_cycle", + "estimated_paid_storage_for_month", + "estimated_storage_for_month" + ] + }, + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "login": { "type": "string" }, + "display_login": { "type": "string" }, + "gravatar_id": { "type": "string", "nullable": true }, + "url": { "type": "string", "format": "uri" }, + "avatar_url": { "type": "string", "format": "uri" } + }, + "required": ["id", "login", "gravatar_id", "url", "avatar_url"] + }, + "label": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 208045946 }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { "type": "boolean", "example": true } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { "type": "integer", "example": 1002604 }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": ["open", "closed"], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "open_issues": { "type": "integer", "example": 4 }, + "closed_issues": { "type": "integer", "example": 8 }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + }, + "issue-simple": { + "title": "Issue Simple", + "description": "Issue Simple", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 1 }, + "node_id": { "type": "string", "example": "MDU6SXNzdWUx" }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}" + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/issues/1347" + }, + "number": { "type": "integer", "example": 1347 }, + "state": { "type": "string", "example": "open" }, + "title": { "type": "string", "example": "Found a bug" }, + "body": { + "type": "string", + "example": "I'm having a problem with this." + }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "labels": { + "type": "array", + "items": { "$ref": "#/components/schemas/label" } + }, + "assignee": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "assignees": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" }, + "nullable": true + }, + "milestone": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/milestone" }] + }, + "locked": { "type": "boolean", "example": true }, + "active_lock_reason": { + "type": "string", + "example": "too heated", + "nullable": true + }, + "comments": { "type": "integer", "example": 0 }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { "type": "string", "format": "uri", "nullable": true } + }, + "required": ["diff_url", "html_url", "patch_url", "url"] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-22T13:33:48Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-22T13:33:48Z" + }, + "author_association": { "type": "string" }, + "body_html": { "type": "string" }, + "body_text": { "type": "string" }, + "timeline_url": { "type": "string", "format": "uri" }, + "repository": { "$ref": "#/components/schemas/repository" }, + "performed_via_github_app": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/integration" }] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + }, + "reaction-rollup": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "total_count": { "type": "integer" }, + "+1": { "type": "integer" }, + "-1": { "type": "integer" }, + "laugh": { "type": "integer" }, + "confused": { "type": "integer" }, + "heart": { "type": "integer" }, + "hooray": { "type": "integer" }, + "eyes": { "type": "integer" }, + "rocket": { "type": "integer" } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "issue-comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer" + }, + "node_id": { "type": "string" }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { "type": "string" }, + "body_html": { "type": "string" }, + "html_url": { "type": "string", "format": "uri" }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { "type": "string", "format": "uri" }, + "author_association": { + "type": "string", + "enum": [ + "collaborator", + "contributor", + "first_timer", + "first_time_contributor", + "mannequin", + "member", + "none", + "owner" + ] + }, + "performed_via_github_app": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/integration" }] + }, + "reactions": { "$ref": "#/components/schemas/reaction-rollup" } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "event": { + "title": "Event", + "description": "Event", + "type": "object", + "properties": { + "id": { "type": "string" }, + "type": { "type": "string", "nullable": true }, + "actor": { "$ref": "#/components/schemas/actor" }, + "repo": { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "name": { "type": "string" }, + "url": { "type": "string", "format": "uri" } + }, + "required": ["id", "name", "url"] + }, + "org": { "$ref": "#/components/schemas/actor" }, + "payload": { + "type": "object", + "properties": { + "action": { "type": "string" }, + "issue": { "$ref": "#/components/schemas/issue-simple" }, + "comment": { "$ref": "#/components/schemas/issue-comment" }, + "pages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "page_name": { "type": "string" }, + "title": { "type": "string" }, + "summary": { "type": "string", "nullable": true }, + "action": { "type": "string" }, + "sha": { "type": "string" }, + "html_url": { "type": "string" } + } + } + } + }, + "required": ["action"] + }, + "public": { "type": "boolean" }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "id", + "type", + "actor", + "repo", + "payload", + "public", + "created_at" + ] + }, + "link-with-type": { + "title": "Link With Type", + "description": "Hypermedia Link with Type", + "type": "object", + "properties": { + "href": { "type": "string" }, + "type": { "type": "string" } + }, + "required": ["href", "type"] + }, + "feed": { + "title": "Feed", + "description": "Feed", + "type": "object", + "properties": { + "timeline_url": { + "type": "string", + "example": "https://github.com/timeline" + }, + "user_url": { + "type": "string", + "example": "https://github.com/{user}" + }, + "current_user_public_url": { + "type": "string", + "example": "https://github.com/octocat" + }, + "current_user_url": { + "type": "string", + "example": "https://github.com/octocat.private?token=abc123" + }, + "current_user_actor_url": { + "type": "string", + "example": "https://github.com/octocat.private.actor?token=abc123" + }, + "current_user_organization_url": { + "type": "string", + "example": "https://github.com/octocat-org" + }, + "current_user_organization_urls": { + "type": "array", + "example": [ + "https://github.com/organizations/github/octocat.private.atom?token=abc123" + ], + "items": { "type": "string", "format": "uri" } + }, + "security_advisories_url": { + "type": "string", + "example": "https://github.com/security-advisories" + }, + "_links": { + "type": "object", + "properties": { + "timeline": { "$ref": "#/components/schemas/link-with-type" }, + "user": { "$ref": "#/components/schemas/link-with-type" }, + "security_advisories": { + "$ref": "#/components/schemas/link-with-type" + }, + "current_user": { "$ref": "#/components/schemas/link-with-type" }, + "current_user_public": { + "$ref": "#/components/schemas/link-with-type" + }, + "current_user_actor": { + "$ref": "#/components/schemas/link-with-type" + }, + "current_user_organization": { + "$ref": "#/components/schemas/link-with-type" + }, + "current_user_organizations": { + "type": "array", + "items": { "$ref": "#/components/schemas/link-with-type" } + } + }, + "required": ["timeline", "user"] + } + }, + "required": ["_links", "timeline_url", "user_url"] + }, + "base-gist": { + "title": "Base Gist", + "description": "Base Gist", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "forks_url": { "type": "string", "format": "uri" }, + "commits_url": { "type": "string", "format": "uri" }, + "id": { "type": "string" }, + "node_id": { "type": "string" }, + "git_pull_url": { "type": "string", "format": "uri" }, + "git_push_url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" }, + "files": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "filename": { "type": "string" }, + "type": { "type": "string" }, + "language": { "type": "string" }, + "raw_url": { "type": "string" }, + "size": { "type": "integer" } + } + } + }, + "public": { "type": "boolean" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" }, + "description": { "type": "string", "nullable": true }, + "comments": { "type": "integer" }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "comments_url": { "type": "string", "format": "uri" }, + "owner": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "truncated": { "type": "boolean" }, + "forks": { "type": "array", "items": {} }, + "history": { "type": "array", "items": {} } + }, + "required": [ + "id", + "node_id", + "url", + "forks_url", + "commits_url", + "git_pull_url", + "git_push_url", + "html_url", + "comments_url", + "public", + "description", + "comments", + "user", + "files", + "created_at", + "updated_at" + ] + }, + "gist-simple": { + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "url": { "type": "string" }, + "forks_url": { "type": "string" }, + "commits_url": { "type": "string" }, + "id": { "type": "string" }, + "node_id": { "type": "string" }, + "git_pull_url": { "type": "string" }, + "git_push_url": { "type": "string" }, + "html_url": { "type": "string" }, + "files": { + "type": "object", + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { "type": "string" }, + "type": { "type": "string" }, + "language": { "type": "string" }, + "raw_url": { "type": "string" }, + "size": { "type": "integer" }, + "truncated": { "type": "boolean" }, + "content": { "type": "string" } + } + } + }, + "public": { "type": "boolean" }, + "created_at": { "type": "string" }, + "updated_at": { "type": "string" }, + "description": { "type": "string", "nullable": true }, + "comments": { "type": "integer" }, + "user": { "type": "string", "nullable": true }, + "comments_url": { "type": "string" }, + "owner": { "$ref": "#/components/schemas/simple-user" }, + "truncated": { "type": "boolean" } + } + }, + "gist-full": { + "title": "Gist Full", + "description": "Gist Full", + "allOf": [ + { "$ref": "#/components/schemas/gist-simple" }, + { + "type": "object", + "properties": { + "forks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "user": { + "type": "object", + "properties": { + "login": { "type": "string" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "avatar_url": { "type": "string" }, + "gravatar_id": { "type": "string" }, + "url": { "type": "string" }, + "html_url": { "type": "string" }, + "followers_url": { "type": "string" }, + "following_url": { "type": "string" }, + "gists_url": { "type": "string" }, + "starred_url": { "type": "string" }, + "subscriptions_url": { "type": "string" }, + "organizations_url": { "type": "string" }, + "repos_url": { "type": "string" }, + "events_url": { "type": "string" }, + "received_events_url": { "type": "string" }, + "type": { "type": "string" }, + "site_admin": { "type": "boolean" } + } + }, + "url": { "type": "string" }, + "id": { "type": "string" }, + "created_at": { "type": "string" }, + "updated_at": { "type": "string" } + } + } + }, + "history": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { "type": "string" }, + "version": { "type": "string" }, + "user": { + "type": "object", + "properties": { + "login": { "type": "string" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "avatar_url": { "type": "string" }, + "gravatar_id": { "type": "string" }, + "url": { "type": "string" }, + "html_url": { "type": "string" }, + "followers_url": { "type": "string" }, + "following_url": { "type": "string" }, + "gists_url": { "type": "string" }, + "starred_url": { "type": "string" }, + "subscriptions_url": { "type": "string" }, + "organizations_url": { "type": "string" }, + "repos_url": { "type": "string" }, + "events_url": { "type": "string" }, + "received_events_url": { "type": "string" }, + "type": { "type": "string" }, + "site_admin": { "type": "boolean" } + }, + "nullable": true + }, + "change_status": { + "type": "object", + "properties": { + "deletions": { "type": "integer" }, + "additions": { "type": "integer" }, + "total": { "type": "integer" } + } + }, + "committed_at": { "type": "string" } + } + } + }, + "fork_of": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/gist-simple" }] + }, + "url": { + "type": "string", + "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/cb5b95fe0f15ada6d34a421007ba2e4a34e2771e\"" + }, + "forks_url": { + "type": "string", + "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/forks\"" + }, + "commits_url": { + "type": "string", + "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/commits\"" + }, + "id": { + "type": "string", + "example": "\"d8de7663c84491ba9eeb9ca1fd20ced8\"" + }, + "node_id": { + "type": "string", + "example": "\"MDQ6R2lzdGQ4ZGU3NjYzYzg0NDkxYmE5ZWViOWNhMWZkMjBjZWQ4\"" + }, + "git_pull_url": { + "type": "string", + "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" + }, + "git_push_url": { + "type": "string", + "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8.git\"" + }, + "html_url": { + "type": "string", + "example": "\"https://gist.github.com/d8de7663c84491ba9eeb9ca1fd20ced8\"" + }, + "created_at": { + "type": "string", + "example": "\"2020-07-09T00:18:06Z\"" + }, + "updated_at": { + "type": "string", + "example": "\"2020-07-09T00:18:06Z\"" + }, + "description": { + "type": "string", + "example": "\"description\"", + "nullable": true + }, + "comments": { "type": "integer", "example": 1 }, + "comments_url": { + "type": "string", + "example": "\"https://api.github.com/gists/d8de7663c84491ba9eeb9ca1fd20ced8/comments\"" + } + } + } + ] + }, + "gist-comment": { + "title": "Gist Comment", + "description": "A comment made to a gist.", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 1 }, + "node_id": { + "type": "string", + "example": "MDExOkdpc3RDb21tZW50MQ==" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" + }, + "body": { + "description": "The comment text.", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment" + }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-18T23:23:56Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-18T23:23:56Z" + }, + "author_association": { "type": "string" } + }, + "required": [ + "url", + "id", + "node_id", + "user", + "body", + "author_association", + "created_at", + "updated_at" + ] + }, + "gist-commit": { + "title": "Gist Commit", + "description": "Gist Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f" + }, + "version": { + "type": "string", + "example": "57a7f021a713b1c5a6a199b54cc514735d2d462f" + }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "change_status": { + "type": "object", + "properties": { + "total": { "type": "integer" }, + "additions": { "type": "integer" }, + "deletions": { "type": "integer" } + } + }, + "committed_at": { + "type": "string", + "format": "date-time", + "example": "2010-04-14T02:15:15Z" + } + }, + "required": ["url", "user", "version", "committed_at", "change_status"] + }, + "gitignore-template": { + "title": "Gitignore Template", + "description": "Gitignore Template", + "type": "object", + "properties": { + "name": { "type": "string", "example": "C" }, + "source": { + "type": "string", + "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" + } + }, + "required": ["name", "source"] + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { "type": "string", "format": "uri" }, + "labels_url": { "type": "string" }, + "comments_url": { "type": "string", "format": "uri" }, + "events_url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string" + }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": ["bug", "registration"], + "type": "array", + "items": { + "oneOf": [ + { "type": "string" }, + { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "name": { "type": "string" }, + "description": { "type": "string", "nullable": true }, + "color": { "type": "string", "nullable": true }, + "default": { "type": "boolean" } + } + } + ] + } + }, + "assignee": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "assignees": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" }, + "nullable": true + }, + "milestone": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/milestone" }] + }, + "locked": { "type": "boolean" }, + "active_lock_reason": { "type": "string", "nullable": true }, + "comments": { "type": "integer" }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { "type": "string", "format": "uri", "nullable": true } + }, + "required": ["diff_url", "html_url", "patch_url", "url"] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" }, + "closed_by": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "body_html": { "type": "string" }, + "body_text": { "type": "string" }, + "timeline_url": { "type": "string", "format": "uri" }, + "repository": { "$ref": "#/components/schemas/repository" }, + "performed_via_github_app": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/integration" }] + }, + "author_association": { "type": "string" }, + "reactions": { "$ref": "#/components/schemas/reaction-rollup" } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + }, + "license": { + "title": "License", + "description": "License", + "type": "object", + "properties": { + "key": { "type": "string", "example": "mit" }, + "name": { "type": "string", "example": "MIT License" }, + "spdx_id": { "type": "string", "example": "MIT", "nullable": true }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/licenses/mit", + "nullable": true + }, + "node_id": { "type": "string", "example": "MDc6TGljZW5zZW1pdA==" }, + "html_url": { + "type": "string", + "format": "uri", + "example": "http://choosealicense.com/licenses/mit/" + }, + "description": { + "type": "string", + "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty." + }, + "implementation": { + "type": "string", + "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders." + }, + "permissions": { + "type": "array", + "example": [ + "commercial-use", + "modifications", + "distribution", + "sublicense", + "private-use" + ], + "items": { "type": "string" } + }, + "conditions": { + "type": "array", + "example": ["include-copyright"], + "items": { "type": "string" } + }, + "limitations": { + "type": "array", + "example": ["no-liability"], + "items": { "type": "string" } + }, + "body": { + "type": "string", + "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" + }, + "featured": { "type": "boolean", "example": true } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id", + "html_url", + "description", + "implementation", + "permissions", + "conditions", + "limitations", + "body", + "featured" + ] + }, + "marketplace-listing-plan": { + "title": "Marketplace Listing Plan", + "description": "Marketplace Listing Plan", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/marketplace_listing/plans/1313" + }, + "accounts_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" + }, + "id": { "type": "integer", "example": 1313 }, + "number": { "type": "integer", "example": 3 }, + "name": { "type": "string", "example": "Pro" }, + "description": { + "type": "string", + "example": "A professional-grade CI solution" + }, + "monthly_price_in_cents": { "type": "integer", "example": 1099 }, + "yearly_price_in_cents": { "type": "integer", "example": 11870 }, + "price_model": { "type": "string", "example": "flat-rate" }, + "has_free_trial": { "type": "boolean", "example": true }, + "unit_name": { "type": "string", "nullable": true }, + "state": { "type": "string", "example": "published" }, + "bullets": { + "type": "array", + "items": { "type": "string" }, + "example": ["Up to 25 private repositories", "11 concurrent builds"] + } + }, + "required": [ + "url", + "accounts_url", + "id", + "number", + "name", + "description", + "has_free_trial", + "price_model", + "unit_name", + "monthly_price_in_cents", + "state", + "yearly_price_in_cents", + "bullets" + ] + }, + "marketplace-purchase": { + "title": "Marketplace Purchase", + "description": "Marketplace Purchase", + "type": "object", + "properties": { + "url": { "type": "string" }, + "type": { "type": "string" }, + "id": { "type": "integer" }, + "login": { "type": "string" }, + "organization_billing_email": { "type": "string" }, + "marketplace_pending_change": { + "type": "object", + "properties": { + "is_installed": { "type": "boolean" }, + "effective_date": { "type": "string" }, + "unit_count": { "type": "integer", "nullable": true }, + "id": { "type": "integer" }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + }, + "nullable": true + }, + "marketplace_purchase": { + "type": "object", + "properties": { + "billing_cycle": { "type": "string" }, + "next_billing_date": { "type": "string", "nullable": true }, + "is_installed": { "type": "boolean" }, + "unit_count": { "type": "integer", "nullable": true }, + "on_free_trial": { "type": "boolean" }, + "free_trial_ends_on": { "type": "string", "nullable": true }, + "updated_at": { "type": "string" }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + } + } + }, + "required": ["url", "id", "type", "login", "marketplace_purchase"] + }, + "api-overview": { + "title": "Api Overview", + "description": "Api Overview", + "type": "object", + "properties": { + "verifiable_password_authentication": { + "type": "boolean", + "example": true + }, + "ssh_key_fingerprints": { + "type": "object", + "properties": { + "SHA256_RSA": { "type": "string" }, + "SHA256_DSA": { "type": "string" } + } + }, + "hooks": { + "type": "array", + "items": { "type": "string" }, + "example": ["127.0.0.1/32"] + }, + "web": { + "type": "array", + "items": { "type": "string" }, + "example": ["127.0.0.1/32"] + }, + "api": { + "type": "array", + "items": { "type": "string" }, + "example": ["127.0.0.1/32"] + }, + "git": { + "type": "array", + "items": { "type": "string" }, + "example": ["127.0.0.1/32"] + }, + "pages": { + "type": "array", + "items": { "type": "string" }, + "example": ["192.30.252.153/32", "192.30.252.154/32"] + }, + "importer": { + "type": "array", + "items": { "type": "string" }, + "example": ["54.158.161.132", "54.226.70.38"] + }, + "actions": { + "type": "array", + "items": { "type": "string" }, + "example": ["13.64.0.0/16", "13.65.0.0/16"] + } + }, + "required": ["verifiable_password_authentication"] + }, + "minimal-repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 1296269 }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { "type": "string", "example": "Hello-World" }, + "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "private": { "type": "boolean" }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { "type": "boolean" }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { "type": "string" }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { "type": "string" }, + "mirror_url": { "type": "string", "nullable": true }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { "type": "string" }, + "homepage": { "type": "string", "nullable": true }, + "language": { "type": "string", "nullable": true }, + "forks_count": { "type": "integer" }, + "stargazers_count": { "type": "integer" }, + "watchers_count": { "type": "integer" }, + "size": { "type": "integer" }, + "default_branch": { "type": "string" }, + "open_issues_count": { "type": "integer" }, + "is_template": { "type": "boolean" }, + "topics": { "type": "array", "items": { "type": "string" } }, + "has_issues": { "type": "boolean" }, + "has_projects": { "type": "boolean" }, + "has_wiki": { "type": "boolean" }, + "has_pages": { "type": "boolean" }, + "has_downloads": { "type": "boolean" }, + "archived": { "type": "boolean" }, + "disabled": { "type": "boolean" }, + "visibility": { "type": "string" }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { "type": "boolean" }, + "push": { "type": "boolean" }, + "pull": { "type": "boolean" } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [{ "$ref": "#/components/schemas/repository" }] + }, + "temp_clone_token": { "type": "string" }, + "delete_branch_on_merge": { "type": "boolean" }, + "subscribers_count": { "type": "integer" }, + "network_count": { "type": "integer" }, + "license": { + "type": "object", + "properties": { + "key": { "type": "string" }, + "name": { "type": "string" }, + "spdx_id": { "type": "string" }, + "url": { "type": "string" }, + "node_id": { "type": "string" } + }, + "nullable": true + }, + "forks": { "type": "integer", "example": 0 }, + "open_issues": { "type": "integer", "example": 0 }, + "watchers": { "type": "integer", "example": 0 } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "thread": { + "title": "Thread", + "description": "Thread", + "type": "object", + "properties": { + "id": { "type": "string" }, + "repository": { "$ref": "#/components/schemas/minimal-repository" }, + "subject": { + "type": "object", + "properties": { + "title": { "type": "string" }, + "url": { "type": "string" }, + "latest_comment_url": { "type": "string" }, + "type": { "type": "string" } + }, + "required": ["title", "url", "latest_comment_url", "type"] + }, + "reason": { "type": "string" }, + "unread": { "type": "boolean" }, + "updated_at": { "type": "string" }, + "last_read_at": { "type": "string", "nullable": true }, + "url": { "type": "string" }, + "subscription_url": { + "type": "string", + "example": "https://api.github.com/notifications/threads/2/subscription" + } + }, + "required": [ + "id", + "unread", + "reason", + "updated_at", + "last_read_at", + "subject", + "repository", + "url", + "subscription_url" + ] + }, + "thread-subscription": { + "title": "Thread Subscription", + "description": "Thread Subscription", + "type": "object", + "properties": { + "subscribed": { "type": "boolean", "example": true }, + "ignored": { "type": "boolean" }, + "reason": { "type": "string", "nullable": true }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-10-06T21:34:12Z", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/notifications/threads/1/subscription" + }, + "thread_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/notifications/threads/1" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/1" + } + }, + "required": ["created_at", "ignored", "reason", "url", "subscribed"] + }, + "organization-full": { + "title": "Organization Full", + "description": "Organization Full", + "type": "object", + "properties": { + "login": { "type": "string", "example": "github" }, + "id": { "type": "integer", "example": 1 }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + }, + "name": { "type": "string", "example": "github" }, + "company": { "type": "string", "example": "GitHub" }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { "type": "string", "example": "San Francisco" }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { "type": "boolean", "example": true }, + "has_organization_projects": { "type": "boolean", "example": true }, + "has_repository_projects": { "type": "boolean", "example": true }, + "public_repos": { "type": "integer", "example": 2 }, + "public_gists": { "type": "integer", "example": 1 }, + "followers": { "type": "integer", "example": 20 }, + "following": { "type": "integer", "example": 0 }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { "type": "string", "example": "Organization" }, + "total_private_repos": { "type": "integer", "example": 100 }, + "owned_private_repos": { "type": "integer", "example": 100 }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "space": { "type": "integer" }, + "private_repos": { "type": "integer" }, + "filled_seats": { "type": "integer" }, + "seats": { "type": "integer" } + }, + "required": ["name", "space", "private_repos"] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { "type": "boolean", "example": true }, + "updated_at": { "type": "string", "format": "date-time" } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at" + ] + }, + "enabled-repositories": { + "type": "string", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": ["all", "none", "selected"] + }, + "actions-organization-permissions": { + "type": "object", + "properties": { + "enabled_repositories": { + "$ref": "#/components/schemas/enabled-repositories" + }, + "selected_repositories_url": { + "type": "string", + "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." + }, + "allowed_actions": { "$ref": "#/components/schemas/allowed-actions" }, + "selected_actions_url": { + "$ref": "#/components/schemas/selected-actions-url" + } + }, + "required": ["enabled_repositories", "allowed_actions"] + }, + "runner-groups-org": { + "type": "object", + "properties": { + "id": { "type": "number" }, + "name": { "type": "string" }, + "visibility": { "type": "string" }, + "default": { "type": "boolean" }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { "type": "string" }, + "inherited": { "type": "boolean" }, + "inherited_allows_public_repositories": { "type": "boolean" }, + "allows_public_repositories": { "type": "boolean" } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "organization-actions-secret": { + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" }, + "visibility": { + "description": "Visibility of a secret", + "enum": ["all", "private", "selected"], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" + } + }, + "required": ["name", "created_at", "updated_at", "visibility"] + }, + "actions-public-key": { + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { "type": "integer", "example": 2 }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { "type": "string", "example": "2011-01-26T19:01:12Z" } + }, + "required": ["key_id", "key"] + }, + "credential-authorization": { + "title": "Credential Authorization", + "description": "Credential Authorization", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "monalisa", + "description": "User login that owns the underlying credential." + }, + "credential_id": { + "type": "integer", + "example": 1, + "description": "Unique identifier for the credential." + }, + "credential_type": { + "type": "string", + "example": "SSH Key", + "description": "Human-readable description of the credential type." + }, + "token_last_eight": { + "type": "string", + "example": "12345678", + "description": "Last eight characters of the credential. Only included in responses with credential_type of personal access token." + }, + "credential_authorized_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "description": "Date when the credential was authorized for use." + }, + "scopes": { + "type": "array", + "example": ["user", "repo"], + "description": "List of oauth scopes the token has been granted.", + "items": { "type": "string" } + }, + "fingerprint": { + "type": "string", + "example": "jklmnop12345678", + "description": "Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key." + }, + "credential_accessed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "description": "Date when the credential was last accessed. May be null if it was never accessed", + "nullable": true + }, + "authorized_credential_id": { + "type": "integer", + "nullable": true, + "example": 12345678 + }, + "authorized_credential_title": { + "type": "string", + "example": "my ssh key", + "description": "The title given to the ssh key. This will only be present when the credential is an ssh key." + }, + "authorized_credential_note": { + "type": "string", + "example": "my token", + "description": "The note given to the token. This will only be present when the credential is a token." + } + }, + "required": [ + "login", + "credential_id", + "credential_type", + "credential_authorized_at" + ] + }, + "org-hook": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 1 }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1" + }, + "ping_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + }, + "name": { "type": "string", "example": "web" }, + "events": { + "type": "array", + "example": ["push", "pull_request"], + "items": { "type": "string" } + }, + "active": { "type": "boolean", "example": true }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "\"http://example.com/2\"" + }, + "insecure_ssl": { "type": "string", "example": "\"0\"" }, + "content_type": { "type": "string", "example": "\"form\"" }, + "secret": { "type": "string", "example": "\"********\"" } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "type": { "type": "string" } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + }, + "interaction-group": { + "type": "string", + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`.", + "example": "collaborators_only", + "enum": ["existing_users", "contributors_only", "collaborators_only"] + }, + "interaction-limit-response": { + "title": "Interaction Limits", + "description": "Interaction limit settings.", + "type": "object", + "properties": { + "limit": { "$ref": "#/components/schemas/interaction-group" }, + "origin": { "type": "string", "example": "repository" }, + "expires_at": { + "type": "string", + "format": "date-time", + "example": "2018-08-17T04:18:39Z" + } + }, + "required": ["limit", "origin", "expires_at"] + }, + "interaction-expiry": { + "type": "string", + "description": "The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`.", + "example": "one_month", + "enum": ["one_day", "three_days", "one_week", "one_month", "six_months"] + }, + "interaction-limit": { + "title": "Interaction Restrictions", + "description": "Limit interactions to a specific type of user for a specified duration", + "type": "object", + "properties": { + "limit": { "$ref": "#/components/schemas/interaction-group" }, + "expiry": { "$ref": "#/components/schemas/interaction-expiry" } + }, + "required": ["limit"] + }, + "organization-invitation": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "login": { "type": "string", "nullable": true }, + "email": { "type": "string", "nullable": true }, + "role": { "type": "string" }, + "created_at": { "type": "string" }, + "inviter": { "$ref": "#/components/schemas/simple-user" }, + "team_count": { "type": "integer" }, + "invitation_team_url": { "type": "string" }, + "node_id": { + "type": "string", + "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + }, + "invitation_teams_url": { + "type": "string", + "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_team_url", + "node_id" + ] + }, + "team-simple": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { "type": "string", "example": "MDQ6VGVhbTE=" }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { "type": "string", "example": "justice-league" }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + }, + "team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "name": { "type": "string" }, + "slug": { "type": "string" }, + "description": { "type": "string", "nullable": true }, + "privacy": { "type": "string" }, + "permission": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { "type": "string" }, + "repositories_url": { "type": "string", "format": "uri" }, + "parent": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/team-simple" }] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + }, + "org-membership": { + "title": "Org Membership", + "description": "Org Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/memberships/defunkt" + }, + "state": { "type": "string", "example": "active" }, + "role": { "type": "string", "example": "admin" }, + "organization_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple" + }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "permissions": { + "type": "object", + "properties": { "can_create_repository": { "type": "boolean" } }, + "required": ["can_create_repository"] + } + }, + "required": [ + "state", + "role", + "organization_url", + "url", + "organization", + "user" + ] + }, + "migration": { + "title": "Migration", + "description": "A migration.", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 79 }, + "owner": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "guid": { + "type": "string", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516" + }, + "state": { "type": "string", "example": "pending" }, + "lock_repositories": { "type": "boolean", "example": true }, + "exclude_attachments": { "type": "boolean" }, + "repositories": { + "type": "array", + "items": { "$ref": "#/components/schemas/repository" } + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octo-org/migrations/79" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2015-07-06T15:33:38-07:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2015-07-06T15:33:38-07:00" + }, + "node_id": { "type": "string" }, + "archive_url": { "type": "string", "format": "uri" }, + "exclude": { "type": "array", "items": {} } + }, + "required": [ + "id", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_attachments", + "repositories", + "url", + "created_at", + "updated_at" + ] + }, + "project": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/api-playground/projects-test" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/1002604" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/api-playground/projects-test/projects/12" + }, + "columns_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/1002604/columns" + }, + "id": { "type": "integer", "example": 1002604 }, + "node_id": { + "type": "string", + "example": "MDc6UHJvamVjdDEwMDI2MDQ=" + }, + "name": { + "description": "Name of the project", + "example": "Week One Sprint", + "type": "string" + }, + "body": { + "description": "Body of the project", + "example": "This project represents the sprint of the first week in January", + "type": "string", + "nullable": true + }, + "number": { "type": "integer", "example": 1 }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "creator": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": ["read", "write", "admin", "none"] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" + ] + }, + "group-mapping": { + "title": "GroupMapping", + "description": "External Groups to be mapped to a team for membership", + "type": "object", + "properties": { + "groups": { + "description": "Array of groups to be mapped to this team", + "example": [ + { + "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", + "group_name": "saml-azuread-test", + "group_description": "A group of Developers working on AzureAD SAML SSO" + }, + { + "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", + "group_name": "saml-azuread-test2", + "group_description": "Another group of Developers working on AzureAD SAML SSO" + } + ], + "type": "array", + "items": { + "type": "object", + "required": ["group_id", "group_name", "group_description"], + "properties": { + "group_id": { + "description": "The ID of the group", + "example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", + "type": "string" + }, + "group_name": { + "description": "The name of the group", + "example": "saml-azuread-test", + "type": "string" + }, + "group_description": { + "description": "a description of the group", + "example": "A group of Developers working on AzureAD SAML SSO", + "type": "string" + } + } + } + }, + "group_id": { + "description": "The ID of the group", + "example": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", + "type": "string" + }, + "group_name": { + "description": "The name of the group", + "example": "saml-azuread-test", + "type": "string" + }, + "group_description": { + "description": "a description of the group", + "example": "A group of Developers working on AzureAD SAML SSO", + "type": "string" + }, + "status": { + "description": "synchronization status for this group mapping", + "example": "unsynced", + "type": "string" + }, + "synced_at": { + "description": "the time of the last sync for this group-mapping", + "example": "2019-06-03 22:27:15:000 -700", + "type": "string" + } + } + }, + "team-full": { + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { "type": "string", "example": "MDQ6VGVhbTE=" }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { "type": "string", "example": "justice-league" }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": ["closed", "secret"], + "example": "closed" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/team-simple" }] + }, + "members_count": { "type": "integer", "example": 3 }, + "repos_count": { "type": "integer", "example": 10 }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-14T16:53:42Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-08-17T12:37:15Z" + }, + "organization": { "$ref": "#/components/schemas/organization-full" }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "created_at", + "updated_at", + "members_count", + "repos_count", + "organization" + ] + }, + "team-discussion": { + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "type": "object", + "properties": { + "author": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "body": { + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", + "type": "string" + }, + "body_html": { + "type": "string", + "example": "

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

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "comments_count": { "type": "integer", "example": 0 }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-25T18:56:31Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" + }, + "node_id": { + "type": "string", + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + }, + "number": { + "description": "The unique sequence number of a team discussion.", + "example": 42, + "type": "integer" + }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization administrators.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-25T18:56:31Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + }, + "reactions": { "$ref": "#/components/schemas/reaction-rollup" } + }, + "required": [ + "author", + "body", + "body_html", + "body_version", + "comments_count", + "comments_url", + "created_at", + "last_edited_at", + "html_url", + "pinned", + "private", + "node_id", + "number", + "team_url", + "title", + "updated_at", + "url" + ] + }, + "team-discussion-comment": { + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", + "type": "object", + "properties": { + "author": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { + "type": "string", + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { "$ref": "#/components/schemas/reaction-rollup" } + }, + "required": [ + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", + "url" + ] + }, + "reaction": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 1 }, + "node_id": { "type": "string", "example": "MDg6UmVhY3Rpb24x" }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": ["id", "node_id", "user", "content", "created_at"] + }, + "team-membership": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "role": { + "description": "The role of the user in the team.", + "enum": ["member", "maintainer"], + "default": "member", + "example": "member", + "type": "string" + }, + "state": { "type": "string" } + }, + "required": ["role", "state", "url"] + }, + "team-project": { + "title": "Team Project", + "description": "A team's access to a project.", + "type": "object", + "properties": { + "owner_url": { "type": "string" }, + "url": { "type": "string" }, + "html_url": { "type": "string" }, + "columns_url": { "type": "string" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "name": { "type": "string" }, + "body": { "type": "string", "nullable": true }, + "number": { "type": "integer" }, + "state": { "type": "string" }, + "creator": { "$ref": "#/components/schemas/simple-user" }, + "created_at": { "type": "string" }, + "updated_at": { "type": "string" }, + "organization_permission": { + "description": "The organization permission for this project. Only present when owner is an organization.", + "type": "string" + }, + "private": { + "description": "Whether the project is private or not. Only present when owner is an organization.", + "type": "boolean" + }, + "permissions": { + "type": "object", + "properties": { + "read": { "type": "boolean" }, + "write": { "type": "boolean" }, + "admin": { "type": "boolean" } + }, + "required": ["read", "write", "admin"] + } + }, + "required": [ + "owner_url", + "url", + "html_url", + "columns_url", + "id", + "node_id", + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at", + "permissions" + ] + }, + "team-repository": { + "title": "Team Repository", + "description": "A team's access to a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "license": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/license-simple" }] + }, + "forks": { "type": "integer" }, + "permissions": { + "type": "object", + "properties": { + "admin": { "type": "boolean" }, + "pull": { "type": "boolean" }, + "triage": { "type": "boolean" }, + "push": { "type": "boolean" }, + "maintain": { "type": "boolean" } + }, + "required": ["admin", "pull", "push"] + }, + "owner": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { "type": "boolean" }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { "type": "string", "nullable": true }, + "forks_count": { "type": "integer", "example": 9 }, + "stargazers_count": { "type": "integer", "example": 80 }, + "watchers_count": { "type": "integer", "example": 80 }, + "size": { "type": "integer", "example": 108 }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { "type": "integer", "example": 0 }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { "type": "array", "items": { "type": "string" } }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { "type": "boolean" }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "type": "object", + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/repository" }] + }, + "temp_clone_token": { "type": "string" }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { "type": "integer" }, + "network_count": { "type": "integer" }, + "open_issues": { "type": "integer" }, + "watchers": { "type": "integer" }, + "master_branch": { "type": "string" } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "project-card": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/cards/1478" + }, + "id": { + "description": "The project card's ID", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + }, + "note": { + "type": "string", + "example": "Add payload for delete Project column", + "nullable": true + }, + "creator": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:21:06Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:20:22Z" + }, + "archived": { + "description": "Whether or not the card is archived", + "example": false, + "type": "boolean" + }, + "column_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367" + }, + "content_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" + }, + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/120" + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + }, + "project-column": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367" + }, + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/120" + }, + "cards_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367/cards" + }, + "id": { + "description": "The unique identifier of the project column", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + }, + "name": { + "description": "Name of the project column", + "example": "Remaining tasks", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:18:44Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:22:28Z" + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] + }, + "repository-collaborator-permission": { + "title": "Repository Collaborator Permission", + "description": "Repository Collaborator Permission", + "type": "object", + "properties": { + "permission": { "type": "string" }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + } + }, + "required": ["permission", "user"] + }, + "rate-limit": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { "type": "integer" }, + "remaining": { "type": "integer" }, + "reset": { "type": "integer" } + }, + "required": ["limit", "remaining", "reset"] + }, + "rate-limit-overview": { + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", + "type": "object", + "properties": { + "resources": { + "type": "object", + "properties": { + "core": { "$ref": "#/components/schemas/rate-limit" }, + "graphql": { "$ref": "#/components/schemas/rate-limit" }, + "search": { "$ref": "#/components/schemas/rate-limit" }, + "source_import": { "$ref": "#/components/schemas/rate-limit" }, + "integration_manifest": { + "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_upload": { + "$ref": "#/components/schemas/rate-limit" + } + }, + "required": ["core", "search"] + }, + "rate": { "$ref": "#/components/schemas/rate-limit" } + }, + "required": ["rate", "resources"] + }, + "full-repository": { + "title": "Full Repository", + "description": "Full Repository", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 1296269 }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { "type": "string", "example": "Hello-World" }, + "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "owner": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "private": { "type": "boolean" }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { "type": "boolean" }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { "type": "string", "nullable": true }, + "forks_count": { "type": "integer", "example": 9 }, + "stargazers_count": { "type": "integer", "example": 80 }, + "watchers_count": { "type": "integer", "example": 80 }, + "size": { "type": "integer", "example": 108 }, + "default_branch": { "type": "string", "example": "master" }, + "open_issues_count": { "type": "integer", "example": 0 }, + "is_template": { "type": "boolean", "example": true }, + "topics": { + "type": "array", + "items": { "type": "string" }, + "example": ["octocat", "atom", "electron", "API"] + }, + "has_issues": { "type": "boolean", "example": true }, + "has_projects": { "type": "boolean", "example": true }, + "has_wiki": { "type": "boolean", "example": true }, + "has_pages": { "type": "boolean" }, + "has_downloads": { "type": "boolean", "example": true }, + "archived": { "type": "boolean" }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "example": "public" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { "type": "boolean" }, + "pull": { "type": "boolean" }, + "push": { "type": "boolean" } + }, + "required": ["admin", "pull", "push"] + }, + "allow_rebase_merge": { "type": "boolean", "example": true }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [{ "$ref": "#/components/schemas/repository" }] + }, + "temp_clone_token": { "type": "string", "nullable": true }, + "allow_squash_merge": { "type": "boolean", "example": true }, + "delete_branch_on_merge": { "type": "boolean", "example": false }, + "allow_merge_commit": { "type": "boolean", "example": true }, + "subscribers_count": { "type": "integer", "example": 42 }, + "network_count": { "type": "integer", "example": 0 }, + "license": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/license-simple" }] + }, + "organization": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "parent": { "$ref": "#/components/schemas/repository" }, + "source": { "$ref": "#/components/schemas/repository" }, + "forks": { "type": "integer" }, + "master_branch": { "type": "string" }, + "open_issues": { "type": "integer" }, + "watchers": { "type": "integer" }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at", + "network_count", + "subscribers_count" + ] + }, + "artifact": { + "title": "Artifact", + "description": "An artifact", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 5 }, + "node_id": { "type": "string", "example": "MDEwOkNoZWNrU3VpdGU1" }, + "name": { + "description": "The name of the artifact.", + "type": "string", + "example": "AdventureWorks.Framework" + }, + "size_in_bytes": { + "description": "The size in bytes of the artifact.", + "type": "integer", + "example": 12345 + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5" + }, + "archive_download_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" + }, + "expired": { + "description": "Whether or not the artifact has expired.", + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "expires_at": { "type": "string", "format": "date-time" }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "name", + "size_in_bytes", + "url", + "archive_download_url", + "expired", + "created_at", + "expires_at", + "updated_at" + ] + }, + "job": { + "title": "Job", + "description": "Information of a job execution in a workflow run", + "type": "object", + "properties": { + "id": { + "description": "The id of the job.", + "example": 21, + "type": "integer" + }, + "run_id": { + "description": "The id of the associated workflow run.", + "example": 5, + "type": "integer" + }, + "run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "node_id": { "type": "string", "example": "MDg6Q2hlY2tSdW40" }, + "head_sha": { + "description": "The SHA of the commit that is being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/jobs/21" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/runs/4", + "nullable": true + }, + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": ["queued", "in_progress", "completed"] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "started_at": { + "description": "The time that the job started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string" + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "steps": { + "description": "Steps in this job.", + "type": "array", + "items": { + "type": "object", + "required": ["name", "status", "conclusion", "number"], + "properties": { + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": ["queued", "in_progress", "completed"] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "number": { "type": "integer", "example": 1 }, + "started_at": { + "description": "The time that the step started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + } + } + } + }, + "check_run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-runs/4" + } + }, + "required": [ + "id", + "node_id", + "run_id", + "run_url", + "head_sha", + "name", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "check_run_url" + ] + }, + "actions-enabled": { + "type": "boolean", + "description": "Whether GitHub Actions is enabled on the repository." + }, + "actions-repository-permissions": { + "type": "object", + "properties": { + "enabled": { "$ref": "#/components/schemas/actions-enabled" }, + "allowed_actions": { "$ref": "#/components/schemas/allowed-actions" }, + "selected_actions_url": { + "$ref": "#/components/schemas/selected-actions-url" + } + }, + "required": ["enabled", "allowed_actions"] + }, + "pull-request-minimal": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "number": { "type": "integer" }, + "url": { "type": "string" }, + "head": { + "type": "object", + "properties": { + "ref": { "type": "string" }, + "sha": { "type": "string" }, + "repo": { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "url": { "type": "string" }, + "name": { "type": "string" } + }, + "required": ["id", "url", "name"] + } + }, + "required": ["ref", "sha", "repo"] + }, + "base": { + "type": "object", + "properties": { + "ref": { "type": "string" }, + "sha": { "type": "string" }, + "repo": { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "url": { "type": "string" }, + "name": { "type": "string" } + }, + "required": ["id", "url", "name"] + } + }, + "required": ["ref", "sha", "repo"] + } + }, + "required": ["id", "number", "url", "head", "base"] + }, + "simple-commit": { + "title": "Simple Commit", + "description": "Simple Commit", + "type": "object", + "properties": { + "id": { "type": "string" }, + "tree_id": { "type": "string" }, + "message": { "type": "string" }, + "timestamp": { "type": "string", "format": "date-time" }, + "author": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "email": { "type": "string" } + }, + "required": ["name", "email"], + "nullable": true + }, + "committer": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "email": { "type": "string" } + }, + "required": ["name", "email"], + "nullable": true + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "workflow-run": { + "title": "Workflow Run", + "description": "An invocation of a workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the workflow run.", + "example": 5 + }, + "name": { + "type": "string", + "description": "The name of the workflow run.", + "example": "Build" + }, + "node_id": { "type": "string", "example": "MDEwOkNoZWNrU3VpdGU1" }, + "head_branch": { + "type": "string", + "nullable": true, + "example": "master" + }, + "head_sha": { + "description": "The SHA of the head commit that points to the version of the worflow being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "run_number": { + "type": "integer", + "description": "The auto incrementing run number for the workflow run.", + "example": 106 + }, + "event": { "type": "string", "example": "push" }, + "status": { + "type": "string", + "nullable": true, + "example": "completed" + }, + "conclusion": { + "type": "string", + "nullable": true, + "example": "neutral" + }, + "workflow_id": { + "type": "integer", + "description": "The ID of the parent workflow.", + "example": 5 + }, + "url": { + "type": "string", + "description": "The URL to the workflow run.", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/suites/4" + }, + "pull_requests": { + "type": "array", + "nullable": true, + "items": { "$ref": "#/components/schemas/pull-request-minimal" } + }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" }, + "jobs_url": { + "description": "The URL to the jobs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs" + }, + "logs_url": { + "description": "The URL to download the logs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/logs" + }, + "check_suite_url": { + "description": "The URL to the associated check suite.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-suites/12" + }, + "artifacts_url": { + "description": "The URL to the artifacts for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts" + }, + "cancel_url": { + "description": "The URL to cancel the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel" + }, + "rerun_url": { + "description": "The URL to rerun the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" + }, + "workflow_url": { + "description": "The URL to the workflow.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" + }, + "head_commit": { "$ref": "#/components/schemas/simple-commit" }, + "repository": { "$ref": "#/components/schemas/minimal-repository" }, + "head_repository": { + "$ref": "#/components/schemas/minimal-repository" + }, + "head_repository_id": { "type": "integer", "example": 5 } + }, + "required": [ + "id", + "node_id", + "head_branch", + "run_number", + "event", + "status", + "conclusion", + "head_sha", + "workflow_id", + "url", + "html_url", + "created_at", + "updated_at", + "head_commit", + "head_repository", + "repository", + "jobs_url", + "logs_url", + "check_suite_url", + "cancel_url", + "rerun_url", + "artifacts_url", + "workflow_url", + "pull_requests" + ] + }, + "workflow-run-usage": { + "title": "Workflow Run Usage", + "description": "Workflow Run Usage", + "type": "object", + "properties": { + "billable": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "object", + "required": ["total_ms", "jobs"], + "properties": { + "total_ms": { "type": "integer" }, + "jobs": { "type": "integer" } + } + }, + "MACOS": { + "type": "object", + "required": ["total_ms", "jobs"], + "properties": { + "total_ms": { "type": "integer" }, + "jobs": { "type": "integer" } + } + }, + "WINDOWS": { + "type": "object", + "required": ["total_ms", "jobs"], + "properties": { + "total_ms": { "type": "integer" }, + "jobs": { "type": "integer" } + } + } + } + }, + "run_duration_ms": { "type": "integer" } + }, + "required": ["billable", "run_duration_ms"] + }, + "actions-secret": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } + }, + "required": ["name", "created_at", "updated_at"] + }, + "workflow": { + "title": "Workflow", + "description": "A GitHub Actions workflow", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 5 }, + "node_id": { "type": "string", "example": "MDg6V29ya2Zsb3cxMg==" }, + "name": { "type": "string", "example": "CI" }, + "path": { "type": "string", "example": "ruby.yaml" }, + "state": { + "type": "string", + "example": "active", + "enum": ["active", "deleted"] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/actions/setup-ruby/workflows/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml" + }, + "badge_url": { + "type": "string", + "example": "https://github.com/actions/setup-ruby/workflows/CI/badge.svg" + }, + "deleted_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + } + }, + "required": [ + "id", + "node_id", + "name", + "path", + "state", + "url", + "html_url", + "badge_url", + "created_at", + "updated_at" + ] + }, + "workflow-usage": { + "title": "Workflow Usage", + "description": "Workflow Usage", + "type": "object", + "properties": { + "billable": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "object", + "properties": { "total_ms": { "type": "integer" } } + }, + "MACOS": { + "type": "object", + "properties": { "total_ms": { "type": "integer" } } + }, + "WINDOWS": { + "type": "object", + "properties": { "total_ms": { "type": "integer" } } + } + } + } + }, + "required": ["billable"] + }, + "protected-branch-admin-enforced": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + }, + "enabled": { "type": "boolean", "example": true } + }, + "required": ["url", "enabled"] + }, + "protected-branch-pull-request-review": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { "$ref": "#/components/schemas/team" } + }, + "url": { + "type": "string", + "example": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + }, + "users_url": { + "type": "string", + "example": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + }, + "teams_url": { + "type": "string", + "example": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + } + } + }, + "dismiss_stale_reviews": { "type": "boolean", "example": true }, + "require_code_owner_reviews": { "type": "boolean", "example": true }, + "required_approving_review_count": { + "type": "integer", + "minimum": 1, + "maximum": 6, + "example": 2 + } + }, + "required": ["dismiss_stale_reviews", "require_code_owner_reviews"] + }, + "branch-restriction-policy": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "users_url": { "type": "string", "format": "uri" }, + "teams_url": { "type": "string", "format": "uri" }, + "apps_url": { "type": "string", "format": "uri" }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { "type": "string" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "avatar_url": { "type": "string" }, + "gravatar_id": { "type": "string" }, + "url": { "type": "string" }, + "html_url": { "type": "string" }, + "followers_url": { "type": "string" }, + "following_url": { "type": "string" }, + "gists_url": { "type": "string" }, + "starred_url": { "type": "string" }, + "subscriptions_url": { "type": "string" }, + "organizations_url": { "type": "string" }, + "repos_url": { "type": "string" }, + "events_url": { "type": "string" }, + "received_events_url": { "type": "string" }, + "type": { "type": "string" }, + "site_admin": { "type": "boolean" } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "url": { "type": "string" }, + "html_url": { "type": "string" }, + "name": { "type": "string" }, + "slug": { "type": "string" }, + "description": { "type": "string", "nullable": true }, + "privacy": { "type": "string" }, + "permission": { "type": "string" }, + "members_url": { "type": "string" }, + "repositories_url": { "type": "string" }, + "parent": { "type": "string", "nullable": true } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "slug": { "type": "string" }, + "node_id": { "type": "string" }, + "owner": { + "type": "object", + "properties": { + "login": { "type": "string" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "url": { "type": "string" }, + "repos_url": { "type": "string" }, + "events_url": { "type": "string" }, + "hooks_url": { "type": "string" }, + "issues_url": { "type": "string" }, + "members_url": { "type": "string" }, + "public_members_url": { "type": "string" }, + "avatar_url": { "type": "string" }, + "description": { "type": "string" }, + "gravatar_id": { "type": "string", "example": "\"\"" }, + "html_url": { + "type": "string", + "example": "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + }, + "followers_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + }, + "following_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + }, + "gists_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + }, + "starred_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + }, + "subscriptions_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + }, + "organizations_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + }, + "received_events_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + }, + "type": { "type": "string", "example": "\"Organization\"" } + } + }, + "name": { "type": "string" }, + "description": { "type": "string" }, + "external_url": { "type": "string" }, + "html_url": { "type": "string" }, + "created_at": { "type": "string" }, + "updated_at": { "type": "string" }, + "permissions": { + "type": "object", + "properties": { + "metadata": { "type": "string" }, + "contents": { "type": "string" }, + "issues": { "type": "string" }, + "single_file": { "type": "string" } + } + }, + "events": { "type": "array", "items": { "type": "string" } } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "branch-protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { "type": "string" }, + "required_status_checks": { + "type": "object", + "properties": { + "url": { "type": "string" }, + "enforcement_level": { "type": "string" }, + "contexts": { "type": "array", "items": { "type": "string" } }, + "contexts_url": { "type": "string" } + }, + "required": ["enforcement_level", "contexts"] + }, + "enforce_admins": { + "$ref": "#/components/schemas/protected-branch-admin-enforced" + }, + "required_pull_request_reviews": { + "$ref": "#/components/schemas/protected-branch-pull-request-review" + }, + "restrictions": { + "$ref": "#/components/schemas/branch-restriction-policy" + }, + "required_linear_history": { + "type": "object", + "properties": { "enabled": { "type": "boolean" } } + }, + "allow_force_pushes": { + "type": "object", + "properties": { "enabled": { "type": "boolean" } } + }, + "allow_deletions": { + "type": "object", + "properties": { "enabled": { "type": "boolean" } } + }, + "enabled": { "type": "boolean" }, + "name": { "type": "string", "example": "\"branch/with/protection\"" }, + "protection_url": { + "type": "string", + "example": "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + } + }, + "required": ["enabled", "required_status_checks"] + }, + "short-branch": { + "title": "Short Branch", + "description": "Short Branch", + "type": "object", + "properties": { + "name": { "type": "string" }, + "commit": { + "type": "object", + "properties": { + "sha": { "type": "string" }, + "url": { "type": "string", "format": "uri" } + }, + "required": ["sha", "url"] + }, + "protected": { "type": "boolean" }, + "protection": { "$ref": "#/components/schemas/branch-protection" }, + "protection_url": { "type": "string", "format": "uri" } + }, + "required": ["name", "commit", "protected"] + }, + "git-user": { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { "type": "string", "example": "\"Chris Wanstrath\"" }, + "email": { "type": "string", "example": "\"chris@ozmm.org\"" }, + "date": { + "type": "string", + "example": "\"2007-10-29T02:42:39.000-07:00\"" + } + } + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { "type": "boolean" }, + "reason": { "type": "string" }, + "payload": { "type": "string", "nullable": true }, + "signature": { "type": "string", "nullable": true } + }, + "required": ["verified", "reason", "payload", "signature"] + }, + "commit": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "sha": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "node_id": { + "type": "string", + "example": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "author": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/git-user" }] + }, + "committer": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/git-user" }] + }, + "message": { "type": "string", "example": "Fix all the bugs" }, + "comment_count": { "type": "integer", "example": 0 }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "example": "827efc6d56897b048c772eb4087f854f46256132" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + } + }, + "required": ["sha", "url"] + }, + "verification": { "$ref": "#/components/schemas/verification" } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "committer": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + } + }, + "required": ["sha", "url"] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { "type": "integer" }, + "deletions": { "type": "integer" }, + "total": { "type": "integer" } + } + }, + "files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "filename": { "type": "string" }, + "additions": { "type": "integer" }, + "deletions": { "type": "integer" }, + "changes": { "type": "integer" }, + "status": { "type": "string" }, + "raw_url": { "type": "string" }, + "blob_url": { "type": "string" }, + "patch": { "type": "string" }, + "sha": { + "type": "string", + "example": "\"1e8e60ce9733d5283f7836fa602b6365a66b2567\"" + }, + "contents_url": { + "type": "string", + "example": "\"https://api.github.com/repos/owner-3d68404b07d25daeb2d4a6bf/AAA_Public_Repo/contents/geometry.js?ref=c3956841a7cb7e8ba4a6fd923568d86958f01573\"" + }, + "previous_filename": { + "type": "string", + "example": "\"subdir/before_name.txt\"" + } + } + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "branch-with-protection": { + "title": "Branch With Protection", + "description": "Branch With Protection", + "type": "object", + "properties": { + "name": { "type": "string" }, + "commit": { "$ref": "#/components/schemas/commit" }, + "_links": { + "type": "object", + "properties": { + "html": { "type": "string" }, + "self": { "type": "string", "format": "uri" } + }, + "required": ["html", "self"] + }, + "protected": { "type": "boolean" }, + "protection": { "$ref": "#/components/schemas/branch-protection" }, + "protection_url": { "type": "string", "format": "uri" }, + "pattern": { "type": "string", "example": "\"mas*\"" }, + "required_approving_review_count": { "type": "integer", "example": 1 } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + }, + "status-check-policy": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + }, + "strict": { "type": "boolean", "example": true }, + "contexts": { + "type": "array", + "example": ["continuous-integration/travis-ci"], + "items": { "type": "string" } + }, + "contexts_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + } + }, + "required": ["url", "contexts_url", "strict", "contexts"] + }, + "protected-branch": { + "title": "Protected Branch", + "description": "Branch protections protect branches", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "required_status_checks": { + "$ref": "#/components/schemas/status-check-policy" + }, + "required_pull_request_reviews": { + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "dismiss_stale_reviews": { "type": "boolean" }, + "require_code_owner_reviews": { "type": "boolean" }, + "required_approving_review_count": { "type": "integer" }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "users_url": { "type": "string", "format": "uri" }, + "teams_url": { "type": "string", "format": "uri" }, + "users": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "teams": { + "type": "array", + "items": { "$ref": "#/components/schemas/team" } + } + }, + "required": ["url", "users_url", "teams_url", "users", "teams"] + } + }, + "required": ["url"] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + }, + "enabled": { "type": "boolean", "example": true } + }, + "required": ["url", "enabled"] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "enabled": { "type": "boolean" } + }, + "additionalProperties": false, + "required": ["url", "enabled"] + }, + "required_linear_history": { + "type": "object", + "properties": { "enabled": { "type": "boolean" } }, + "additionalProperties": false, + "required": ["enabled"] + }, + "allow_force_pushes": { + "type": "object", + "properties": { "enabled": { "type": "boolean" } }, + "additionalProperties": false, + "required": ["enabled"] + }, + "allow_deletions": { + "type": "object", + "properties": { "enabled": { "type": "boolean" } }, + "additionalProperties": false, + "required": ["enabled"] + }, + "restrictions": { + "$ref": "#/components/schemas/branch-restriction-policy" + } + }, + "required": ["url"] + }, + "check-run": { + "title": "CheckRun", + "description": "A check performed on the code of a given code change", + "type": "object", + "properties": { + "id": { + "description": "The id of the check.", + "example": 21, + "type": "integer" + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "node_id": { "type": "string", "example": "MDg6Q2hlY2tSdW40" }, + "external_id": { + "type": "string", + "example": "42", + "nullable": true + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-runs/4" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/runs/4", + "nullable": true + }, + "details_url": { + "type": "string", + "example": "https://example.com", + "nullable": true + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "example": "queued", + "type": "string", + "enum": ["queued", "in_progress", "completed"] + }, + "conclusion": { + "type": "string", + "example": "neutral", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ], + "nullable": true + }, + "started_at": { + "type": "string", + "format": "date-time", + "example": "2018-05-04T01:14:52Z", + "nullable": true + }, + "completed_at": { + "type": "string", + "format": "date-time", + "example": "2018-05-04T01:14:52Z", + "nullable": true + }, + "output": { + "type": "object", + "properties": { + "title": { "type": "string", "nullable": true }, + "summary": { "type": "string", "nullable": true }, + "text": { "type": "string", "nullable": true }, + "annotations_count": { "type": "integer" }, + "annotations_url": { "type": "string", "format": "uri" } + }, + "required": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" + ] + }, + "name": { + "description": "The name of the check.", + "example": "test-coverage", + "type": "string" + }, + "check_suite": { + "type": "object", + "properties": { "id": { "type": "integer" } }, + "required": ["id"], + "nullable": true + }, + "app": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/integration" }] + }, + "pull_requests": { + "items": { "$ref": "#/components/schemas/pull-request-minimal" } + } + }, + "required": [ + "id", + "node_id", + "head_sha", + "name", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at", + "external_id", + "check_suite", + "output", + "app", + "pull_requests" + ] + }, + "check-annotation": { + "title": "Check Annotation", + "description": "Check Annotation", + "type": "object", + "properties": { + "path": { "type": "string", "example": "README.md" }, + "start_line": { "type": "integer", "example": 2 }, + "end_line": { "type": "integer", "example": 2 }, + "start_column": { "type": "integer", "example": 5, "nullable": true }, + "end_column": { "type": "integer", "example": 10, "nullable": true }, + "annotation_level": { + "type": "string", + "example": "warning", + "nullable": true + }, + "title": { + "type": "string", + "example": "Spell Checker", + "nullable": true + }, + "message": { + "type": "string", + "example": "Check your spelling for 'banaas'.", + "nullable": true + }, + "raw_details": { + "type": "string", + "example": "Do you mean 'bananas' or 'banana'?", + "nullable": true + }, + "blob_href": { "type": "string" } + }, + "required": [ + "path", + "blob_href", + "start_line", + "end_line", + "start_column", + "end_column", + "annotation_level", + "title", + "message", + "raw_details" + ] + }, + "check-suite": { + "title": "CheckSuite", + "description": "A suite of checks performed on the code of a given code change", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 5 }, + "node_id": { "type": "string", "example": "MDEwOkNoZWNrU3VpdGU1" }, + "head_branch": { + "type": "string", + "example": "master", + "nullable": true + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "status": { + "type": "string", + "example": "completed", + "enum": ["queued", "in_progress", "completed"], + "nullable": true + }, + "conclusion": { + "type": "string", + "example": "neutral", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ], + "nullable": true + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-suites/5", + "nullable": true + }, + "before": { + "type": "string", + "example": "146e867f55c26428e5f9fade55a9bbf5e95a7912", + "nullable": true + }, + "after": { + "type": "string", + "example": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "nullable": true + }, + "pull_requests": { + "type": "array", + "items": { "$ref": "#/components/schemas/pull-request-minimal" }, + "nullable": true + }, + "app": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/integration" }] + }, + "repository": { "$ref": "#/components/schemas/minimal-repository" }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "head_commit": { "$ref": "#/components/schemas/simple-commit" }, + "latest_check_runs_count": { "type": "integer" }, + "check_runs_url": { "type": "string" } + }, + "required": [ + "id", + "node_id", + "head_branch", + "status", + "conclusion", + "head_sha", + "url", + "before", + "after", + "created_at", + "updated_at", + "app", + "head_commit", + "repository", + "latest_check_runs_count", + "check_runs_url", + "pull_requests" + ] + }, + "check-suite-preference": { + "title": "Check Suite Preference", + "description": "Check suite configuration preferences for a repository.", + "type": "object", + "required": ["preferences", "repository"], + "properties": { + "preferences": { + "type": "object", + "properties": { + "auto_trigger_checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "app_id": { "type": "integer" }, + "setting": { "type": "boolean" } + }, + "required": ["app_id", "setting"] + } + } + } + }, + "repository": { "$ref": "#/components/schemas/repository" } + } + }, + "code-scanning-alert-state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": ["open", "dismissed", "fixed"] + }, + "code-scanning-alert-ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "alert-number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "alert-created-at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "alert-url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "alert-html-url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "code-scanning-alert-dismissed-at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "code-scanning-alert-dismissed-reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true, + "oneOf": [ + { "enum": ["false positive", "won't fix", "used in tests"] }, + { "enum": [null] } + ] + }, + "code-scanning-alert-rule": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": ["none", "note", "warning", "error"] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + } + } + }, + "code-scanning-analysis-tool-name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis alert." + }, + "code-scanning-analysis-tool": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/code-scanning-analysis-tool-name" + }, + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to detect the alert." + } + } + }, + "code-scanning-alert-code-scanning-alert-items": { + "type": "object", + "properties": { + "number": { "$ref": "#/components/schemas/alert-number" }, + "created_at": { "$ref": "#/components/schemas/alert-created-at" }, + "url": { "$ref": "#/components/schemas/alert-url" }, + "html_url": { "$ref": "#/components/schemas/alert-html-url" }, + "state": { "$ref": "#/components/schemas/code-scanning-alert-state" }, + "dismissed_by": { "$ref": "#/components/schemas/simple-user" }, + "dismissed_at": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-at" + }, + "dismissed_reason": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" + }, + "rule": { "$ref": "#/components/schemas/code-scanning-alert-rule" }, + "tool": { "$ref": "#/components/schemas/code-scanning-analysis-tool" } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "code-scanning-analysis-analysis-key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "code-scanning-alert-environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "code-scanning-alert-instances": { + "nullable": true, + "type": "array", + "items": { + "properties": { + "ref": { "$ref": "#/components/schemas/code-scanning-alert-ref" }, + "analysis_key": { + "$ref": "#/components/schemas/code-scanning-analysis-analysis-key" + }, + "environment": { + "$ref": "#/components/schemas/code-scanning-alert-environment" + }, + "matrix_vars": { "nullable": true, "type": "string" }, + "state": { + "$ref": "#/components/schemas/code-scanning-alert-state" + } + } + } + }, + "code-scanning-alert-code-scanning-alert": { + "type": "object", + "properties": { + "number": { "$ref": "#/components/schemas/alert-number" }, + "created_at": { "$ref": "#/components/schemas/alert-created-at" }, + "url": { "$ref": "#/components/schemas/alert-url" }, + "html_url": { "$ref": "#/components/schemas/alert-html-url" }, + "instances": { + "$ref": "#/components/schemas/code-scanning-alert-instances" + }, + "state": { "$ref": "#/components/schemas/code-scanning-alert-state" }, + "dismissed_by": { "$ref": "#/components/schemas/simple-user" }, + "dismissed_at": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-at" + }, + "dismissed_reason": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" + }, + "rule": { "$ref": "#/components/schemas/code-scanning-alert-rule" }, + "tool": { "$ref": "#/components/schemas/code-scanning-analysis-tool" } + }, + "required": [ + "instances", + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "code-scanning-alert-set-state": { + "description": "Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`.", + "type": "string", + "enum": ["open", "dismissed"] + }, + "code-scanning-analysis-ref": { + "type": "string", + "description": "The full Git reference of the code scanning analysis file, formatted as `refs/heads/`." + }, + "code-scanning-analysis-commit-sha": { + "description": "The commit SHA of the code scanning analysis file.", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$" + }, + "code-scanning-analysis-created-at": { + "type": "string", + "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "code-scanning-analysis-environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which this analysis was performed." + }, + "code-scanning-analysis-code-scanning-analysis": { + "type": "object", + "properties": { + "commit_sha": { + "$ref": "#/components/schemas/code-scanning-analysis-commit-sha" + }, + "ref": { "$ref": "#/components/schemas/code-scanning-analysis-ref" }, + "analysis_key": { + "$ref": "#/components/schemas/code-scanning-analysis-analysis-key" + }, + "created_at": { + "$ref": "#/components/schemas/code-scanning-analysis-created-at" + }, + "tool_name": { + "$ref": "#/components/schemas/code-scanning-analysis-tool-name" + }, + "error": { "type": "string", "example": "error reading field xyz" }, + "environment": { + "$ref": "#/components/schemas/code-scanning-analysis-environment" + } + }, + "required": [ + "ref", + "commit_sha", + "analysis_key", + "tool_name", + "environment", + "error", + "created_at" + ] + }, + "code-scanning-analysis-sarif-file": { + "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string.", + "type": "string" + }, + "collaborator": { + "title": "Collaborator", + "description": "Collaborator", + "type": "object", + "properties": { + "login": { "type": "string", "example": "octocat" }, + "id": { "type": "integer", "example": 1 }, + "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { "type": "string", "example": "User" }, + "site_admin": { "type": "boolean" }, + "permissions": { + "type": "object", + "properties": { + "pull": { "type": "boolean" }, + "push": { "type": "boolean" }, + "admin": { "type": "boolean" } + }, + "required": ["pull", "push", "admin"] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "repository-invitation": { + "title": "Repository Invitation", + "description": "Repository invitations let you manage who you collaborate with.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository invitation.", + "example": 42, + "type": "integer" + }, + "repository": { "$ref": "#/components/schemas/minimal-repository" }, + "invitee": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "inviter": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "permissions": { + "description": "The permission associated with the invitation.", + "example": "read", + "type": "string", + "enum": ["read", "write", "admin"] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-06-13T14:52:50-05:00" + }, + "expired": { + "description": "Whether or not the invitation has expired", + "type": "boolean" + }, + "url": { + "description": "URL for the repository invitation", + "example": "https://api.github.com/user/repository-invitations/1", + "type": "string" + }, + "html_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World/invitations" + }, + "node_id": { "type": "string" } + }, + "required": [ + "id", + "node_id", + "permissions", + "inviter", + "invitee", + "repository", + "url", + "html_url", + "created_at" + ] + }, + "commit-comment": { + "title": "Commit Comment", + "description": "Commit Comment", + "type": "object", + "properties": { + "html_url": { "type": "string", "format": "uri" }, + "url": { "type": "string", "format": "uri" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "body": { "type": "string" }, + "path": { "type": "string", "nullable": true }, + "position": { "type": "integer", "nullable": true }, + "line": { "type": "integer", "nullable": true }, + "commit_id": { "type": "string" }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" }, + "author_association": { "type": "string" }, + "reactions": { "$ref": "#/components/schemas/reaction-rollup" } + }, + "required": [ + "url", + "html_url", + "id", + "node_id", + "user", + "position", + "line", + "path", + "commit_id", + "body", + "author_association", + "created_at", + "updated_at" + ] + }, + "scim-error": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { "type": "string", "nullable": true }, + "documentation_url": { "type": "string", "nullable": true }, + "detail": { "type": "string", "nullable": true }, + "status": { "type": "integer" }, + "scimType": { "type": "string", "nullable": true }, + "schemas": { "type": "array", "items": { "type": "string" } } + } + }, + "branch-short": { + "title": "Branch Short", + "description": "Branch Short", + "type": "object", + "properties": { + "name": { "type": "string" }, + "commit": { + "type": "object", + "properties": { + "sha": { "type": "string" }, + "url": { "type": "string" } + }, + "required": ["sha", "url"] + }, + "protected": { "type": "boolean" } + }, + "required": ["name", "commit", "protected"] + }, + "link": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { "href": { "type": "string" } }, + "required": ["href"] + }, + "pull-request-simple": { + "title": "Pull Request Simple", + "description": "Pull Request Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "id": { "type": "integer", "example": 1 }, + "node_id": { + "type": "string", + "example": "MDExOlB1bGxSZXF1ZXN0MQ==" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1347" + }, + "diff_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1347.diff" + }, + "patch_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "issue_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "commits_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + }, + "review_comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + }, + "review_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "statuses_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "number": { "type": "integer", "example": 1347 }, + "state": { "type": "string", "example": "open" }, + "locked": { "type": "boolean", "example": true }, + "title": { "type": "string", "example": "new-feature" }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "body": { + "type": "string", + "example": "Please pull these awesome changes", + "nullable": true + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "url": { "type": "string" }, + "name": { "type": "string" }, + "description": { "type": "string" }, + "color": { "type": "string" }, + "default": { "type": "boolean" } + } + } + }, + "milestone": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/milestone" }] + }, + "active_lock_reason": { + "type": "string", + "example": "too heated", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "merged_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "merge_commit_sha": { + "type": "string", + "example": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "nullable": true + }, + "assignee": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "assignees": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" }, + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" }, + "nullable": true + }, + "requested_teams": { + "type": "array", + "items": { "$ref": "#/components/schemas/team-simple" }, + "nullable": true + }, + "head": { + "type": "object", + "properties": { + "label": { "type": "string" }, + "ref": { "type": "string" }, + "repo": { "$ref": "#/components/schemas/repository" }, + "sha": { "type": "string" }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + } + }, + "required": ["label", "ref", "repo", "sha", "user"] + }, + "base": { + "type": "object", + "properties": { + "label": { "type": "string" }, + "ref": { "type": "string" }, + "repo": { "$ref": "#/components/schemas/repository" }, + "sha": { "type": "string" }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + } + }, + "required": ["label", "ref", "repo", "sha", "user"] + }, + "_links": { + "type": "object", + "properties": { + "comments": { "$ref": "#/components/schemas/link" }, + "commits": { "$ref": "#/components/schemas/link" }, + "statuses": { "$ref": "#/components/schemas/link" }, + "html": { "$ref": "#/components/schemas/link" }, + "issue": { "$ref": "#/components/schemas/link" }, + "review_comments": { "$ref": "#/components/schemas/link" }, + "review_comment": { "$ref": "#/components/schemas/link" }, + "self": { "$ref": "#/components/schemas/link" } + }, + "required": [ + "comments", + "commits", + "statuses", + "html", + "issue", + "review_comments", + "review_comment", + "self" + ] + }, + "author_association": { "type": "string", "example": "OWNER" }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "example": false, + "type": "boolean" + } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association" + ] + }, + "simple-commit-status": { + "title": "Simple Commit Status", + "type": "object", + "properties": { + "description": { "type": "string", "nullable": true }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "state": { "type": "string" }, + "context": { "type": "string" }, + "target_url": { "type": "string", "format": "uri" }, + "required": { "type": "boolean", "nullable": true }, + "avatar_url": { "type": "string", "nullable": true, "format": "uri" }, + "url": { "type": "string", "format": "uri" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } + }, + "required": [ + "description", + "id", + "node_id", + "state", + "context", + "target_url", + "avatar_url", + "url", + "created_at", + "updated_at" + ] + }, + "combined-commit-status": { + "title": "Combined Commit Status", + "description": "Combined Commit Status", + "type": "object", + "properties": { + "state": { "type": "string" }, + "statuses": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-commit-status" } + }, + "sha": { "type": "string" }, + "total_count": { "type": "integer" }, + "repository": { "$ref": "#/components/schemas/minimal-repository" }, + "commit_url": { "type": "string", "format": "uri" }, + "url": { "type": "string", "format": "uri" } + }, + "required": [ + "state", + "sha", + "total_count", + "statuses", + "repository", + "commit_url", + "url" + ] + }, + "status": { + "title": "Status", + "description": "The status of a commit.", + "type": "object", + "properties": { + "url": { "type": "string" }, + "avatar_url": { "type": "string", "nullable": true }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "state": { "type": "string" }, + "description": { "type": "string" }, + "target_url": { "type": "string" }, + "context": { "type": "string" }, + "created_at": { "type": "string" }, + "updated_at": { "type": "string" }, + "creator": { "$ref": "#/components/schemas/simple-user" } + }, + "required": [ + "url", + "avatar_url", + "id", + "node_id", + "state", + "description", + "target_url", + "context", + "created_at", + "updated_at", + "creator" + ] + }, + "code-of-conduct-simple": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/citizen_code_of_conduct" + }, + "key": { "type": "string", "example": "citizen_code_of_conduct" }, + "name": { "type": "string", "example": "Citizen Code of Conduct" }, + "html_url": { "type": "string", "nullable": true, "format": "uri" } + }, + "required": ["url", "key", "name", "html_url"] + }, + "community-health-file": { + "title": "Community Health File", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" } + }, + "required": ["url", "html_url"] + }, + "community-profile": { + "title": "Community Profile", + "description": "Community Profile", + "type": "object", + "properties": { + "health_percentage": { "type": "integer", "example": 100 }, + "description": { + "type": "string", + "example": "My first repository on GitHub!", + "nullable": true + }, + "documentation": { + "type": "string", + "example": "example.com", + "nullable": true + }, + "files": { + "type": "object", + "properties": { + "code_of_conduct": { + "nullable": true, + "allOf": [ + { "$ref": "#/components/schemas/code-of-conduct-simple" } + ] + }, + "license": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/license-simple" }] + }, + "contributing": { + "nullable": true, + "allOf": [ + { "$ref": "#/components/schemas/community-health-file" } + ] + }, + "readme": { + "nullable": true, + "allOf": [ + { "$ref": "#/components/schemas/community-health-file" } + ] + }, + "issue_template": { + "nullable": true, + "allOf": [ + { "$ref": "#/components/schemas/community-health-file" } + ] + }, + "pull_request_template": { + "nullable": true, + "allOf": [ + { "$ref": "#/components/schemas/community-health-file" } + ] + } + }, + "required": [ + "code_of_conduct", + "license", + "contributing", + "readme", + "issue_template", + "pull_request_template" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-02-28T19:09:29Z", + "nullable": true + }, + "content_reports_enabled": { "type": "boolean", "example": true } + }, + "required": [ + "health_percentage", + "description", + "documentation", + "files", + "updated_at" + ] + }, + "diff-entry": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "example": "bbcd538c8e72b8c175046e27cc8f907076331401" + }, + "filename": { "type": "string", "example": "file1.txt" }, + "status": { "type": "string", "example": "added" }, + "additions": { "type": "integer", "example": 103 }, + "deletions": { "type": "integer", "example": 21 }, + "changes": { "type": "integer", "example": 124 }, + "blob_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + }, + "raw_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + }, + "contents_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "patch": { + "type": "string", + "example": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + }, + "previous_filename": { "type": "string", "example": "file.txt" } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + }, + "commit-comparison": { + "title": "Commit Comparison", + "description": "Commit Comparison", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/compare/master...topic" + }, + "permalink_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17" + }, + "diff_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/compare/master...topic.diff" + }, + "patch_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/compare/master...topic.patch" + }, + "base_commit": { "$ref": "#/components/schemas/commit" }, + "merge_base_commit": { "$ref": "#/components/schemas/commit" }, + "status": { + "type": "string", + "enum": ["diverged", "ahead", "behind", "identical"], + "example": "ahead" + }, + "ahead_by": { "type": "integer", "example": 4 }, + "behind_by": { "type": "integer", "example": 5 }, + "total_commits": { "type": "integer", "example": 6 }, + "commits": { + "type": "array", + "items": { "$ref": "#/components/schemas/commit" } + }, + "files": { + "type": "array", + "items": { "$ref": "#/components/schemas/diff-entry" } + } + }, + "required": [ + "url", + "html_url", + "permalink_url", + "diff_url", + "patch_url", + "base_commit", + "merge_base_commit", + "status", + "ahead_by", + "behind_by", + "total_commits", + "commits", + "files" + ] + }, + "content-tree": { + "title": "Content Tree", + "description": "Content Tree", + "type": "object", + "properties": { + "type": { "type": "string" }, + "size": { "type": "integer" }, + "name": { "type": "string" }, + "path": { "type": "string" }, + "sha": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "git_url": { "type": "string", "format": "uri", "nullable": true }, + "html_url": { "type": "string", "format": "uri", "nullable": true }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { "type": "string" }, + "size": { "type": "integer" }, + "name": { "type": "string" }, + "path": { "type": "string" }, + "content": { "type": "string" }, + "sha": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { "type": "string", "format": "uri" } + }, + "required": ["git", "html", "self"] + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url" + ] + } + }, + "_links": { + "type": "object", + "properties": { + "git": { "type": "string", "format": "uri", "nullable": true }, + "html": { "type": "string", "format": "uri", "nullable": true }, + "self": { "type": "string", "format": "uri" } + }, + "required": ["git", "html", "self"] + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "content-directory": { + "title": "Content Directory", + "description": "A list of directory items", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { "type": "string" }, + "size": { "type": "integer" }, + "name": { "type": "string" }, + "path": { "type": "string" }, + "content": { "type": "string" }, + "sha": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "git_url": { "type": "string", "format": "uri", "nullable": true }, + "html_url": { "type": "string", "format": "uri", "nullable": true }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { "type": "string", "format": "uri", "nullable": true }, + "html": { "type": "string", "format": "uri", "nullable": true }, + "self": { "type": "string", "format": "uri" } + }, + "required": ["git", "html", "self"] + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url" + ] + } + }, + "content-file": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { "type": "string" }, + "encoding": { "type": "string" }, + "size": { "type": "integer" }, + "name": { "type": "string" }, + "path": { "type": "string" }, + "content": { "type": "string" }, + "sha": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "git_url": { "type": "string", "format": "uri", "nullable": true }, + "html_url": { "type": "string", "format": "uri", "nullable": true }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { "type": "string", "format": "uri", "nullable": true }, + "html": { "type": "string", "format": "uri", "nullable": true }, + "self": { "type": "string", "format": "uri" } + }, + "required": ["git", "html", "self"] + }, + "target": { "type": "string", "example": "\"actual/actual.md\"" }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "content-symlink": { + "title": "Symlink Content", + "description": "An object describing a symlink", + "type": "object", + "properties": { + "type": { "type": "string" }, + "target": { "type": "string" }, + "size": { "type": "integer" }, + "name": { "type": "string" }, + "path": { "type": "string" }, + "sha": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "git_url": { "type": "string", "format": "uri", "nullable": true }, + "html_url": { "type": "string", "format": "uri", "nullable": true }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { "type": "string", "format": "uri", "nullable": true }, + "html": { "type": "string", "format": "uri", "nullable": true }, + "self": { "type": "string", "format": "uri" } + }, + "required": ["git", "html", "self"] + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "target" + ] + }, + "content-submodule": { + "title": "Symlink Content", + "description": "An object describing a symlink", + "type": "object", + "properties": { + "type": { "type": "string" }, + "submodule_git_url": { "type": "string", "format": "uri" }, + "size": { "type": "integer" }, + "name": { "type": "string" }, + "path": { "type": "string" }, + "sha": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "git_url": { "type": "string", "format": "uri", "nullable": true }, + "html_url": { "type": "string", "format": "uri", "nullable": true }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { "type": "string", "format": "uri", "nullable": true }, + "html": { "type": "string", "format": "uri", "nullable": true }, + "self": { "type": "string", "format": "uri" } + }, + "required": ["git", "html", "self"] + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "submodule_git_url" + ] + }, + "file-commit": { + "title": "File Commit", + "description": "File Commit", + "type": "object", + "required": ["content", "commit"], + "properties": { + "content": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "path": { "type": "string" }, + "sha": { "type": "string" }, + "size": { "type": "integer" }, + "url": { "type": "string" }, + "html_url": { "type": "string" }, + "git_url": { "type": "string" }, + "download_url": { "type": "string" }, + "type": { "type": "string" }, + "_links": { + "type": "object", + "properties": { + "self": { "type": "string" }, + "git": { "type": "string" }, + "html": { "type": "string" } + } + } + }, + "nullable": true + }, + "commit": { + "type": "object", + "properties": { + "sha": { "type": "string" }, + "node_id": { "type": "string" }, + "url": { "type": "string" }, + "html_url": { "type": "string" }, + "author": { + "type": "object", + "properties": { + "date": { "type": "string" }, + "name": { "type": "string" }, + "email": { "type": "string" } + } + }, + "committer": { + "type": "object", + "properties": { + "date": { "type": "string" }, + "name": { "type": "string" }, + "email": { "type": "string" } + } + }, + "message": { "type": "string" }, + "tree": { + "type": "object", + "properties": { + "url": { "type": "string" }, + "sha": { "type": "string" } + } + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { "type": "string" }, + "html_url": { "type": "string" }, + "sha": { "type": "string" } + } + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { "type": "boolean" }, + "reason": { "type": "string" }, + "signature": { "type": "string", "nullable": true }, + "payload": { "type": "string", "nullable": true } + } + } + } + } + } + }, + "contributor": { + "title": "Contributor", + "description": "Contributor", + "type": "object", + "properties": { + "login": { "type": "string" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "avatar_url": { "type": "string", "format": "uri" }, + "gravatar_id": { "type": "string", "nullable": true }, + "url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" }, + "followers_url": { "type": "string", "format": "uri" }, + "following_url": { "type": "string" }, + "gists_url": { "type": "string" }, + "starred_url": { "type": "string" }, + "subscriptions_url": { "type": "string", "format": "uri" }, + "organizations_url": { "type": "string", "format": "uri" }, + "repos_url": { "type": "string", "format": "uri" }, + "events_url": { "type": "string" }, + "received_events_url": { "type": "string", "format": "uri" }, + "type": { "type": "string" }, + "site_admin": { "type": "boolean" }, + "contributions": { "type": "integer" }, + "email": { "type": "string" }, + "name": { "type": "string" } + }, + "required": ["contributions", "type"] + }, + "deployment": { + "title": "Deployment", + "description": "A request for a specific ref(branch,sha,tag) to be deployed", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1" + }, + "id": { + "description": "Unique identifier of the deployment", + "example": 42, + "type": "integer" + }, + "node_id": { "type": "string", "example": "MDEwOkRlcGxveW1lbnQx" }, + "sha": { + "type": "string", + "example": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" + }, + "ref": { + "description": "The ref to deploy. This can be a branch, tag, or sha.", + "example": "topic-branch", + "type": "string" + }, + "task": { + "description": "Parameter to specify a task to execute", + "example": "deploy", + "type": "string" + }, + "payload": { "type": "object", "properties": {} }, + "original_environment": { "type": "string", "example": "staging" }, + "environment": { + "description": "Name for the target deployment environment.", + "example": "production", + "type": "string" + }, + "description": { + "type": "string", + "example": "Deploy request from hubot", + "nullable": true + }, + "creator": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "statuses_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example" + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "example": true, + "type": "boolean" + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "example": true, + "type": "boolean" + }, + "performed_via_github_app": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/integration" }] + } + }, + "required": [ + "id", + "node_id", + "sha", + "ref", + "task", + "environment", + "creator", + "payload", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + }, + "deployment-status": { + "title": "Deployment Status", + "description": "The status of a deployment.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1" + }, + "id": { "type": "integer", "example": 1 }, + "node_id": { + "type": "string", + "example": "MDE2OkRlcGxveW1lbnRTdGF0dXMx" + }, + "state": { + "description": "The state of the status.", + "enum": [ + "error", + "failure", + "inactive", + "pending", + "success", + "queued", + "in_progress" + ], + "example": "success", + "type": "string" + }, + "creator": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "description": { + "description": "A short description of the status.", + "default": "", + "type": "string", + "maxLength": 140, + "example": "Deployment finished successfully." + }, + "environment": { + "description": "The environment of the deployment that the status is for.", + "default": "", + "type": "string", + "example": "production" + }, + "target_url": { + "description": "Deprecated: the URL to associate with this status.", + "default": "", + "type": "string", + "format": "uri", + "example": "https://example.com/deployment/42/output" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "deployment_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/42" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example" + }, + "environment_url": { + "description": "The URL for accessing your environment.", + "default": "", + "type": "string", + "format": "uri", + "example": "https://staging.example.com/" + }, + "log_url": { + "description": "The URL to associate with this status.", + "default": "", + "type": "string", + "format": "uri", + "example": "https://example.com/deployment/42/output" + }, + "performed_via_github_app": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/integration" }] + } + }, + "required": [ + "id", + "node_id", + "state", + "creator", + "description", + "deployment_url", + "target_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + }, + "short-blob": { + "title": "Short Blob", + "description": "Short Blob", + "type": "object", + "properties": { + "url": { "type": "string" }, + "sha": { "type": "string" } + }, + "required": ["url", "sha"] + }, + "blob": { + "title": "Blob", + "description": "Blob", + "type": "object", + "properties": { + "content": { "type": "string" }, + "encoding": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "sha": { "type": "string" }, + "size": { "type": "integer", "nullable": true }, + "node_id": { "type": "string" }, + "highlighted_content": { "type": "string" } + }, + "required": ["sha", "url", "node_id", "size", "content", "encoding"] + }, + "git-commit": { + "title": "Git Commit", + "description": "Low-level Git commit operations within a repository", + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd", + "type": "string" + }, + "node_id": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "author": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "example": "2014-08-09T08:02:04+12:00", + "format": "date-time", + "type": "string" + }, + "email": { + "type": "string", + "description": "Git email address of the user", + "example": "monalisa.octocat@example.com" + }, + "name": { + "description": "Name of the git user", + "example": "Monalisa Octocat", + "type": "string" + } + }, + "required": ["email", "name", "date"] + }, + "committer": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "example": "2014-08-09T08:02:04+12:00", + "format": "date-time", + "type": "string" + }, + "email": { + "type": "string", + "description": "Git email address of the user", + "example": "monalisa.octocat@example.com" + }, + "name": { + "description": "Name of the git user", + "example": "Monalisa Octocat", + "type": "string" + } + }, + "required": ["email", "name", "date"] + }, + "message": { + "description": "Message describing the purpose of the commit", + "example": "Fix #42", + "type": "string" + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd", + "type": "string" + }, + "url": { "type": "string", "format": "uri" } + }, + "required": ["sha", "url"] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd", + "type": "string" + }, + "url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" } + }, + "required": ["sha", "url", "html_url"] + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { "type": "boolean" }, + "reason": { "type": "string" }, + "signature": { "type": "string", "nullable": true }, + "payload": { "type": "string", "nullable": true } + }, + "required": ["verified", "reason", "signature", "payload"] + }, + "html_url": { "type": "string", "format": "uri" } + }, + "required": [ + "sha", + "node_id", + "url", + "html_url", + "author", + "committer", + "tree", + "message", + "parents", + "verification" + ] + }, + "git-ref": { + "title": "Git Reference", + "description": "Git references within a repository", + "type": "object", + "properties": { + "ref": { "type": "string" }, + "node_id": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "object": { + "type": "object", + "properties": { + "type": { "type": "string" }, + "sha": { + "description": "SHA for the reference", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd", + "type": "string", + "minLength": 40, + "maxLength": 40 + }, + "url": { "type": "string", "format": "uri" } + }, + "required": ["type", "sha", "url"] + } + }, + "required": ["ref", "node_id", "url", "object"] + }, + "git-tag": { + "title": "Git Tag", + "description": "Metadata for a Git tag", + "type": "object", + "properties": { + "node_id": { + "type": "string", + "example": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==" + }, + "tag": { + "description": "Name of the tag", + "example": "v0.0.1", + "type": "string" + }, + "sha": { + "type": "string", + "example": "940bd336248efae0f9ee5bc7b2d5c985887b16ac" + }, + "url": { + "description": "URL for the tag", + "example": "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "type": "string", + "format": "uri" + }, + "message": { + "description": "Message describing the purpose of the tag", + "example": "Initial public release", + "type": "string" + }, + "tagger": { + "type": "object", + "properties": { + "date": { "type": "string" }, + "email": { "type": "string" }, + "name": { "type": "string" } + }, + "required": ["date", "email", "name"] + }, + "object": { + "type": "object", + "properties": { + "sha": { "type": "string" }, + "type": { "type": "string" }, + "url": { "type": "string", "format": "uri" } + }, + "required": ["sha", "type", "url"] + }, + "verification": { "$ref": "#/components/schemas/verification" } + }, + "required": [ + "sha", + "url", + "node_id", + "tagger", + "object", + "tag", + "message" + ] + }, + "git-tree": { + "title": "Git Tree", + "description": "The hierarchy between files in a Git repository.", + "type": "object", + "properties": { + "sha": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "truncated": { "type": "boolean" }, + "tree": { + "description": "Objects specifying a tree structure", + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { "type": "string", "example": "test/file.rb" }, + "mode": { "type": "string", "example": "040000" }, + "type": { "type": "string", "example": "tree" }, + "sha": { + "type": "string", + "example": "23f6827669e43831def8a7ad935069c8bd418261" + }, + "size": { "type": "integer", "example": 12 }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" + } + } + }, + "example": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 30, + "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", + "properties": { + "path": { "type": "string" }, + "mode": { "type": "string" }, + "type": { "type": "string" }, + "size": { "type": "integer" }, + "sha": { "type": "string" }, + "url": { "type": "string" } + }, + "required": ["path", "mode", "type", "sha", "url", "size"] + } + ] + } + }, + "required": ["sha", "url", "tree", "truncated"] + }, + "hook-response": { + "title": "Hook Response", + "type": "object", + "properties": { + "code": { "type": "integer", "nullable": true }, + "status": { "type": "string", "nullable": true }, + "message": { "type": "string", "nullable": true } + }, + "required": ["code", "status", "message"] + }, + "hook": { + "title": "Webhook", + "description": "Webhooks for repositories.", + "type": "object", + "properties": { + "type": { "type": "string" }, + "id": { + "description": "Unique identifier of the webhook.", + "example": 42, + "type": "integer" + }, + "name": { + "description": "The name of a valid service, use 'web' for a webhook.", + "example": "web", + "type": "string" + }, + "active": { + "description": "Determines whether the hook is actually triggered on pushes.", + "type": "boolean", + "example": true + }, + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { "type": "string" }, + "example": ["push", "pull_request"] + }, + "config": { + "type": "object", + "properties": { + "email": { "type": "string", "example": "\"foo@bar.com\"" }, + "password": { "type": "string", "example": "\"foo\"" }, + "room": { "type": "string", "example": "\"roomer\"" }, + "subdomain": { "type": "string", "example": "\"foo\"" }, + "url": { "$ref": "#/components/schemas/webhook-config-url" }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "digest": { "type": "string", "example": "\"sha256\"" }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "token": { "type": "string", "example": "\"abc\"" } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1" + }, + "test_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" + }, + "ping_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + }, + "last_response": { "$ref": "#/components/schemas/hook-response" } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at", + "last_response", + "test_url" + ] + }, + "import": { + "title": "Import", + "description": "A repository import from an external source.", + "type": "object", + "properties": { + "vcs": { "type": "string", "nullable": true }, + "use_lfs": { "type": "string" }, + "vcs_url": { + "description": "The URL of the originating repository.", + "type": "string" + }, + "svc_root": { "type": "string" }, + "tfvc_project": { "type": "string" }, + "status": { + "type": "string", + "enum": [ + "auth", + "error", + "none", + "detecting", + "choose", + "auth_failed", + "importing", + "mapping", + "waiting_to_push", + "pushing", + "complete", + "setup", + "unknown", + "detection_found_multiple", + "detection_found_nothing", + "detection_needs_auth" + ] + }, + "status_text": { "type": "string", "nullable": true }, + "failed_step": { "type": "string", "nullable": true }, + "error_message": { "type": "string", "nullable": true }, + "import_percent": { "type": "integer", "nullable": true }, + "commit_count": { "type": "integer", "nullable": true }, + "push_percent": { "type": "integer", "nullable": true }, + "has_large_files": { "type": "boolean" }, + "large_files_size": { "type": "integer" }, + "large_files_count": { "type": "integer" }, + "project_choices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "vcs": { "type": "string" }, + "tfvc_project": { "type": "string" }, + "human_name": { "type": "string" } + } + } + }, + "message": { "type": "string" }, + "authors_count": { "type": "integer", "nullable": true }, + "url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" }, + "authors_url": { "type": "string", "format": "uri" }, + "repository_url": { "type": "string", "format": "uri" }, + "svn_root": { "type": "string" } + }, + "required": [ + "vcs", + "vcs_url", + "status", + "url", + "repository_url", + "html_url", + "authors_url" + ] + }, + "porter-author": { + "title": "Porter Author", + "description": "Porter Author", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "remote_id": { "type": "string" }, + "remote_name": { "type": "string" }, + "email": { "type": "string" }, + "name": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "import_url": { "type": "string", "format": "uri" } + }, + "required": [ + "id", + "remote_id", + "remote_name", + "email", + "name", + "url", + "import_url" + ] + }, + "porter-large-file": { + "title": "Porter Large File", + "description": "Porter Large File", + "type": "object", + "properties": { + "ref_name": { "type": "string" }, + "path": { "type": "string" }, + "oid": { "type": "string" }, + "size": { "type": "integer" } + }, + "required": ["oid", "path", "ref_name", "size"] + }, + "issue-event-label": { + "title": "Issue Event Label", + "description": "Issue Event Label", + "type": "object", + "properties": { + "name": { "type": "string", "nullable": true }, + "color": { "type": "string", "nullable": true } + }, + "required": ["name", "color"] + }, + "issue-event-dismissed-review": { + "title": "Issue Event Dismissed Review", + "type": "object", + "properties": { + "state": { "type": "string" }, + "review_id": { "type": "integer" }, + "dismissal_message": { "type": "string", "nullable": true }, + "dismissal_commit_id": { "type": "string", "nullable": true } + }, + "required": ["state", "review_id", "dismissal_message"] + }, + "issue-event-milestone": { + "title": "Issue Event Milestone", + "description": "Issue Event Milestone", + "type": "object", + "properties": { "title": { "type": "string" } }, + "required": ["title"] + }, + "issue-event-project-card": { + "title": "Issue Event Project Card", + "description": "Issue Event Project Card", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "id": { "type": "integer" }, + "project_url": { "type": "string", "format": "uri" }, + "project_id": { "type": "integer" }, + "column_name": { "type": "string" }, + "previous_column_name": { "type": "string" } + }, + "required": ["url", "id", "project_url", "project_id", "column_name"] + }, + "issue-event-rename": { + "title": "Issue Event Rename", + "description": "Issue Event Rename", + "type": "object", + "properties": { + "from": { "type": "string" }, + "to": { "type": "string" } + }, + "required": ["from", "to"] + }, + "issue-event": { + "title": "Issue Event", + "description": "Issue Event", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 1 }, + "node_id": { "type": "string", "example": "MDEwOklzc3VlRXZlbnQx" }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + }, + "actor": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "event": { "type": "string", "example": "closed" }, + "commit_id": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "commit_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue": { "$ref": "#/components/schemas/issue-simple" }, + "label": { "$ref": "#/components/schemas/issue-event-label" }, + "assignee": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "assigner": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "review_requester": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "requested_reviewer": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "requested_team": { "$ref": "#/components/schemas/team" }, + "dismissed_review": { + "$ref": "#/components/schemas/issue-event-dismissed-review" + }, + "milestone": { "$ref": "#/components/schemas/issue-event-milestone" }, + "project_card": { + "$ref": "#/components/schemas/issue-event-project-card" + }, + "rename": { "$ref": "#/components/schemas/issue-event-rename" }, + "author_association": { "type": "string" }, + "lock_reason": { "type": "string", "nullable": true } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at" + ] + }, + "issue-event-for-issue": { + "title": "Issue Event for Issue", + "description": "Issue Event for Issue", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "url": { "type": "string" }, + "actor": { "$ref": "#/components/schemas/simple-user" }, + "event": { "type": "string" }, + "commit_id": { "type": "string", "nullable": true }, + "commit_url": { "type": "string", "nullable": true }, + "created_at": { "type": "string" }, + "sha": { + "type": "string", + "example": "\"480d4f47447129f015cb327536c522ca683939a1\"" + }, + "html_url": { + "type": "string", + "example": "\"https://github.com/owner-3906e11a33a3d55ba449d63f/BBB_Private_Repo/commit/480d4f47447129f015cb327536c522ca683939a1\"" + }, + "message": { + "type": "string", + "example": "\"add a bunch of files\"" + }, + "issue_url": { + "type": "string", + "example": "\"https://api.github.com/repos/owner-3906e11a33a3d55ba449d63f/AAA_Public_Repo/issues/1\"" + }, + "updated_at": { + "type": "string", + "example": "\"2020-07-09T00:17:36Z\"" + }, + "author_association": { + "type": "string", + "example": "\"COLLABORATOR\"" + }, + "body": { "type": "string", "example": "\":+1:\"" }, + "lock_reason": { "type": "string", "example": "\"off-topic\"" }, + "submitted_at": { + "type": "string", + "example": "\"2020-07-09T00:17:51Z\"" + }, + "state": { "type": "string", "example": "\"commented\"" }, + "pull_request_url": { + "type": "string", + "example": "\"https://api.github.com/repos/owner-3906e11a33a3d55ba449d63f/AAA_Public_Repo/pulls/2\"" + }, + "body_html": { + "type": "string", + "example": "\"

Accusantium fugiat cumque. Autem qui nostrum. Atque quae ullam.

\"" + }, + "body_text": { + "type": "string", + "example": "\"Accusantium fugiat cumque. Autem qui nostrum. Atque quae ullam.\"" + } + } + }, + "deploy-key": { + "title": "Deploy Key", + "description": "An SSH key granting access to a single repository.", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "key": { "type": "string" }, + "url": { "type": "string" }, + "title": { "type": "string" }, + "verified": { "type": "boolean" }, + "created_at": { "type": "string" }, + "read_only": { "type": "boolean" } + }, + "required": [ + "id", + "key", + "url", + "title", + "verified", + "created_at", + "read_only" + ] + }, + "language": { + "title": "Language", + "description": "Language", + "type": "object", + "additionalProperties": { "type": "integer" } + }, + "license-content": { + "title": "License Content", + "description": "License Content", + "type": "object", + "properties": { + "name": { "type": "string" }, + "path": { "type": "string" }, + "sha": { "type": "string" }, + "size": { "type": "integer" }, + "url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri", "nullable": true }, + "git_url": { "type": "string", "format": "uri", "nullable": true }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "type": { "type": "string" }, + "content": { "type": "string" }, + "encoding": { "type": "string" }, + "_links": { + "type": "object", + "properties": { + "git": { "type": "string", "format": "uri", "nullable": true }, + "html": { "type": "string", "format": "uri", "nullable": true }, + "self": { "type": "string", "format": "uri" } + }, + "required": ["git", "html", "self"] + }, + "license": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/license-simple" }] + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding", + "license" + ] + }, + "pages-source-hash": { + "title": "Pages Source Hash", + "type": "object", + "properties": { + "branch": { "type": "string" }, + "path": { "type": "string" } + }, + "required": ["branch", "path"] + }, + "page": { + "title": "GitHub Pages", + "description": "The configuration for GitHub Pages for a repository.", + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "The API address for accessing this Page resource.", + "format": "uri", + "example": "https://api.github.com/repos/github/hello-world/pages" + }, + "status": { + "type": "string", + "description": "The status of the most recent build of the Page.", + "example": "built", + "enum": ["built", "building", "errored"], + "nullable": true + }, + "cname": { + "description": "The Pages site's custom domain", + "example": "example.com", + "type": "string", + "nullable": true + }, + "custom_404": { + "type": "boolean", + "description": "Whether the Page has a custom 404 page.", + "example": false, + "default": false + }, + "html_url": { + "type": "string", + "description": "The web address the Page can be accessed from.", + "format": "uri", + "example": "https://example.com" + }, + "source": { "$ref": "#/components/schemas/pages-source-hash" } + }, + "required": ["url", "status", "cname", "custom_404"] + }, + "page-build": { + "title": "Page Build", + "description": "Page Build", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "status": { "type": "string" }, + "error": { + "type": "object", + "properties": { "message": { "type": "string", "nullable": true } }, + "required": ["message"] + }, + "pusher": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "commit": { "type": "string" }, + "duration": { "type": "integer" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } + }, + "required": [ + "url", + "status", + "error", + "pusher", + "commit", + "duration", + "created_at", + "updated_at" + ] + }, + "page-build-status": { + "title": "Page Build Status", + "description": "Page Build Status", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/github/hello-world/pages/builds/latest" + }, + "status": { "type": "string", "example": "queued" } + }, + "required": ["url", "status"] + }, + "pull-request": { + "type": "object", + "title": "Pull Request", + "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "id": { "type": "integer", "example": 1 }, + "node_id": { + "type": "string", + "example": "MDExOlB1bGxSZXF1ZXN0MQ==" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1347" + }, + "diff_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1347.diff" + }, + "patch_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "issue_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "commits_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + }, + "review_comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + }, + "review_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "statuses_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "enum": ["open", "closed"], + "example": "open", + "type": "string" + }, + "locked": { "type": "boolean", "example": true }, + "title": { + "description": "The title of the pull request.", + "example": "Amazing new feature", + "type": "string" + }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "body": { + "type": "string", + "example": "Please pull these awesome changes", + "nullable": true + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "url": { "type": "string" }, + "name": { "type": "string" }, + "description": { "type": "string", "nullable": true }, + "color": { "type": "string" }, + "default": { "type": "boolean" } + } + } + }, + "milestone": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/milestone" }] + }, + "active_lock_reason": { + "type": "string", + "example": "too heated", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "merged_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "merge_commit_sha": { + "type": "string", + "example": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "nullable": true + }, + "assignee": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "assignees": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" }, + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" }, + "nullable": true + }, + "requested_teams": { + "type": "array", + "items": { "$ref": "#/components/schemas/team-simple" }, + "nullable": true + }, + "head": { + "type": "object", + "properties": { + "label": { "type": "string" }, + "ref": { "type": "string" }, + "repo": { + "type": "object", + "properties": { + "archive_url": { "type": "string" }, + "assignees_url": { "type": "string" }, + "blobs_url": { "type": "string" }, + "branches_url": { "type": "string" }, + "collaborators_url": { "type": "string" }, + "comments_url": { "type": "string" }, + "commits_url": { "type": "string" }, + "compare_url": { "type": "string" }, + "contents_url": { "type": "string" }, + "contributors_url": { "type": "string", "format": "uri" }, + "deployments_url": { "type": "string", "format": "uri" }, + "description": { "type": "string", "nullable": true }, + "downloads_url": { "type": "string", "format": "uri" }, + "events_url": { "type": "string", "format": "uri" }, + "fork": { "type": "boolean" }, + "forks_url": { "type": "string", "format": "uri" }, + "full_name": { "type": "string" }, + "git_commits_url": { "type": "string" }, + "git_refs_url": { "type": "string" }, + "git_tags_url": { "type": "string" }, + "hooks_url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "issue_comment_url": { "type": "string" }, + "issue_events_url": { "type": "string" }, + "issues_url": { "type": "string" }, + "keys_url": { "type": "string" }, + "labels_url": { "type": "string" }, + "languages_url": { "type": "string", "format": "uri" }, + "merges_url": { "type": "string", "format": "uri" }, + "milestones_url": { "type": "string" }, + "name": { "type": "string" }, + "notifications_url": { "type": "string" }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { "type": "string", "format": "uri" }, + "events_url": { "type": "string" }, + "followers_url": { "type": "string", "format": "uri" }, + "following_url": { "type": "string" }, + "gists_url": { "type": "string" }, + "gravatar_id": { "type": "string", "nullable": true }, + "html_url": { "type": "string", "format": "uri" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "login": { "type": "string" }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { "type": "string", "format": "uri" }, + "site_admin": { "type": "boolean" }, + "starred_url": { "type": "string" }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { "type": "string" }, + "url": { "type": "string", "format": "uri" } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { "type": "boolean" }, + "pulls_url": { "type": "string" }, + "releases_url": { "type": "string" }, + "stargazers_url": { "type": "string", "format": "uri" }, + "statuses_url": { "type": "string" }, + "subscribers_url": { "type": "string", "format": "uri" }, + "subscription_url": { "type": "string", "format": "uri" }, + "tags_url": { "type": "string", "format": "uri" }, + "teams_url": { "type": "string", "format": "uri" }, + "trees_url": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "clone_url": { "type": "string" }, + "default_branch": { "type": "string" }, + "forks": { "type": "integer" }, + "forks_count": { "type": "integer" }, + "git_url": { "type": "string" }, + "has_downloads": { "type": "boolean" }, + "has_issues": { "type": "boolean" }, + "has_projects": { "type": "boolean" }, + "has_wiki": { "type": "boolean" }, + "has_pages": { "type": "boolean" }, + "homepage": { + "type": "string", + "format": "uri", + "nullable": true + }, + "language": { "type": "string", "nullable": true }, + "master_branch": { "type": "string" }, + "archived": { "type": "boolean" }, + "disabled": { "type": "boolean" }, + "mirror_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "open_issues": { "type": "integer" }, + "open_issues_count": { "type": "integer" }, + "permissions": { + "type": "object", + "properties": { + "admin": { "type": "boolean" }, + "pull": { "type": "boolean" }, + "push": { "type": "boolean" } + }, + "required": ["admin", "pull", "push"] + }, + "temp_clone_token": { "type": "string" }, + "allow_merge_commit": { "type": "boolean" }, + "allow_squash_merge": { "type": "boolean" }, + "allow_rebase_merge": { "type": "boolean" }, + "license": { + "type": "object", + "properties": { + "key": { "type": "string" }, + "name": { "type": "string" }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "spdx_id": { "type": "string", "nullable": true }, + "node_id": { "type": "string" } + }, + "required": ["key", "name", "url", "spdx_id", "node_id"], + "nullable": true + }, + "pushed_at": { "type": "string", "format": "date-time" }, + "size": { "type": "integer" }, + "ssh_url": { "type": "string" }, + "stargazers_count": { "type": "integer" }, + "svn_url": { "type": "string", "format": "uri" }, + "topics": { "type": "array", "items": { "type": "string" } }, + "watchers": { "type": "integer" }, + "watchers_count": { "type": "integer" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sha": { "type": "string" }, + "user": { + "type": "object", + "properties": { + "avatar_url": { "type": "string", "format": "uri" }, + "events_url": { "type": "string" }, + "followers_url": { "type": "string", "format": "uri" }, + "following_url": { "type": "string" }, + "gists_url": { "type": "string" }, + "gravatar_id": { "type": "string", "nullable": true }, + "html_url": { "type": "string", "format": "uri" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "login": { "type": "string" }, + "organizations_url": { "type": "string", "format": "uri" }, + "received_events_url": { "type": "string", "format": "uri" }, + "repos_url": { "type": "string", "format": "uri" }, + "site_admin": { "type": "boolean" }, + "starred_url": { "type": "string" }, + "subscriptions_url": { "type": "string", "format": "uri" }, + "type": { "type": "string" }, + "url": { "type": "string", "format": "uri" } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": ["label", "ref", "repo", "sha", "user"] + }, + "base": { + "type": "object", + "properties": { + "label": { "type": "string" }, + "ref": { "type": "string" }, + "repo": { + "type": "object", + "properties": { + "archive_url": { "type": "string" }, + "assignees_url": { "type": "string" }, + "blobs_url": { "type": "string" }, + "branches_url": { "type": "string" }, + "collaborators_url": { "type": "string" }, + "comments_url": { "type": "string" }, + "commits_url": { "type": "string" }, + "compare_url": { "type": "string" }, + "contents_url": { "type": "string" }, + "contributors_url": { "type": "string", "format": "uri" }, + "deployments_url": { "type": "string", "format": "uri" }, + "description": { "type": "string", "nullable": true }, + "downloads_url": { "type": "string", "format": "uri" }, + "events_url": { "type": "string", "format": "uri" }, + "fork": { "type": "boolean" }, + "forks_url": { "type": "string", "format": "uri" }, + "full_name": { "type": "string" }, + "git_commits_url": { "type": "string" }, + "git_refs_url": { "type": "string" }, + "git_tags_url": { "type": "string" }, + "hooks_url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "issue_comment_url": { "type": "string" }, + "issue_events_url": { "type": "string" }, + "issues_url": { "type": "string" }, + "keys_url": { "type": "string" }, + "labels_url": { "type": "string" }, + "languages_url": { "type": "string", "format": "uri" }, + "merges_url": { "type": "string", "format": "uri" }, + "milestones_url": { "type": "string" }, + "name": { "type": "string" }, + "notifications_url": { "type": "string" }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { "type": "string", "format": "uri" }, + "events_url": { "type": "string" }, + "followers_url": { "type": "string", "format": "uri" }, + "following_url": { "type": "string" }, + "gists_url": { "type": "string" }, + "gravatar_id": { "type": "string", "nullable": true }, + "html_url": { "type": "string", "format": "uri" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "login": { "type": "string" }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { "type": "string", "format": "uri" }, + "site_admin": { "type": "boolean" }, + "starred_url": { "type": "string" }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { "type": "string" }, + "url": { "type": "string", "format": "uri" } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { "type": "boolean" }, + "pulls_url": { "type": "string" }, + "releases_url": { "type": "string" }, + "stargazers_url": { "type": "string", "format": "uri" }, + "statuses_url": { "type": "string" }, + "subscribers_url": { "type": "string", "format": "uri" }, + "subscription_url": { "type": "string", "format": "uri" }, + "tags_url": { "type": "string", "format": "uri" }, + "teams_url": { "type": "string", "format": "uri" }, + "trees_url": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "clone_url": { "type": "string" }, + "default_branch": { "type": "string" }, + "forks": { "type": "integer" }, + "forks_count": { "type": "integer" }, + "git_url": { "type": "string" }, + "has_downloads": { "type": "boolean" }, + "has_issues": { "type": "boolean" }, + "has_projects": { "type": "boolean" }, + "has_wiki": { "type": "boolean" }, + "has_pages": { "type": "boolean" }, + "homepage": { + "type": "string", + "format": "uri", + "nullable": true + }, + "language": { "type": "string", "nullable": true }, + "master_branch": { "type": "string" }, + "archived": { "type": "boolean" }, + "disabled": { "type": "boolean" }, + "mirror_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "open_issues": { "type": "integer" }, + "open_issues_count": { "type": "integer" }, + "permissions": { + "type": "object", + "properties": { + "admin": { "type": "boolean" }, + "pull": { "type": "boolean" }, + "push": { "type": "boolean" } + }, + "required": ["admin", "pull", "push"] + }, + "temp_clone_token": { "type": "string" }, + "allow_merge_commit": { "type": "boolean" }, + "allow_squash_merge": { "type": "boolean" }, + "allow_rebase_merge": { "type": "boolean" }, + "license": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/license-simple" }] + }, + "pushed_at": { "type": "string", "format": "date-time" }, + "size": { "type": "integer" }, + "ssh_url": { "type": "string" }, + "stargazers_count": { "type": "integer" }, + "svn_url": { "type": "string", "format": "uri" }, + "topics": { "type": "array", "items": { "type": "string" } }, + "watchers": { "type": "integer" }, + "watchers_count": { "type": "integer" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "sha": { "type": "string" }, + "user": { + "type": "object", + "properties": { + "avatar_url": { "type": "string", "format": "uri" }, + "events_url": { "type": "string" }, + "followers_url": { "type": "string", "format": "uri" }, + "following_url": { "type": "string" }, + "gists_url": { "type": "string" }, + "gravatar_id": { "type": "string", "nullable": true }, + "html_url": { "type": "string", "format": "uri" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "login": { "type": "string" }, + "organizations_url": { "type": "string", "format": "uri" }, + "received_events_url": { "type": "string", "format": "uri" }, + "repos_url": { "type": "string", "format": "uri" }, + "site_admin": { "type": "boolean" }, + "starred_url": { "type": "string" }, + "subscriptions_url": { "type": "string", "format": "uri" }, + "type": { "type": "string" }, + "url": { "type": "string", "format": "uri" } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": ["label", "ref", "repo", "sha", "user"] + }, + "_links": { + "type": "object", + "properties": { + "comments": { "$ref": "#/components/schemas/link" }, + "commits": { "$ref": "#/components/schemas/link" }, + "statuses": { "$ref": "#/components/schemas/link" }, + "html": { "$ref": "#/components/schemas/link" }, + "issue": { "$ref": "#/components/schemas/link" }, + "review_comments": { "$ref": "#/components/schemas/link" }, + "review_comment": { "$ref": "#/components/schemas/link" }, + "self": { "$ref": "#/components/schemas/link" } + }, + "required": [ + "comments", + "commits", + "statuses", + "html", + "issue", + "review_comments", + "review_comment", + "self" + ] + }, + "author_association": { "type": "string", "example": "OWNER" }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "example": false, + "type": "boolean" + }, + "merged": { "type": "boolean" }, + "mergeable": { "type": "boolean", "example": true, "nullable": true }, + "rebaseable": { + "type": "boolean", + "example": true, + "nullable": true + }, + "mergeable_state": { "type": "string", "example": "clean" }, + "merged_by": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "comments": { "type": "integer", "example": 10 }, + "review_comments": { "type": "integer", "example": 0 }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "example": true, + "type": "boolean" + }, + "commits": { "type": "integer", "example": 3 }, + "additions": { "type": "integer", "example": 100 }, + "deletions": { "type": "integer", "example": 3 }, + "changed_files": { "type": "integer", "example": 5 } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "additions", + "changed_files", + "comments", + "commits", + "deletions", + "mergeable", + "mergeable_state", + "merged", + "maintainer_can_modify", + "merged_by", + "review_comments" + ] + }, + "pull-request-review-comment": { + "title": "Pull Request Review Comment", + "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", + "type": "object", + "properties": { + "url": { + "description": "URL for the pull request review comment", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "type": "string" + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "example": 42, + "type": "integer", + "nullable": true + }, + "id": { + "description": "The ID of the pull request review comment.", + "example": 1, + "type": "integer" + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string", + "example": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string", + "example": "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "example": "config/database.yaml", + "type": "string" + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "example": 1, + "type": "integer" + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies.", + "example": 4, + "type": "integer" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "type": "string" + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "example": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", + "type": "string" + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "example": 8, + "type": "integer" + }, + "user": { "$ref": "#/components/schemas/simple-user" }, + "body": { + "description": "The text of the comment.", + "example": "We should probably include a check for null values here.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request_url": { + "description": "URL for the pull request that the review comment belongs to.", + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + }, + "author_association": { + "description": "How the author of the comment is associated with the pull request.", + "type": "string", + "example": "OWNER" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + } + }, + "required": ["href"] + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + } + }, + "required": ["href"] + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + } + }, + "required": ["href"] + } + }, + "required": ["self", "html", "pull_request"] + }, + "start_line": { + "type": "integer", + "description": "The first line of the range for a multi-line comment.", + "example": 2, + "nullable": true + }, + "original_start_line": { + "type": "integer", + "description": "The first line of the range for a multi-line comment.", + "example": 2, + "nullable": true + }, + "start_side": { + "type": "string", + "description": "The side of the first line of the range for a multi-line comment.", + "enum": ["LEFT", "RIGHT"], + "default": "RIGHT", + "nullable": true + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "example": 2, + "type": "integer" + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "example": 2, + "type": "integer" + }, + "side": { + "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", + "enum": ["LEFT", "RIGHT"], + "default": "RIGHT", + "type": "string" + }, + "reactions": { "$ref": "#/components/schemas/reaction-rollup" }, + "body_html": { + "type": "string", + "example": "\"

comment body

\"" + }, + "body_text": { "type": "string", "example": "\"comment body\"" } + }, + "required": [ + "url", + "id", + "node_id", + "pull_request_review_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "author_association", + "_links" + ] + }, + "pull-request-merge-result": { + "title": "Pull Request Merge Result", + "description": "Pull Request Merge Result", + "type": "object", + "properties": { + "sha": { "type": "string" }, + "merged": { "type": "boolean" }, + "message": { "type": "string" } + }, + "required": ["merged", "message", "sha"] + }, + "pull-request-review-request": { + "title": "Pull Request Review Request", + "description": "Pull Request Review Request", + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" } + }, + "teams": { + "type": "array", + "items": { "$ref": "#/components/schemas/team-simple" } + } + }, + "required": ["users", "teams"] + }, + "pull-request-review": { + "title": "Pull Request Review", + "description": "Pull Request Reviews are reviews on pull requests.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the review", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" + }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "body": { + "description": "The text of the review.", + "example": "This looks great.", + "type": "string" + }, + "state": { "type": "string", "example": "CHANGES_REQUESTED" }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "object", + "properties": { "href": { "type": "string" } }, + "required": ["href"] + }, + "pull_request": { + "type": "object", + "properties": { "href": { "type": "string" } }, + "required": ["href"] + } + }, + "required": ["html", "pull_request"] + }, + "submitted_at": { "type": "string", "format": "date-time" }, + "commit_id": { + "description": "A commit SHA for the review.", + "example": "54bb654c9e6025347f57900a4a5c2313a96b8035", + "type": "string" + }, + "body_html": { "type": "string" }, + "body_text": { "type": "string" }, + "author_association": { "type": "string" } + }, + "required": [ + "id", + "node_id", + "user", + "body", + "state", + "commit_id", + "html_url", + "pull_request_url", + "_links", + "author_association" + ] + }, + "review-comment": { + "title": "Legacy Review Comment", + "description": "Legacy Review Comment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + }, + "pull_request_review_id": { + "type": "integer", + "example": 42, + "nullable": true + }, + "id": { "type": "integer", "example": 10 }, + "node_id": { + "type": "string", + "example": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" + }, + "diff_hunk": { + "type": "string", + "example": "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + }, + "path": { "type": "string", "example": "file1.txt" }, + "position": { "type": "integer", "example": 1, "nullable": true }, + "original_position": { "type": "integer", "example": 4 }, + "commit_id": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "original_commit_id": { + "type": "string", + "example": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840" + }, + "in_reply_to_id": { "type": "integer", "example": 8 }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "body": { "type": "string", "example": "Great stuff" }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + }, + "author_association": { "type": "string" }, + "_links": { + "type": "object", + "properties": { + "self": { "$ref": "#/components/schemas/link" }, + "html": { "$ref": "#/components/schemas/link" }, + "pull_request": { "$ref": "#/components/schemas/link" } + }, + "required": ["self", "html", "pull_request"] + }, + "body_text": { "type": "string" }, + "body_html": { "type": "string" }, + "side": { + "description": "The side of the first line of the range for a multi-line comment.", + "enum": ["LEFT", "RIGHT"], + "default": "RIGHT", + "type": "string" + }, + "start_side": { + "type": "string", + "description": "The side of the first line of the range for a multi-line comment.", + "enum": ["LEFT", "RIGHT"], + "default": "RIGHT", + "nullable": true + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "example": 2, + "type": "integer" + }, + "original_line": { + "description": "The original line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "example": 2, + "type": "integer" + }, + "start_line": { + "description": "The first line of the range for a multi-line comment.", + "example": 2, + "type": "integer", + "nullable": true + }, + "original_start_line": { + "description": "The original first line of the range for a multi-line comment.", + "example": 2, + "type": "integer", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "body", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "pull_request_review_id", + "html_url", + "pull_request_url", + "_links", + "author_association", + "created_at", + "updated_at" + ] + }, + "release-asset": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "browser_download_url": { "type": "string", "format": "uri" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "name": { + "description": "The file name of the asset.", + "type": "string", + "example": "Team Environment" + }, + "label": { "type": "string", "nullable": true }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": ["uploaded", "open"] + }, + "content_type": { "type": "string" }, + "size": { "type": "integer" }, + "download_count": { "type": "integer" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" }, + "uploader": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + } + }, + "required": [ + "id", + "name", + "content_type", + "size", + "state", + "url", + "node_id", + "download_count", + "label", + "uploader", + "browser_download_url", + "created_at", + "updated_at" + ] + }, + "release": { + "title": "Release", + "description": "A release.", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" }, + "assets_url": { "type": "string", "format": "uri" }, + "upload_url": { "type": "string" }, + "tarball_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "zipball_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "tag_name": { + "description": "The name of the tag.", + "example": "v1.0.0", + "type": "string" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "example": "master", + "type": "string" + }, + "name": { "type": "string", "nullable": true }, + "body": { "type": "string", "nullable": true }, + "draft": { + "description": "true to create a draft (unpublished) release, false to create a published one.", + "example": false, + "type": "boolean" + }, + "prerelease": { + "description": "Whether to identify the release as a prerelease or a full release.", + "example": false, + "type": "boolean" + }, + "created_at": { "type": "string", "format": "date-time" }, + "published_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "author": { "$ref": "#/components/schemas/simple-user" }, + "assets": { + "type": "array", + "items": { "$ref": "#/components/schemas/release-asset" } + }, + "body_html": { "type": "string" }, + "body_text": { "type": "string" } + }, + "required": [ + "assets_url", + "upload_url", + "tarball_url", + "zipball_url", + "created_at", + "published_at", + "draft", + "id", + "node_id", + "author", + "html_url", + "name", + "prerelease", + "tag_name", + "target_commitish", + "assets", + "url" + ] + }, + "secret-scanning-alert-state": { + "description": "Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": ["open", "resolved"] + }, + "secret-scanning-alert-resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", + "nullable": true, + "oneOf": [ + { + "enum": ["false_positive", "wont_fix", "revoked", "used_in_tests"] + }, + { "enum": [null] } + ] + }, + "secret-scanning-alert": { + "type": "object", + "properties": { + "number": { "$ref": "#/components/schemas/alert-number" }, + "created_at": { "$ref": "#/components/schemas/alert-created-at" }, + "url": { "$ref": "#/components/schemas/alert-url" }, + "html_url": { "$ref": "#/components/schemas/alert-html-url" }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { "$ref": "#/components/schemas/simple-user" }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + } + } + }, + "stargazer": { + "title": "Stargazer", + "description": "Stargazer", + "type": "object", + "properties": { + "starred_at": { "type": "string", "format": "date-time" }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + } + }, + "required": ["starred_at", "user"] + }, + "code-frequency-stat": { + "title": "Code Frequency Stat", + "description": "Code Frequency Stat", + "type": "array", + "items": { "type": "integer" } + }, + "commit-activity": { + "title": "Commit Activity", + "description": "Commit Activity", + "type": "object", + "properties": { + "days": { + "type": "array", + "example": [0, 3, 26, 20, 39, 1, 0], + "items": { "type": "integer" } + }, + "total": { "type": "integer", "example": 89 }, + "week": { "type": "integer", "example": 1336280400 } + }, + "required": ["days", "total", "week"] + }, + "contributor-activity": { + "title": "Contributor Activity", + "description": "Contributor Activity", + "type": "object", + "properties": { + "author": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "total": { "type": "integer", "example": 135 }, + "weeks": { + "type": "array", + "example": [{ "w": "1367712000", "a": 6898, "d": 77, "c": 10 }], + "items": { + "type": "object", + "properties": { + "w": { "type": "string" }, + "a": { "type": "integer" }, + "d": { "type": "integer" }, + "c": { "type": "integer" } + } + } + } + }, + "required": ["author", "total", "weeks"] + }, + "participation-stats": { + "title": "Participation Stats", + "type": "object", + "properties": { + "all": { "type": "array", "items": { "type": "integer" } }, + "owner": { "type": "array", "items": { "type": "integer" } } + }, + "required": ["all", "owner"] + }, + "repository-subscription": { + "title": "Repository Invitation", + "description": "Repository invitations let you manage who you collaborate with.", + "type": "object", + "properties": { + "subscribed": { + "description": "Determines if notifications should be received from this repository.", + "type": "boolean", + "example": true + }, + "ignored": { + "description": "Determines if all notifications should be blocked from this repository.", + "type": "boolean" + }, + "reason": { "type": "string", "nullable": true }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-10-06T21:34:12Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/subscription" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example" + } + }, + "required": [ + "created_at", + "ignored", + "reason", + "subscribed", + "url", + "repository_url" + ] + }, + "tag": { + "title": "Tag", + "description": "Tag", + "type": "object", + "properties": { + "name": { "type": "string", "example": "v0.1" }, + "commit": { + "type": "object", + "properties": { + "sha": { "type": "string" }, + "url": { "type": "string", "format": "uri" } + }, + "required": ["sha", "url"] + }, + "zipball_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/zipball/v0.1" + }, + "tarball_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/tarball/v0.1" + }, + "node_id": { "type": "string" } + }, + "required": ["name", "node_id", "commit", "zipball_url", "tarball_url"] + }, + "topic": { + "title": "Topic", + "description": "A topic aggregates entities that are related to a subject.", + "type": "object", + "properties": { + "names": { "type": "array", "items": { "type": "string" } } + }, + "required": ["names"] + }, + "traffic": { + "title": "Traffic", + "type": "object", + "properties": { + "timestamp": { "type": "string", "format": "date-time" }, + "uniques": { "type": "integer" }, + "count": { "type": "integer" } + }, + "required": ["timestamp", "uniques", "count"] + }, + "clone-traffic": { + "title": "Clone Traffic", + "description": "Clone Traffic", + "type": "object", + "properties": { + "count": { "type": "integer", "example": 173 }, + "uniques": { "type": "integer", "example": 128 }, + "clones": { + "type": "array", + "items": { "$ref": "#/components/schemas/traffic" } + } + }, + "required": ["uniques", "count", "clones"] + }, + "content-traffic": { + "title": "Content Traffic", + "description": "Content Traffic", + "type": "object", + "properties": { + "path": { "type": "string", "example": "/github/hubot" }, + "title": { + "type": "string", + "example": "github/hubot: A customizable life embetterment robot." + }, + "count": { "type": "integer", "example": 3542 }, + "uniques": { "type": "integer", "example": 2225 } + }, + "required": ["path", "title", "uniques", "count"] + }, + "referrer-traffic": { + "title": "Referrer Traffic", + "description": "Referrer Traffic", + "type": "object", + "properties": { + "referrer": { "type": "string", "example": "Google" }, + "count": { "type": "integer", "example": 4 }, + "uniques": { "type": "integer", "example": 3 } + }, + "required": ["referrer", "uniques", "count"] + }, + "view-traffic": { + "title": "View Traffic", + "description": "View Traffic", + "type": "object", + "properties": { + "count": { "type": "integer", "example": 14850 }, + "uniques": { "type": "integer", "example": 3782 }, + "views": { + "type": "array", + "items": { "$ref": "#/components/schemas/traffic" } + } + }, + "required": ["uniques", "count", "views"] + }, + "scim-group-list-enterprise": { + "type": "object", + "properties": { + "schemas": { "type": "array", "items": { "type": "string" } }, + "totalResults": { "type": "number" }, + "itemsPerPage": { "type": "number" }, + "startIndex": { "type": "number" }, + "Resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schemas": { "type": "array", "items": { "type": "string" } }, + "id": { "type": "string" }, + "externalId": { "type": "string", "nullable": true }, + "displayName": { "type": "string" }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { "type": "string" }, + "$ref": { "type": "string" }, + "display": { "type": "string" } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { "type": "string" }, + "created": { "type": "string" }, + "lastModified": { "type": "string" }, + "location": { "type": "string" } + } + } + }, + "required": ["schemas", "id"] + } + } + }, + "required": [ + "schemas", + "totalResults", + "itemsPerPage", + "startIndex", + "Resources" + ] + }, + "scim-enterprise-group": { + "type": "object", + "properties": { + "schemas": { "type": "array", "items": { "type": "string" } }, + "id": { "type": "string" }, + "externalId": { "type": "string", "nullable": true }, + "displayName": { "type": "string" }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { "type": "string" }, + "$ref": { "type": "string" }, + "display": { "type": "string" } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { "type": "string" }, + "created": { "type": "string" }, + "lastModified": { "type": "string" }, + "location": { "type": "string" } + } + } + }, + "required": ["schemas", "id"] + }, + "scim-user-list-enterprise": { + "type": "object", + "properties": { + "schemas": { "type": "array", "items": { "type": "string" } }, + "totalResults": { "type": "number" }, + "itemsPerPage": { "type": "number" }, + "startIndex": { "type": "number" }, + "Resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schemas": { "type": "array", "items": { "type": "string" } }, + "id": { "type": "string" }, + "externalId": { "type": "string" }, + "userName": { "type": "string" }, + "name": { + "type": "object", + "properties": { + "givenName": { "type": "string" }, + "familyName": { "type": "string" } + } + }, + "emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { "type": "string" }, + "primary": { "type": "boolean" }, + "type": { "type": "string" } + } + } + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { "value": { "type": "string" } } + } + }, + "active": { "type": "boolean" }, + "meta": { + "type": "object", + "properties": { + "resourceType": { "type": "string" }, + "created": { "type": "string" }, + "lastModified": { "type": "string" }, + "location": { "type": "string" } + } + } + }, + "required": ["schemas", "id"] + } + } + }, + "required": [ + "schemas", + "totalResults", + "itemsPerPage", + "startIndex", + "Resources" + ] + }, + "scim-enterprise-user": { + "type": "object", + "properties": { + "schemas": { "type": "array", "items": { "type": "string" } }, + "id": { "type": "string" }, + "externalId": { "type": "string" }, + "userName": { "type": "string" }, + "name": { + "type": "object", + "properties": { + "givenName": { "type": "string" }, + "familyName": { "type": "string" } + } + }, + "emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { "type": "string" }, + "type": { "type": "string" }, + "primary": { "type": "boolean" } + } + } + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { "value": { "type": "string" } } + } + }, + "active": { "type": "boolean" }, + "meta": { + "type": "object", + "properties": { + "resourceType": { "type": "string" }, + "created": { "type": "string" }, + "lastModified": { "type": "string" }, + "location": { "type": "string" } + } + } + }, + "required": ["schemas", "id"] + }, + "scim-user": { + "title": "SCIM /Users", + "description": "SCIM /Users provisioning endpoints", + "type": "object", + "properties": { + "schemas": { + "description": "SCIM schema used.", + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "example": "urn:ietf:params:scim:schemas:core:2.0:User" + } + }, + "id": { + "description": "Unique identifier of an external identity", + "example": "1b78eada-9baa-11e6-9eb6-a431576d590e", + "type": "string" + }, + "externalId": { + "description": "The ID of the User.", + "type": "string", + "example": "a7b0f98395", + "nullable": true + }, + "userName": { + "description": "Configured by the admin. Could be an email, login, or username", + "example": "someone@example.com", + "type": "string", + "nullable": true + }, + "displayName": { + "description": "The name of the user, suitable for display to end-users", + "example": "Jon Doe", + "type": "string", + "nullable": true + }, + "name": { + "type": "object", + "properties": { + "givenName": { "type": "string", "nullable": true }, + "familyName": { "type": "string", "nullable": true }, + "formatted": { "type": "string", "nullable": true } + }, + "required": ["givenName", "familyName"], + "example": { "givenName": "Jane", "familyName": "User" } + }, + "emails": { + "description": "user emails", + "example": [ + { "value": "someone@example.com", "primary": true }, + { "value": "another@example.com", "primary": false } + ], + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "value": { "type": "string" }, + "primary": { "type": "boolean" } + }, + "required": ["value"] + } + }, + "active": { + "description": "The active status of the User.", + "type": "boolean", + "example": true + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { "type": "string", "example": "User" }, + "created": { + "type": "string", + "format": "date-time", + "example": "2019-01-24T22:45:36.000Z" + }, + "lastModified": { + "type": "string", + "format": "date-time", + "example": "2019-01-24T22:45:36.000Z" + }, + "location": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/scim/v2/organizations/myorg-123abc55141bfd8f/Users/c42772b5-2029-11e9-8543-9264a97dec8d" + } + } + }, + "organization_id": { + "description": "The ID of the organization.", + "type": "integer" + }, + "operations": { + "description": "Set of operations to be performed", + "example": [{ "op": "replace", "value": { "active": false } }], + "type": "array", + "minItems": 1, + "items": { + "properties": { + "op": { + "type": "string", + "enum": ["add", "remove", "replace"] + }, + "path": { "type": "string" }, + "value": { + "oneOf": [ + { "type": "string" }, + { "type": "object" }, + { "type": "array", "items": {} } + ] + } + }, + "required": ["op"], + "type": "object" + } + }, + "groups": { + "description": "associated groups", + "type": "array", + "items": { + "properties": { + "value": { "type": "string" }, + "display": { "type": "string" } + } + } + } + }, + "required": [ + "id", + "schemas", + "externalId", + "userName", + "name", + "emails", + "active", + "meta" + ] + }, + "scim-user-list": { + "title": "SCIM User List", + "description": "SCIM User List", + "type": "object", + "properties": { + "schemas": { + "description": "SCIM schema used.", + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "example": "urn:ietf:params:scim:api:messages:2.0:ListResponse" + } + }, + "totalResults": { "type": "integer", "example": 3 }, + "itemsPerPage": { "type": "integer", "example": 10 }, + "startIndex": { "type": "integer", "example": 1 }, + "Resources": { + "type": "array", + "items": { "$ref": "#/components/schemas/scim-user" } + } + }, + "required": [ + "schemas", + "totalResults", + "itemsPerPage", + "startIndex", + "Resources" + ] + }, + "search-result-text-matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { "type": "string" }, + "object_type": { "nullable": true, "type": "string" }, + "property": { "type": "string" }, + "fragment": { "type": "string" }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { "type": "string" }, + "indices": { "type": "array", "items": { "type": "integer" } } + } + } + } + } + } + }, + "code-search-result-item": { + "title": "Code Search Result Item", + "description": "Code Search Result Item", + "type": "object", + "properties": { + "name": { "type": "string" }, + "path": { "type": "string" }, + "sha": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "git_url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" }, + "repository": { "$ref": "#/components/schemas/minimal-repository" }, + "score": { "type": "integer" }, + "file_size": { "type": "integer" }, + "language": { "type": "string", "nullable": true }, + "last_modified_at": { "type": "string", "format": "date-time" }, + "line_numbers": { + "type": "array", + "items": { "type": "string" }, + "example": ["73..77", "77..78"] + }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + } + }, + "required": [ + "score", + "name", + "path", + "sha", + "git_url", + "html_url", + "url", + "repository" + ] + }, + "commit-search-result-item": { + "title": "Commit Search Result Item", + "description": "Commit Search Result Item", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "sha": { "type": "string" }, + "html_url": { "type": "string", "format": "uri" }, + "comments_url": { "type": "string", "format": "uri" }, + "commit": { + "type": "object", + "properties": { + "author": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "email": { "type": "string" }, + "date": { "type": "string", "format": "date-time" } + }, + "required": ["name", "email", "date"] + }, + "committer": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/git-user" }] + }, + "comment_count": { "type": "integer" }, + "message": { "type": "string" }, + "tree": { + "type": "object", + "properties": { + "sha": { "type": "string" }, + "url": { "type": "string", "format": "uri" } + }, + "required": ["sha", "url"] + }, + "url": { "type": "string", "format": "uri" }, + "verification": { "$ref": "#/components/schemas/verification" } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "committer": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/git-user" }] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { "type": "string" }, + "html_url": { "type": "string" }, + "sha": { "type": "string" } + } + } + }, + "repository": { "$ref": "#/components/schemas/minimal-repository" }, + "score": { "type": "integer" }, + "node_id": { "type": "string" }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + } + }, + "required": [ + "sha", + "node_id", + "url", + "html_url", + "author", + "committer", + "parents", + "comments_url", + "commit", + "repository", + "score" + ] + }, + "issue-search-result-item": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "repository_url": { "type": "string", "format": "uri" }, + "labels_url": { "type": "string" }, + "comments_url": { "type": "string", "format": "uri" }, + "events_url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "number": { "type": "integer" }, + "title": { "type": "string" }, + "locked": { "type": "boolean" }, + "active_lock_reason": { "type": "string", "nullable": true }, + "assignees": { + "type": "array", + "items": { "$ref": "#/components/schemas/simple-user" }, + "nullable": true + }, + "user": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "url": { "type": "string" }, + "name": { "type": "string" }, + "color": { "type": "string" }, + "default": { "type": "boolean" }, + "description": { "type": "string", "nullable": true } + } + } + }, + "state": { "type": "string" }, + "assignee": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "milestone": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/milestone" }] + }, + "comments": { "type": "integer" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { "type": "string", "format": "uri", "nullable": true } + }, + "required": ["diff_url", "html_url", "patch_url", "url"] + }, + "body": { "type": "string" }, + "score": { "type": "integer" }, + "author_association": { "type": "string" }, + "draft": { "type": "boolean" }, + "repository": { "$ref": "#/components/schemas/repository" }, + "body_html": { "type": "string" }, + "body_text": { "type": "string" }, + "timeline_url": { "type": "string", "format": "uri" }, + "performed_via_github_app": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/integration" }] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + }, + "label-search-result-item": { + "title": "Label Search Result Item", + "description": "Label Search Result Item", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "url": { "type": "string", "format": "uri" }, + "name": { "type": "string" }, + "color": { "type": "string" }, + "default": { "type": "boolean" }, + "description": { "type": "string", "nullable": true }, + "score": { "type": "integer" }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description", + "score" + ] + }, + "repo-search-result-item": { + "title": "Repo Search Result Item", + "description": "Repo Search Result Item", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "name": { "type": "string" }, + "full_name": { "type": "string" }, + "owner": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/simple-user" }] + }, + "private": { "type": "boolean" }, + "html_url": { "type": "string", "format": "uri" }, + "description": { "type": "string", "nullable": true }, + "fork": { "type": "boolean" }, + "url": { "type": "string", "format": "uri" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" }, + "pushed_at": { "type": "string", "format": "date-time" }, + "homepage": { "type": "string", "format": "uri", "nullable": true }, + "size": { "type": "integer" }, + "stargazers_count": { "type": "integer" }, + "watchers_count": { "type": "integer" }, + "language": { "type": "string", "nullable": true }, + "forks_count": { "type": "integer" }, + "open_issues_count": { "type": "integer" }, + "master_branch": { "type": "string" }, + "default_branch": { "type": "string" }, + "score": { "type": "integer" }, + "forks_url": { "type": "string", "format": "uri" }, + "keys_url": { "type": "string" }, + "collaborators_url": { "type": "string" }, + "teams_url": { "type": "string", "format": "uri" }, + "hooks_url": { "type": "string", "format": "uri" }, + "issue_events_url": { "type": "string" }, + "events_url": { "type": "string", "format": "uri" }, + "assignees_url": { "type": "string" }, + "branches_url": { "type": "string" }, + "tags_url": { "type": "string", "format": "uri" }, + "blobs_url": { "type": "string" }, + "git_tags_url": { "type": "string" }, + "git_refs_url": { "type": "string" }, + "trees_url": { "type": "string" }, + "statuses_url": { "type": "string" }, + "languages_url": { "type": "string", "format": "uri" }, + "stargazers_url": { "type": "string", "format": "uri" }, + "contributors_url": { "type": "string", "format": "uri" }, + "subscribers_url": { "type": "string", "format": "uri" }, + "subscription_url": { "type": "string", "format": "uri" }, + "commits_url": { "type": "string" }, + "git_commits_url": { "type": "string" }, + "comments_url": { "type": "string" }, + "issue_comment_url": { "type": "string" }, + "contents_url": { "type": "string" }, + "compare_url": { "type": "string" }, + "merges_url": { "type": "string", "format": "uri" }, + "archive_url": { "type": "string" }, + "downloads_url": { "type": "string", "format": "uri" }, + "issues_url": { "type": "string" }, + "pulls_url": { "type": "string" }, + "milestones_url": { "type": "string" }, + "notifications_url": { "type": "string" }, + "labels_url": { "type": "string" }, + "releases_url": { "type": "string" }, + "deployments_url": { "type": "string", "format": "uri" }, + "git_url": { "type": "string" }, + "ssh_url": { "type": "string" }, + "clone_url": { "type": "string" }, + "svn_url": { "type": "string", "format": "uri" }, + "forks": { "type": "integer" }, + "open_issues": { "type": "integer" }, + "watchers": { "type": "integer" }, + "topics": { "type": "array", "items": { "type": "string" } }, + "mirror_url": { "type": "string", "format": "uri", "nullable": true }, + "has_issues": { "type": "boolean" }, + "has_projects": { "type": "boolean" }, + "has_pages": { "type": "boolean" }, + "has_wiki": { "type": "boolean" }, + "has_downloads": { "type": "boolean" }, + "archived": { "type": "boolean" }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "license": { + "nullable": true, + "allOf": [{ "$ref": "#/components/schemas/license-simple" }] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { "type": "boolean" }, + "pull": { "type": "boolean" }, + "push": { "type": "boolean" } + }, + "required": ["admin", "pull", "push"] + }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + }, + "temp_clone_token": { "type": "string" }, + "allow_merge_commit": { "type": "boolean" }, + "allow_squash_merge": { "type": "boolean" }, + "allow_rebase_merge": { "type": "boolean" }, + "delete_branch_on_merge": { "type": "boolean" } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at", + "score" + ] + }, + "topic-search-result-item": { + "title": "Topic Search Result Item", + "description": "Topic Search Result Item", + "type": "object", + "properties": { + "name": { "type": "string" }, + "display_name": { "type": "string", "nullable": true }, + "short_description": { "type": "string", "nullable": true }, + "description": { "type": "string", "nullable": true }, + "created_by": { "type": "string", "nullable": true }, + "released": { "type": "string", "nullable": true }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" }, + "featured": { "type": "boolean" }, + "curated": { "type": "boolean" }, + "score": { "type": "integer" }, + "repository_count": { "type": "integer", "nullable": true }, + "logo_url": { "type": "string", "format": "uri", "nullable": true }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + }, + "related": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "topic_relation": { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "name": { "type": "string" }, + "topic_id": { "type": "integer" }, + "relation_type": { "type": "string" } + } + } + } + } + }, + "aliases": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "topic_relation": { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "name": { "type": "string" }, + "topic_id": { "type": "integer" }, + "relation_type": { "type": "string" } + } + } + } + } + } + }, + "required": [ + "name", + "display_name", + "short_description", + "description", + "created_by", + "released", + "created_at", + "updated_at", + "featured", + "curated", + "score" + ] + }, + "user-search-result-item": { + "title": "User Search Result Item", + "description": "User Search Result Item", + "type": "object", + "properties": { + "login": { "type": "string" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "avatar_url": { "type": "string", "format": "uri" }, + "gravatar_id": { "type": "string", "nullable": true }, + "url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" }, + "followers_url": { "type": "string", "format": "uri" }, + "subscriptions_url": { "type": "string", "format": "uri" }, + "organizations_url": { "type": "string", "format": "uri" }, + "repos_url": { "type": "string", "format": "uri" }, + "received_events_url": { "type": "string", "format": "uri" }, + "type": { "type": "string" }, + "score": { "type": "integer" }, + "following_url": { "type": "string" }, + "gists_url": { "type": "string" }, + "starred_url": { "type": "string" }, + "events_url": { "type": "string" }, + "public_repos": { "type": "integer" }, + "public_gists": { "type": "integer" }, + "followers": { "type": "integer" }, + "following": { "type": "integer" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" }, + "name": { "type": "string", "nullable": true }, + "bio": { "type": "string", "nullable": true }, + "email": { "type": "string", "format": "email", "nullable": true }, + "location": { "type": "string", "nullable": true }, + "site_admin": { "type": "boolean" }, + "hireable": { "type": "boolean", "nullable": true }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + }, + "blog": { "type": "string", "nullable": true }, + "company": { "type": "string", "nullable": true }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "score" + ] + }, + "private-user": { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "login": { "type": "string", "example": "octocat" }, + "id": { "type": "integer", "example": 1 }, + "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { "type": "string", "example": "User" }, + "site_admin": { "type": "boolean" }, + "name": { + "type": "string", + "example": "monalisa octocat", + "nullable": true + }, + "company": { + "type": "string", + "example": "GitHub", + "nullable": true + }, + "blog": { + "type": "string", + "example": "https://github.com/blog", + "nullable": true + }, + "location": { + "type": "string", + "example": "San Francisco", + "nullable": true + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com", + "nullable": true + }, + "hireable": { "type": "boolean", "nullable": true }, + "bio": { + "type": "string", + "example": "There once was...", + "nullable": true + }, + "twitter_username": { + "type": "string", + "example": "monalisa", + "nullable": true + }, + "public_repos": { "type": "integer", "example": 2 }, + "public_gists": { "type": "integer", "example": 1 }, + "followers": { "type": "integer", "example": 20 }, + "following": { "type": "integer", "example": 0 }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "private_gists": { "type": "integer", "example": 81 }, + "total_private_repos": { "type": "integer", "example": 100 }, + "owned_private_repos": { "type": "integer", "example": 100 }, + "disk_usage": { "type": "integer", "example": 10000 }, + "collaborators": { "type": "integer", "example": 8 }, + "two_factor_authentication": { "type": "boolean", "example": true }, + "plan": { + "type": "object", + "properties": { + "collaborators": { "type": "integer" }, + "name": { "type": "string" }, + "space": { "type": "integer" }, + "private_repos": { "type": "integer" } + }, + "required": ["collaborators", "name", "space", "private_repos"] + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "business_plus": { "type": "boolean" }, + "ldap_dn": { "type": "string" } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + "public-user": { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { "type": "string" }, + "id": { "type": "integer" }, + "node_id": { "type": "string" }, + "avatar_url": { "type": "string", "format": "uri" }, + "gravatar_id": { "type": "string", "nullable": true }, + "url": { "type": "string", "format": "uri" }, + "html_url": { "type": "string", "format": "uri" }, + "followers_url": { "type": "string", "format": "uri" }, + "following_url": { "type": "string" }, + "gists_url": { "type": "string" }, + "starred_url": { "type": "string" }, + "subscriptions_url": { "type": "string", "format": "uri" }, + "organizations_url": { "type": "string", "format": "uri" }, + "repos_url": { "type": "string", "format": "uri" }, + "events_url": { "type": "string" }, + "received_events_url": { "type": "string", "format": "uri" }, + "type": { "type": "string" }, + "site_admin": { "type": "boolean" }, + "name": { "type": "string", "nullable": true }, + "company": { "type": "string", "nullable": true }, + "blog": { "type": "string", "nullable": true }, + "location": { "type": "string", "nullable": true }, + "email": { "type": "string", "format": "email", "nullable": true }, + "hireable": { "type": "boolean", "nullable": true }, + "bio": { "type": "string", "nullable": true }, + "twitter_username": { "type": "string", "nullable": true }, + "public_repos": { "type": "integer" }, + "public_gists": { "type": "integer" }, + "followers": { "type": "integer" }, + "following": { "type": "integer" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" }, + "plan": { + "type": "object", + "properties": { + "collaborators": { "type": "integer" }, + "name": { "type": "string" }, + "space": { "type": "integer" }, + "private_repos": { "type": "integer" } + }, + "required": ["collaborators", "name", "space", "private_repos"] + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "private_gists": { "type": "integer", "example": 1 }, + "total_private_repos": { "type": "integer", "example": 2 }, + "owned_private_repos": { "type": "integer", "example": 2 }, + "disk_usage": { "type": "integer", "example": 1 }, + "collaborators": { "type": "integer", "example": 3 } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + }, + "email": { + "title": "Email", + "description": "Email", + "oneOf": [ + { + "type": "object", + "properties": { + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "primary": { "type": "boolean", "example": true }, + "verified": { "type": "boolean", "example": true }, + "visibility": { + "type": "string", + "example": "public", + "nullable": true + } + }, + "required": ["email", "primary", "verified", "visibility"] + }, + { "type": "string" } + ] + }, + "gpg-key": { + "title": "GPG Key", + "description": "A unique encryption key", + "type": "object", + "properties": { + "id": { "type": "integer", "example": 3 }, + "primary_key_id": { "type": "integer", "nullable": true }, + "key_id": { "type": "string", "example": "3262EFF25BA0D270" }, + "public_key": { "type": "string", "example": "xsBNBFayYZ..." }, + "emails": { + "type": "array", + "example": [ + { + "email": "mastahyeti@users.noreply.github.com", + "verified": true + } + ], + "items": { + "type": "object", + "properties": { + "email": { "type": "string" }, + "verified": { "type": "boolean" } + } + } + }, + "subkeys": { + "type": "array", + "example": [ + { + "id": 4, + "primary_key_id": 3, + "key_id": "4A595D4C72EE49C7", + "public_key": "zsBNBFayYZ...", + "emails": [], + "subkeys": [], + "can_sign": false, + "can_encrypt_comms": true, + "can_encrypt_storage": true, + "can_certify": false, + "created_at": "2016-03-24T11:31:04-06:00", + "expires_at": null + } + ], + "items": { + "type": "object", + "properties": { + "id": { "type": "integer" }, + "primary_key_id": { "type": "integer" }, + "key_id": { "type": "string" }, + "public_key": { "type": "string" }, + "emails": { "type": "array", "items": {} }, + "subkeys": { "type": "array", "items": {} }, + "can_sign": { "type": "boolean" }, + "can_encrypt_comms": { "type": "boolean" }, + "can_encrypt_storage": { "type": "boolean" }, + "can_certify": { "type": "boolean" }, + "created_at": { "type": "string" }, + "expires_at": { "type": "string", "nullable": true }, + "raw_key": { "type": "string", "nullable": true } + } + } + }, + "can_sign": { "type": "boolean", "example": true }, + "can_encrypt_comms": { "type": "boolean" }, + "can_encrypt_storage": { "type": "boolean" }, + "can_certify": { "type": "boolean", "example": true }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-03-24T11:31:04-06:00" + }, + "expires_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "raw_key": { "type": "string", "nullable": true } + }, + "required": [ + "id", + "primary_key_id", + "key_id", + "raw_key", + "public_key", + "created_at", + "expires_at", + "can_sign", + "can_encrypt_comms", + "can_encrypt_storage", + "can_certify", + "emails", + "subkeys" + ] + }, + "key": { + "title": "Key", + "description": "Key", + "type": "object", + "properties": { + "key_id": { "type": "string" }, + "key": { "type": "string" }, + "id": { "type": "integer" }, + "url": { "type": "string" }, + "title": { "type": "string" }, + "created_at": { "type": "string", "format": "date-time" }, + "verified": { "type": "boolean" }, + "read_only": { "type": "boolean" } + }, + "required": [ + "key_id", + "key", + "id", + "url", + "title", + "created_at", + "verified", + "read_only" + ] + }, + "marketplace-account": { + "title": "Marketplace Account", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri" }, + "id": { "type": "integer" }, + "type": { "type": "string" }, + "node_id": { "type": "string" }, + "login": { "type": "string" }, + "email": { "type": "string", "nullable": true, "format": "email" }, + "organization_billing_email": { + "type": "string", + "nullable": true, + "format": "email" + } + }, + "required": ["url", "id", "type", "login"] + }, + "user-marketplace-purchase": { + "title": "User Marketplace Purchase", + "description": "User Marketplace Purchase", + "type": "object", + "properties": { + "billing_cycle": { "type": "string", "example": "monthly" }, + "next_billing_date": { + "type": "string", + "format": "date-time", + "example": "2017-11-11T00:00:00Z", + "nullable": true + }, + "unit_count": { "type": "integer", "nullable": true }, + "on_free_trial": { "type": "boolean", "example": true }, + "free_trial_ends_on": { + "type": "string", + "format": "date-time", + "example": "2017-11-11T00:00:00Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-11-02T01:12:12Z", + "nullable": true + }, + "account": { "$ref": "#/components/schemas/marketplace-account" }, + "plan": { "$ref": "#/components/schemas/marketplace-listing-plan" } + }, + "required": [ + "billing_cycle", + "next_billing_date", + "unit_count", + "updated_at", + "on_free_trial", + "free_trial_ends_on", + "account", + "plan" + ] + }, + "starred-repository": { + "title": "Starred Repository", + "description": "Starred Repository", + "type": "object", + "properties": { + "starred_at": { "type": "string", "format": "date-time" }, + "repo": { "$ref": "#/components/schemas/repository" } + }, + "required": ["starred_at", "repo"] + }, + "hovercard": { + "title": "Hovercard", + "description": "Hovercard", + "type": "object", + "properties": { + "contexts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { "type": "string" }, + "octicon": { "type": "string" } + }, + "required": ["message", "octicon"] + } + } + }, + "required": ["contexts"] + }, + "key-simple": { + "title": "Key Simple", + "description": "Key Simple", + "type": "object", + "properties": { + "id": { "type": "integer" }, + "key": { "type": "string" } + }, + "required": ["key", "id"] + } + }, + "examples": { + "integration": { + "value": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": ["push", "pull_request"] + } + }, + "integration-from-manifest": { + "value": { + "id": 1, + "slug": "octoapp", + "node_id": "MDxOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": ["push", "pull_request"], + "client_id": "Iv1.8a61f9b3a7aba766", + "client_secret": "1726be1638095a19edd134c77bde3aa2ece1e5d8", + "webhook_secret": "e340154128314309424b7c8e90325147d99fdafa", + "pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\n-----END RSA PRIVATE KEY-----\n" + } + }, + "webhook-config": { + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } + }, + "base-installation-items": { + "value": [ + { + "id": 1, + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": ["push", "pull_request"], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": ["config.yml", ".github/issue_TEMPLATE.md"], + "repository_selection": "selected", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions" + } + ] + }, + "base-installation": { + "value": { + "id": 1, + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": ["push", "pull_request"], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": ["config.yml", ".github/issue_TEMPLATE.md"], + "repository_selection": "selected", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions" + } + }, + "installation-token": { + "value": { + "token": "v1.1f699f1069f60xxx", + "expires_at": "2016-07-11T22:14:10Z", + "permissions": { "issues": "write", "contents": "read" }, + "repository_selection": "selected", + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + } + }, + "application-grant-items": { + "value": [ + { + "id": 1, + "url": "https://api.github.com/applications/grants/1", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "abcde12345fghij67890" + }, + "created_at": "2011-09-06T17:26:27Z", + "updated_at": "2011-09-06T20:39:23Z", + "scopes": ["public_repo"] + } + ] + }, + "application-grant": { + "value": { + "id": 1, + "url": "https://api.github.com/applications/grants/1", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "abcde12345fghij67890" + }, + "created_at": "2011-09-06T17:26:27Z", + "updated_at": "2011-09-06T20:39:23Z", + "scopes": ["public_repo"] + } + }, + "authorization-with-user": { + "value": { + "id": 1, + "url": "https://api.github.com/authorizations/1", + "scopes": ["public_repo", "user"], + "token": "abcdefgh12345678", + "token_last_eight": "12345678", + "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "abcde12345fghij67890" + }, + "note": "optional note", + "note_url": "http://optional/note/url", + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "fingerprint": "jklmnop12345678", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "scope-token": { + "value": { + "id": 1, + "url": "https://api.github.com/authorizations/1", + "scopes": ["public_repo"], + "token": "abcdefgh12345678", + "token_last_eight": "12345678", + "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "abcde12345fghij67890" + }, + "note": "optional note", + "note_url": "http://optional/note/url", + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "fingerprint": "jklmnop12345678", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "installation": { + "permissions": { + "metadata": "read", + "issues": "write", + "contents": "read" + }, + "repository_selection": "selected", + "single_file_name": ".github/workflow.yml", + "repositories_url": "https://api.github.com/user/repos", + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "has_multiple_single_files": false, + "single_file_paths": [] + } + } + }, + "authorization-items": { + "value": [ + { + "id": 1, + "url": "https://api.github.com/authorizations/1", + "scopes": ["public_repo"], + "token": "", + "token_last_eight": "12345678", + "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "abcde12345fghij67890" + }, + "note": "optional note", + "note_url": "http://optional/note/url", + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "fingerprint": "jklmnop12345678" + } + ] + }, + "authorization": { + "value": { + "id": 1, + "url": "https://api.github.com/authorizations/1", + "scopes": ["public_repo"], + "token": "abcdefgh12345678", + "token_last_eight": "12345678", + "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "abcde12345fghij67890" + }, + "note": "optional note", + "note_url": "http://optional/note/url", + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "fingerprint": "" + } + }, + "authorization-response-if-returning-an-existing-token-2": { + "value": { + "id": 1, + "url": "https://api.github.com/authorizations/1", + "scopes": ["public_repo"], + "token": "", + "token_last_eight": "12345678", + "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "abcde12345fghij67890" + }, + "note": "optional note", + "note_url": "http://optional/note/url", + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "fingerprint": "" + } + }, + "authorization-response-if-returning-an-existing-token": { + "value": { + "id": 1, + "url": "https://api.github.com/authorizations/1", + "scopes": ["public_repo"], + "token": "", + "token_last_eight": "12345678", + "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "abcde12345fghij67890" + }, + "note": "optional note", + "note_url": "http://optional/note/url", + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "fingerprint": "jklmnop12345678" + } + }, + "authorization-3": { + "value": { + "id": 1, + "url": "https://api.github.com/authorizations/1", + "scopes": ["public_repo"], + "token": "abcdefgh12345678", + "token_last_eight": "12345678", + "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "abcde12345fghij67890" + }, + "note": "optional note", + "note_url": "http://optional/note/url", + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "fingerprint": "jklmnop12345678" + } + }, + "authorization-2": { + "value": { + "id": 1, + "url": "https://api.github.com/authorizations/1", + "scopes": ["public_repo"], + "token": "", + "token_last_eight": "12345678", + "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "abcde12345fghij67890" + }, + "note": "optional note", + "note_url": "http://optional/note/url", + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "fingerprint": "jklmnop12345678" + } + }, + "code-of-conduct-simple-items": { + "value": [ + { + "key": "citizen_code_of_conduct", + "name": "Citizen Code of Conduct", + "url": "https://api.github.com/codes_of_conduct/citizen_code_of_conduct", + "html_url": "http://citizencodeofconduct.org/" + }, + { + "key": "contributor_covenant", + "name": "Contributor Covenant", + "url": "https://api.github.com/codes_of_conduct/contributor_covenant", + "html_url": "https://www.contributor-covenant.org/version/2/0/code_of_conduct/" + } + ] + }, + "code-of-conduct": { + "value": { + "key": "contributor_covenant", + "name": "Contributor Covenant", + "url": "https://api.github.com/codes_of_conduct/contributor_covenant", + "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n", + "html_url": "http://contributor-covenant.org/version/1/4/" + } + }, + "content-reference-attachment": { + "value": { + "id": 101, + "title": "[A-1234] Error found in core/models.py file'", + "body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=(Octocat@github.com) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()" + } + }, + "actions-enterprise-permissions": { + "value": { + "enabled_organizations": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/enterprises/2/actions/permissions/selected-actions" + } + }, + "organization-targets": { + "value": { + "total_count": 1, + "organizations": [ + { + "login": "octocat", + "id": 161335, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + } + }, + "selected-actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": ["monalisa/octocat@*", "docker/*"] + } + }, + "runner-groups-enterprise": { + "value": { + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners", + "allows_public_repositories": false + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners", + "allows_public_repositories": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners", + "allows_public_repositories": true + } + ] + } + }, + "runner-group-enterprise": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "allows_public_repositories": false + } + }, + "runner-group-update-enterprise": { + "value": { + "id": 2, + "name": "Expensive hardware runners", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "allows_public_repositories": true + } + }, + "runner-paginated": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "labels": [ + { "id": 5, "name": "self-hosted", "type": "read-only" }, + { "id": 7, "name": "X64", "type": "read-only" }, + { "id": 11, "name": "Linux", "type": "read-only" } + ] + }, + { + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "labels": [ + { "id": 5, "name": "self-hosted", "type": "read-only" }, + { "id": 7, "name": "X64", "type": "read-only" }, + { "id": 20, "name": "macOS", "type": "read-only" }, + { "id": 21, "name": "no-gpu", "type": "custom" } + ] + } + ] + } + }, + "runner-application-items": { + "value": [ + { + "os": "osx", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", + "filename": "actions-runner-osx-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", + "filename": "actions-runner-linux-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "arm", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm-2.164.0.tar.gz" + }, + { + "os": "win", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", + "filename": "actions-runner-win-x64-2.164.0.zip" + }, + { + "os": "linux", + "architecture": "arm64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" + } + ] + }, + "authentication-token": { + "value": { + "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-22T12:13:35.123-08:00" + } + }, + "authentication-token-2": { + "value": { + "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-29T12:13:35.123-08:00" + } + }, + "runner": { + "value": { + "id": 23, + "name": "MBP", + "os": "macos", + "status": "online", + "busy": true, + "labels": [ + { "id": 5, "name": "self-hosted", "type": "read-only" }, + { "id": 7, "name": "X64", "type": "read-only" }, + { "id": 20, "name": "macOS", "type": "read-only" }, + { "id": 21, "name": "no-gpu", "type": "custom" } + ] + } + }, + "audit-log": { + "value": [ + { + "@timestamp": 1606929874512, + "action": "team.add_member", + "actor": "octocat", + "created_at": 1606929874512, + "org": "octo-corp", + "team": "octo-corp/example-team", + "user": "monalisa" + }, + { + "@timestamp": 1606507117008, + "action": "org.create", + "actor": "octocat", + "created_at": 1606507117008, + "org": "octocat-test-org" + }, + { + "@timestamp": 1605719148837, + "action": "repo.destroy", + "actor": "monalisa", + "created_at": 1605719148837, + "org": "mona-org", + "repo": "mona-org/mona-test-repo", + "visibility": "private" + } + ] + }, + "actions-billing-usage": { + "value": { + "total_minutes_used": 305, + "total_paid_minutes_used": 0, + "included_minutes": 3000, + "minutes_used_breakdown": { + "UBUNTU": 205, + "MACOS": 10, + "WINDOWS": 90 + } + } + }, + "packages-billing-usage": { + "value": { + "total_gigabytes_bandwidth_used": 50, + "total_paid_gigabytes_bandwidth_used": 40, + "included_gigabytes_bandwidth": 10 + } + }, + "combined-billing-usage": { + "value": { + "days_left_in_billing_cycle": 20, + "estimated_paid_storage_for_month": 15, + "estimated_storage_for_month": 40 + } + }, + "feed": { + "value": { + "timeline_url": "https://github.com/timeline", + "user_url": "https://github.com/{user}", + "current_user_public_url": "https://github.com/octocat", + "current_user_url": "https://github.com/octocat.private?token=abc123", + "current_user_actor_url": "https://github.com/octocat.private.actor?token=abc123", + "current_user_organization_url": "", + "current_user_organization_urls": [ + "https://github.com/organizations/github/octocat.private.atom?token=abc123" + ], + "security_advisories_url": "https://github.com/security-advisories", + "_links": { + "timeline": { + "href": "https://github.com/timeline", + "type": "application/atom+xml" + }, + "user": { + "href": "https://github.com/{user}", + "type": "application/atom+xml" + }, + "current_user_public": { + "href": "https://github.com/octocat", + "type": "application/atom+xml" + }, + "current_user": { + "href": "https://github.com/octocat.private?token=abc123", + "type": "application/atom+xml" + }, + "current_user_actor": { + "href": "https://github.com/octocat.private.actor?token=abc123", + "type": "application/atom+xml" + }, + "current_user_organization": { "href": "", "type": "" }, + "current_user_organizations": [ + { + "href": "https://github.com/organizations/github/octocat.private.atom?token=abc123", + "type": "application/atom+xml" + } + ], + "security_advisories": { + "href": "https://github.com/security-advisories", + "type": "application/atom+xml" + } + } + } + }, + "base-gist-items": { + "value": [ + { + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 0, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "truncated": false + } + ] + }, + "gist": { + "value": { + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 0, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/" + } + }, + "gist-comment-items": { + "value": [ + { + "id": 1, + "node_id": "MDExOkdpc3RDb21tZW50MQ==", + "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", + "body": "Just commenting for the sake of commenting", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-18T23:23:56Z", + "updated_at": "2011-04-18T23:23:56Z", + "author_association": "collaborator" + } + ] + }, + "gist-comment": { + "value": { + "id": 1, + "node_id": "MDExOkdpc3RDb21tZW50MQ==", + "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", + "body": "Just commenting for the sake of commenting", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-18T23:23:56Z", + "updated_at": "2011-04-18T23:23:56Z", + "author_association": "collaborator" + } + }, + "gist-commit-items": { + "value": [ + { + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f", + "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "change_status": { "deletions": 0, "additions": 180, "total": 180 }, + "committed_at": "2010-04-14T02:15:15Z" + } + ] + }, + "gist-fork-items": { + "value": [ + { + "url": "https://api.github.com/gists/dee9c42e4998ce2ea439", + "id": "dee9c42e4998ce2ea439", + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z" + } + ] + }, + "base-gist": { + "value": { + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 0, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "truncated": false + } + }, + "gitignore-template": { + "value": { + "name": "C", + "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" + } + }, + "repository-paginated-2": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + } + }, + "issue-with-repo-items": { + "value": [ + { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "author_association": "collaborator" + } + ] + }, + "license-simple-items": { + "value": [ + { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + { + "key": "lgpl-3.0", + "name": "GNU Lesser General Public License v3.0", + "spdx_id": "LGPL-3.0", + "url": "https://api.github.com/licenses/lgpl-3.0", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + { + "key": "mpl-2.0", + "name": "Mozilla Public License 2.0", + "spdx_id": "MPL-2.0", + "url": "https://api.github.com/licenses/mpl-2.0", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + { + "key": "agpl-3.0", + "name": "GNU Affero General Public License v3.0", + "spdx_id": "AGPL-3.0", + "url": "https://api.github.com/licenses/agpl-3.0", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + { + "key": "unlicense", + "name": "The Unlicense", + "spdx_id": "Unlicense", + "url": "https://api.github.com/licenses/unlicense", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + { + "key": "apache-2.0", + "name": "Apache License 2.0", + "spdx_id": "Apache-2.0", + "url": "https://api.github.com/licenses/apache-2.0", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + { + "key": "gpl-3.0", + "name": "GNU General Public License v3.0", + "spdx_id": "GPL-3.0", + "url": "https://api.github.com/licenses/gpl-3.0", + "node_id": "MDc6TGljZW5zZW1pdA==" + } + ] + }, + "license": { + "value": { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "http://choosealicense.com/licenses/mit/", + "description": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.", + "implementation": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.", + "permissions": [ + "commercial-use", + "modifications", + "distribution", + "sublicense", + "private-use" + ], + "conditions": ["include-copyright"], + "limitations": ["no-liability"], + "body": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n", + "featured": true + } + }, + "marketplace-purchase": { + "value": { + "url": "https://api.github.com/orgs/github", + "type": "Organization", + "id": 4, + "login": "github", + "organization_billing_email": "billing@github.com", + "marketplace_pending_change": { + "effective_date": "2017-11-11T00:00:00Z", + "unit_count": null, + "id": 77, + "plan": { + "url": "https://api.github.com/marketplace_listing/plans/1111", + "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts", + "id": 1111, + "number": 2, + "name": "Startup", + "description": "A professional-grade CI solution", + "monthly_price_in_cents": 699, + "yearly_price_in_cents": 7870, + "price_model": "flat-rate", + "has_free_trial": true, + "state": "published", + "unit_name": null, + "bullets": [ + "Up to 10 private repositories", + "3 concurrent builds" + ] + } + }, + "marketplace_purchase": { + "billing_cycle": "monthly", + "next_billing_date": "2017-11-11T00:00:00Z", + "unit_count": null, + "on_free_trial": true, + "free_trial_ends_on": "2017-11-11T00:00:00Z", + "updated_at": "2017-11-02T01:12:12Z", + "plan": { + "url": "https://api.github.com/marketplace_listing/plans/1313", + "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", + "id": 1313, + "number": 3, + "name": "Pro", + "description": "A professional-grade CI solution", + "monthly_price_in_cents": 1099, + "yearly_price_in_cents": 11870, + "price_model": "flat-rate", + "has_free_trial": true, + "unit_name": null, + "state": "published", + "bullets": [ + "Up to 25 private repositories", + "11 concurrent builds" + ] + } + } + } + }, + "marketplace-listing-plan-items": { + "value": [ + { + "url": "https://api.github.com/marketplace_listing/plans/1313", + "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", + "id": 1313, + "number": 3, + "name": "Pro", + "description": "A professional-grade CI solution", + "monthly_price_in_cents": 1099, + "yearly_price_in_cents": 11870, + "price_model": "flat-rate", + "has_free_trial": true, + "unit_name": null, + "state": "published", + "bullets": ["Up to 25 private repositories", "11 concurrent builds"] + } + ] + }, + "marketplace-purchase-items": { + "value": [ + { + "url": "https://api.github.com/orgs/github", + "type": "Organization", + "id": 4, + "login": "github", + "organization_billing_email": "billing@github.com", + "marketplace_pending_change": { + "effective_date": "2017-11-11T00:00:00Z", + "unit_count": null, + "id": 77, + "plan": { + "url": "https://api.github.com/marketplace_listing/plans/1111", + "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts", + "id": 1111, + "number": 2, + "name": "Startup", + "description": "A professional-grade CI solution", + "monthly_price_in_cents": 699, + "yearly_price_in_cents": 7870, + "price_model": "flat-rate", + "has_free_trial": true, + "state": "published", + "unit_name": null, + "bullets": [ + "Up to 10 private repositories", + "3 concurrent builds" + ] + } + }, + "marketplace_purchase": { + "billing_cycle": "monthly", + "next_billing_date": "2017-11-11T00:00:00Z", + "unit_count": null, + "on_free_trial": true, + "free_trial_ends_on": "2017-11-11T00:00:00Z", + "updated_at": "2017-11-02T01:12:12Z", + "plan": { + "url": "https://api.github.com/marketplace_listing/plans/1313", + "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", + "id": 1313, + "number": 3, + "name": "Pro", + "description": "A professional-grade CI solution", + "monthly_price_in_cents": 1099, + "yearly_price_in_cents": 11870, + "price_model": "flat-rate", + "has_free_trial": true, + "unit_name": null, + "state": "published", + "bullets": [ + "Up to 25 private repositories", + "11 concurrent builds" + ] + } + } + } + ] + }, + "api-overview": { + "value": { + "verifiable_password_authentication": true, + "ssh_key_fingerprints": { + "SHA256_RSA": "nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8", + "SHA256_DSA": "br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ" + }, + "hooks": ["192.30.252.0/22"], + "web": ["192.30.252.0/22", "185.199.108.0/22"], + "api": ["192.30.252.0/22", "185.199.108.0/22"], + "git": ["192.30.252.0/22"], + "pages": ["192.30.252.153/32", "192.30.252.154/32"], + "importer": ["54.158.161.132", "54.226.70.38"], + "actions": ["13.64.0.0/16", "13.65.0.0/16"] + } + }, + "thread-items": { + "value": [ + { + "id": "1", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "subject": { + "title": "Greetings", + "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123", + "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123", + "type": "Issue" + }, + "reason": "subscribed", + "unread": true, + "updated_at": "2014-11-07T22:01:45Z", + "last_read_at": "2014-11-07T22:01:45Z", + "url": "https://api.github.com/notifications/threads/1", + "subscription_url": "https://api.github.com/notifications/threads/1/subscription" + } + ] + }, + "thread": { + "value": { + "id": "1", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "subject": { + "title": "Greetings", + "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123", + "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123", + "type": "Issue" + }, + "reason": "subscribed", + "unread": true, + "updated_at": "2014-11-07T22:01:45Z", + "last_read_at": "2014-11-07T22:01:45Z", + "url": "https://api.github.com/notifications/threads/1", + "subscription_url": "https://api.github.com/notifications/threads/1/subscription" + } + }, + "thread-subscription": { + "value": { + "subscribed": true, + "ignored": false, + "reason": null, + "created_at": "2012-10-06T21:34:12Z", + "url": "https://api.github.com/notifications/threads/1/subscription", + "thread_url": "https://api.github.com/notifications/threads/1" + } + }, + "organization-simple-items": { + "value": [ + { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + }, + "organization-full-default-response": { + "summary": "Default response", + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2014-03-03T18:58:10Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { "name": "Medium", "space": 400, "private_repos": 20 }, + "default_repository_permission": "read", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true + } + }, + "organization-full-response-with-git-hub-plan-information": { + "summary": "Response with GitHub plan information", + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2014-03-03T18:58:10Z", + "type": "Organization", + "plan": { + "name": "team", + "space": 976562499, + "private_repos": 999999, + "filled_seats": 4, + "seats": 5 + } + } + }, + "organization-full": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { "name": "Medium", "space": 400, "private_repos": 20 }, + "default_repository_permission": "read", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "updated_at": "2014-03-03T18:58:10Z" + } + }, + "actions-organization-permissions": { + "value": { + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + } + }, + "repository-paginated": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + } + }, + "runner-groups-org": { + "value": { + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", + "inherited": false, + "allows_public_repositories": true + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": true, + "allows_public_repositories": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", + "inherited": false, + "allows_public_repositories": true + } + ] + } + }, + "runner-group": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": false, + "allows_public_repositories": true + } + }, + "runner-group-item": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": false, + "allows_public_repositories": true + } + }, + "organization-actions-secret-paginated": { + "value": { + "total_count": 3, + "secrets": [ + { + "name": "GIST_ID", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "DEPLOY_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + } + ] + } + }, + "actions-public-key": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + }, + "organization-actions-secret": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + } + }, + "public-repository-paginated": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + }, + "simple-user-items": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + }, + "credential-authorization-items": { + "value": [ + { + "login": "octocat", + "credential_id": 161195, + "credential_type": "personal access token", + "token_last_eight": "71c3fc11", + "credential_authorized_at": "2011-01-26T19:06:43Z", + "scopes": ["user", "repo"] + }, + { + "login": "hubot", + "credential_id": 161196, + "credential_type": "personal access token", + "token_last_eight": "12345678", + "credential_authorized_at": "2019-03-29T19:06:43Z", + "scopes": ["repo"] + } + ] + }, + "org-hook-items": { + "value": [ + { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "name": "web", + "events": ["push", "pull_request"], + "active": true, + "config": { "url": "http://example.com", "content_type": "json" }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + ] + }, + "org-hook": { + "value": { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "name": "web", + "events": ["push", "pull_request"], + "active": true, + "config": { "url": "http://example.com", "content_type": "json" }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + }, + "org-hook-2": { + "value": { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "name": "web", + "events": ["pull_request"], + "active": true, + "config": { "url": "http://example.com", "content_type": "json" }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + }, + "installation": { + "value": { + "id": 1, + "account": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/orgs/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "repository_selection": "all", + "access_tokens_url": "https://api.github.com/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": ["push", "pull_request"], + "created_at": "2018-02-09T20:51:14Z", + "updated_at": "2018-02-09T20:51:14Z", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": ["config.yml", ".github/issue_TEMPLATE.md"], + "app_slug": "github-actions" + } + }, + "installation-paginated": { + "value": { + "total_count": 1, + "installations": [ + { + "id": 25381, + "account": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "repository_selection": "selected", + "access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/octo-org/settings/installations/25381", + "app_id": 2218, + "target_id": 6811672, + "target_type": "Organization", + "permissions": { + "deployments": "write", + "metadata": "read", + "pull_requests": "read", + "statuses": "read" + }, + "events": ["deployment", "deployment_status"], + "created_at": "2017-05-16T08:47:09.000-07:00", + "updated_at": "2017-06-06T11:23:23.000-07:00", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": ["config.yml", ".github/issue_TEMPLATE.md"], + "app_slug": "github-actions" + } + ] + } + }, + "interaction-limit-response": { + "value": { + "limit": "collaborators_only", + "origin": "organization", + "expires_at": "2018-08-17T04:18:39Z" + } + }, + "organization-invitation-items": { + "value": [ + { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + }, + "team_count": 2, + "invitation_team_url": "https://api.github.com/organizations/2/invitations/1/teams" + } + ] + }, + "organization-invitation": { + "value": { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + }, + "team_count": 2, + "invitation_team_url": "https://api.github.com/organizations/2/invitations/1/teams" + } + }, + "team-items": { + "value": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ] + }, + "org-membership-response-if-user-has-an-active-admin-membership-with-organization": { + "summary": "Response if user has an active admin membership with organization", + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "org-membership-response-if-user-has-an-active-membership-with-organization": { + "summary": "Response if user has an active membership with organization", + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "member", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "org-membership-response-if-user-has-a-pending-membership-with-organization": { + "summary": "Response if user has a pending membership with organization", + "value": { + "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", + "state": "pending", + "role": "member", + "organization_url": "https://api.github.com/orgs/invitocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "org-membership-response-if-user-was-previously-unaffiliated-with-organization": { + "summary": "Response if user was previously unaffiliated with organization", + "value": { + "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", + "state": "pending", + "role": "admin", + "organization_url": "https://api.github.com/orgs/invitocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "org-membership-response-if-user-already-had-membership-with-organization": { + "summary": "Response if user already had membership with organization", + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "migration-with-short-org-items": { + "value": [ + { + "id": 79, + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00", + "node_id": "MDQ6VXNlcjE=" + } + ] + }, + "migration-with-short-org-2": { + "value": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + } + }, + "migration-with-short-org": { + "value": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "exported", + "lock_repositories": true, + "exclude_attachments": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + } + }, + "minimal-repository-items": { + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + } + } + ] + }, + "project-items": { + "value": [ + { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z" + } + ] + }, + "project-2": { + "value": { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z" + } + }, + "repository": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + } + }, + "group-mapping-3": { + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "group_description": "The people who configure your octoworld." + }, + { + "group_id": "456", + "group_name": "Octocat docs members", + "group_description": "The people who make your octoworld come to life." + } + ] + } + }, + "team-full": { + "value": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + }, + "team-discussion-items": { + "value": [ + { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

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

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 0, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": null, + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Our first team post", + "updated_at": "2018-01-25T18:56:31Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } + } + ] + }, + "team-discussion": { + "value": { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

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

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 0, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": null, + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Our first team post", + "updated_at": "2018-01-25T18:56:31Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } + } + }, + "team-discussion-2": { + "value": { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

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

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 1, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": "2018-01-26T18:22:20Z", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Welcome to our first team post", + "updated_at": "2018-01-26T18:22:20Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } + } + }, + "team-discussion-comment-items": { + "value": [ + { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } + } + ] + }, + "team-discussion-comment": { + "value": { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } + } + }, + "team-discussion-comment-2": { + "value": { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like pineapples?", + "body_html": "

Do you like pineapples?

", + "body_version": "e6907b24d9c93cc0c5024a7af5888116", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": "2018-01-26T18:22:20Z", + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-26T18:22:20Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } + } + }, + "reaction-items": { + "value": [ + { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + ] + }, + "reaction": { + "value": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + }, + "team-membership-response-if-user-has-an-active-membership-with-team": { + "summary": "Response if user has an active membership with team", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "active" + } + }, + "team-membership-response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" + } + }, + "team-membership-response-if-user-has-a-pending-membership-with-team": { + "summary": "Response if user has a pending membership with team", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" + } + }, + "team-membership-response-if-users-membership-with-team-is-now-active": { + "summary": "Response if user's membership with team is now active", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "active" + } + }, + "team-membership-response-if-users-membership-with-team-is-now-pending": { + "summary": "Response if user's membership with team is now pending", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" + } + }, + "team-project-items": { + "value": [ + { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": false, + "permissions": { "read": true, "write": true, "admin": false } + } + ] + }, + "team-project": { + "value": { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": false, + "permissions": { "read": true, "write": true, "admin": false } + } + }, + "team-repository-alternative-response-with-repository-permissions": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "group-mapping": { + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "group_description": "The people who configure your octoworld." + }, + { + "group_id": "456", + "group_name": "Octocat docs members", + "group_description": "The people who make your octoworld come to life." + } + ] + } + }, + "team-items-response-if-child-teams-exist": { + "value": [ + { + "id": 2, + "node_id": "MDQ6VGVhbTI=", + "url": "https://api.github.com/teams/2", + "name": "Original Roster", + "slug": "original-roster", + "description": "Started it all.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/2/members{/member}", + "repositories_url": "https://api.github.com/teams/2/repos", + "parent": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + }, + "html_url": "https://github.com/orgs/rails/teams/core" + } + ] + }, + "project-card": { + "value": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + }, + "project-column": { + "value": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + }, + "project-card-items": { + "value": [ + { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + ] + }, + "project-3": { + "value": { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + } + }, + "repository-collaborator-permission": { + "value": { + "permission": "admin", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "project-column-items": { + "value": [ + { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + ] + }, + "rate-limit-overview": { + "value": { + "resources": { + "core": { "limit": 5000, "remaining": 4999, "reset": 1372700873 }, + "search": { "limit": 30, "remaining": 18, "reset": 1372697452 }, + "graphql": { + "limit": 5000, + "remaining": 4993, + "reset": 1372700389 + }, + "integration_manifest": { + "limit": 5000, + "remaining": 4999, + "reset": 1551806725 + }, + "code_scanning_upload": { + "limit": 500, + "remaining": 499, + "reset": 1551806725 + } + }, + "rate": { "limit": 5000, "remaining": 4999, "reset": 1372700873 } + } + }, + "full-repository-default-response": { + "summary": "Default response", + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "pull": true, "push": false, "admin": false }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + }, + "full-repository-response-with-scarlet-witch-preview-media-type": { + "summary": "Response with scarlet-witch-preview media type", + "value": { + "id": 88760408, + "node_id": "MDEwOlJlcG9zaXRvcnk4ODc2MDQwOA==", + "name": "cosee", + "full_name": "LindseyB/cosee", + "disabled": false, + "archived": false, + "owner": { + "login": "LindseyB", + "id": 33750, + "node_id": "MDQ6VXNlcjMzNzUw", + "avatar_url": "https://avatars2.githubusercontent.com/u/33750?v=3", + "gravatar_id": "", + "url": "https://api.github.com/users/LindseyB", + "html_url": "https://github.com/LindseyB", + "followers_url": "https://api.github.com/users/LindseyB/followers", + "following_url": "https://api.github.com/users/LindseyB/following{/other_user}", + "gists_url": "https://api.github.com/users/LindseyB/gists{/gist_id}", + "starred_url": "https://api.github.com/users/LindseyB/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/LindseyB/subscriptions", + "organizations_url": "https://api.github.com/users/LindseyB/orgs", + "repos_url": "https://api.github.com/users/LindseyB/repos", + "events_url": "https://api.github.com/users/LindseyB/events{/privacy}", + "received_events_url": "https://api.github.com/users/LindseyB/received_events", + "type": "User", + "site_admin": true + }, + "private": false, + "html_url": "https://github.com/LindseyB/cosee", + "description": null, + "fork": false, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "url": "https://api.github.com/repos/LindseyB/cosee", + "forks_url": "https://api.github.com/repos/LindseyB/cosee/forks", + "keys_url": "https://api.github.com/repos/LindseyB/cosee/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/LindseyB/cosee/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/LindseyB/cosee/teams", + "hooks_url": "https://api.github.com/repos/LindseyB/cosee/hooks", + "issue_events_url": "https://api.github.com/repos/LindseyB/cosee/issues/events{/number}", + "events_url": "https://api.github.com/repos/LindseyB/cosee/events", + "assignees_url": "https://api.github.com/repos/LindseyB/cosee/assignees{/user}", + "branches_url": "https://api.github.com/repos/LindseyB/cosee/branches{/branch}", + "tags_url": "https://api.github.com/repos/LindseyB/cosee/tags", + "blobs_url": "https://api.github.com/repos/LindseyB/cosee/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/LindseyB/cosee/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/LindseyB/cosee/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/LindseyB/cosee/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/LindseyB/cosee/statuses/{sha}", + "languages_url": "https://api.github.com/repos/LindseyB/cosee/languages", + "stargazers_url": "https://api.github.com/repos/LindseyB/cosee/stargazers", + "contributors_url": "https://api.github.com/repos/LindseyB/cosee/contributors", + "subscribers_url": "https://api.github.com/repos/LindseyB/cosee/subscribers", + "subscription_url": "https://api.github.com/repos/LindseyB/cosee/subscription", + "commits_url": "https://api.github.com/repos/LindseyB/cosee/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/LindseyB/cosee/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/LindseyB/cosee/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/LindseyB/cosee/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/LindseyB/cosee/contents/{+path}", + "compare_url": "https://api.github.com/repos/LindseyB/cosee/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/LindseyB/cosee/merges", + "archive_url": "https://api.github.com/repos/LindseyB/cosee/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/LindseyB/cosee/downloads", + "issues_url": "https://api.github.com/repos/LindseyB/cosee/issues{/number}", + "pulls_url": "https://api.github.com/repos/LindseyB/cosee/pulls{/number}", + "milestones_url": "https://api.github.com/repos/LindseyB/cosee/milestones{/number}", + "notifications_url": "https://api.github.com/repos/LindseyB/cosee/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/LindseyB/cosee/labels{/name}", + "releases_url": "https://api.github.com/repos/LindseyB/cosee/releases{/id}", + "deployments_url": "https://api.github.com/repos/LindseyB/cosee/deployments", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "git_url": "git://github.com/LindseyB/cosee.git", + "ssh_url": "git@github.com:LindseyB/cosee.git", + "clone_url": "https://github.com/LindseyB/cosee.git", + "svn_url": "https://github.com/LindseyB/cosee", + "homepage": null, + "size": 1, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "forks_count": 0, + "mirror_url": null, + "open_issues_count": 0, + "forks": 0, + "open_issues": 0, + "watchers": 0, + "default_branch": "master", + "network_count": 0, + "subscribers_count": 0 + } + }, + "full-repository": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "pull": true, "push": false, "admin": false }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + }, + "artifact-paginated": { + "value": { + "total_count": 2, + "artifacts": [ + { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z" + }, + { + "id": 13, + "node_id": "MDg6QXJ0aWZhY3QxMw==", + "name": "", + "size_in_bytes": 453, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z" + } + ] + } + }, + "artifact": { + "value": { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-01-21T14:59:22Z", + "updated_at": "2020-01-21T14:59:22Z" + } + }, + "job": { + "value": { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496" + } + }, + "actions-repository-permissions": { + "value": { + "enabled": true, + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" + } + }, + "workflow-run-paginated": { + "value": { + "total_count": 1, + "workflow_runs": [ + { + "id": 30433642, + "name": "Build", + "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", + "head_branch": "master", + "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", + "run_number": 562, + "event": "push", + "status": "queued", + "conclusion": null, + "workflow_id": 159038, + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", + "pull_requests": [], + "created_at": "2020-01-22T19:33:08Z", + "updated_at": "2020-01-22T19:33:08Z", + "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", + "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", + "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", + "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", + "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", + "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", + "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", + "head_commit": { + "id": "acb5820ced9479c074f688cc328bf03f341a511d", + "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", + "message": "Create linter.yaml", + "timestamp": "2020-01-22T19:33:05Z", + "author": { "name": "Octo Cat", "email": "octocat@github.com" }, + "committer": { "name": "GitHub", "email": "noreply@github.com" } + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "head_repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" + } + } + ] + } + }, + "workflow-run": { + "value": { + "id": 30433642, + "name": "Build", + "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", + "head_branch": "master", + "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", + "run_number": 562, + "event": "push", + "status": "queued", + "conclusion": null, + "workflow_id": 159038, + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", + "pull_requests": [], + "created_at": "2020-01-22T19:33:08Z", + "updated_at": "2020-01-22T19:33:08Z", + "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", + "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", + "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", + "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", + "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", + "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", + "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", + "head_commit": { + "id": "acb5820ced9479c074f688cc328bf03f341a511d", + "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", + "message": "Create linter.yaml", + "timestamp": "2020-01-22T19:33:05Z", + "author": { "name": "Octo Cat", "email": "octocat@github.com" }, + "committer": { "name": "GitHub", "email": "noreply@github.com" } + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "head_repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" + } + } + }, + "job-paginated": { + "value": { + "total_count": 1, + "jobs": [ + { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496" + } + ] + } + }, + "workflow-run-usage": { + "value": { + "billable": { + "UBUNTU": { "total_ms": 180000, "jobs": 1 }, + "MACOS": { "total_ms": 240000, "jobs": 4 }, + "WINDOWS": { "total_ms": 300000, "jobs": 2 } + }, + "run_duration_ms": 500000 + } + }, + "actions-secret-paginated": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + } + }, + "actions-secret": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + }, + "workflow-paginated": { + "value": { + "total_count": 2, + "workflows": [ + { + "id": 161335, + "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", + "name": "CI", + "path": ".github/workflows/blank.yaml", + "state": "active", + "created_at": "2020-01-08T23:48:37.000-08:00", + "updated_at": "2020-01-08T23:50:21.000-08:00", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335", + "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335", + "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" + }, + { + "id": 269289, + "node_id": "MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==", + "name": "Linter", + "path": ".github/workflows/linter.yaml", + "state": "active", + "created_at": "2020-01-08T23:48:37.000-08:00", + "updated_at": "2020-01-08T23:50:21.000-08:00", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289", + "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289", + "badge_url": "https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg" + } + ] + } + }, + "workflow": { + "value": { + "id": 161335, + "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", + "name": "CI", + "path": ".github/workflows/blank.yaml", + "state": "active", + "created_at": "2020-01-08T23:48:37.000-08:00", + "updated_at": "2020-01-08T23:50:21.000-08:00", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335", + "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335", + "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" + } + }, + "workflow-usage": { + "value": { + "billable": { + "UBUNTU": { "total_ms": 180000 }, + "MACOS": { "total_ms": 240000 }, + "WINDOWS": { "total_ms": 300000 } + } + } + }, + "short-branch-items": { + "value": [ + { + "name": "master", + "commit": { + "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" + }, + "protected": true + } + ] + }, + "short-branch-with-protection-items": { + "value": [ + { + "name": "master", + "commit": { + "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" + }, + "protected": true, + "protection": { + "enabled": true, + "required_status_checks": { + "enforcement_level": "non_admins", + "contexts": ["ci-test", "linter"] + } + }, + "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" + } + ] + }, + "branch-with-protection": { + "value": { + "name": "master", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "commit": { + "author": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "committer": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + }, + "comment_count": 0 + }, + "author": { + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ], + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "committer": { + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + }, + "_links": { + "html": "https://github.com/octocat/Hello-World/tree/master", + "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" + }, + "protected": true, + "protection": { + "enabled": true, + "required_status_checks": { + "enforcement_level": "non_admins", + "contexts": ["ci-test", "linter"] + } + }, + "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" + } + }, + "branch-protection": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "enabled": true, + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "contexts": ["continuous-integration/travis-ci"], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", + "enforcement_level": "non_admins" + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", + "enabled": true + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2 + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": ["push", "pull_request"] + } + ] + }, + "required_linear_history": { "enabled": true }, + "allow_force_pushes": { "enabled": true }, + "allow_deletions": { "enabled": true } + } + }, + "protected-branch-admin-enforced-2": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", + "enabled": true + } + }, + "protected-branch-pull-request-review": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2 + } + }, + "protected-branch-admin-enforced": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", + "enabled": true + } + }, + "status-check-policy": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, + "contexts": ["continuous-integration/travis-ci"], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + } + }, + "branch-restriction-policy": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": ["push", "pull_request"] + } + ] + } + }, + "integration-items": { + "value": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": ["push", "pull_request"] + } + ] + }, + "check-run-example-of-in-progress-conclusion": { + "summary": "Example of in_progress conclusion", + "value": { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "42", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "in_progress", + "conclusion": "neutral", + "started_at": "2018-05-04T01:14:52Z", + "completed_at": null, + "output": { + "title": "Mighty Readme Report", + "summary": "", + "text": "", + "annotations_count": 1, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { "id": 5 }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": ["push", "pull_request"] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } + }, + "check-run-example-of-completed-conclusion": { + "summary": "Example of completed conclusion", + "value": { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "completed", + "conclusion": "neutral", + "started_at": "2018-05-04T01:14:52Z", + "completed_at": "2018-05-04T01:14:52Z", + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { "id": 5 }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": ["push", "pull_request"] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } + }, + "check-run": { + "value": { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "completed", + "conclusion": "neutral", + "started_at": "2018-05-04T01:14:52Z", + "completed_at": "2018-05-04T01:14:52Z", + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { "id": 5 }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": ["push", "pull_request"] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } + }, + "check-annotation-items": { + "value": [ + { + "path": "README.md", + "start_line": 2, + "end_line": 2, + "start_column": 5, + "end_column": 10, + "annotation_level": "warning", + "title": "Spell Checker", + "message": "Check your spelling for 'banaas'.", + "raw_details": "Do you mean 'bananas' or 'banana'?", + "blob_href": "https://api.github.com/repos/github/rest-api-description/git/blobs/abc" + } + ] + }, + "check-suite": { + "value": { + "id": 5, + "node_id": "MDEwOkNoZWNrU3VpdGU1", + "head_branch": "master", + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "status": "completed", + "conclusion": "neutral", + "url": "https://api.github.com/repos/github/hello-world/check-suites/5", + "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", + "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "pull_requests": [], + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": ["push", "pull_request"] + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0 + }, + "head_commit": { + "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "timestamp": "2016-10-10T00:00:00Z", + "author": { "name": "The Octocat", "email": "octocat@nowhere.com" }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com" + } + }, + "latest_check_runs_count": 1, + "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" + } + }, + "check-suite-preference": { + "value": { + "preferences": { + "auto_trigger_checks": [ + { "app_id": 2, "setting": true }, + { "app_id": 4, "setting": false } + ] + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "http://choosealicense.com/licenses/mit/" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + }, + "check-run-paginated": { + "value": { + "total_count": 1, + "check_runs": [ + { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "completed", + "conclusion": "neutral", + "started_at": "2018-05-04T01:14:52Z", + "completed_at": "2018-05-04T01:14:52Z", + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { "id": 5 }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": ["push", "pull_request"] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } + ] + } + }, + "code-scanning-alert-code-scanning-alert-items": { + "value": [ + { + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/github/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/github/hello-world/code-scanning/4", + "state": "open", + "dismissed_by": null, + "dismissed_at": null, + "dismissed_reason": null, + "rule": { + "id": "js/zipslip", + "severity": "error", + "description": "Arbitrary file write during zip extraction" + }, + "tool": { "name": "CodeQL command-line toolchain", "version": null } + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/github/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/github/hello-world/code-scanning/3", + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/zipslip", + "severity": "error", + "description": "Arbitrary file write during zip extraction" + }, + "tool": { "name": "CodeQL command-line toolchain", "version": null } + } + ] + }, + "code-scanning-alert-code-scanning-alert": { + "value": { + "number": 42, + "created_at": "2020-06-19T11:21:34Z", + "url": "https://api.github.com/repos/github/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/github/hello-world/code-scanning/42", + "instances": [ + { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "state": "fixed" + }, + { + "ref": "refs/pull/3740/head", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "state": "dismissed" + } + ], + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/polynomial-redos", + "severity": "warning", + "description": "Polynomial regular expression used on uncontrolled data" + }, + "tool": { "name": "CodeQL command-line toolchain", "version": null } + } + }, + "code-scanning-alert-code-scanning-alert-dismissed": { + "value": { + "number": 42, + "created_at": "2020-08-25T21:28:36Z", + "url": "https://api.github.com/repos/github/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/github/hello-world/code-scanning/42", + "instances": [ + { + "ref": "refs/heads/codeql-analysis-yml", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "state": "dismissed" + }, + { + "ref": "refs/pull/3740/head", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "state": "dismissed" + } + ], + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-09-02T22:34:56Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/polynomial-redos", + "severity": "warning", + "description": "Polynomial regular expression used on uncontrolled data" + }, + "tool": { "name": "CodeQL command-line toolchain", "version": null } + } + }, + "code-scanning-analysis-code-scanning-analysis-items": { + "value": [ + { + "ref": "refs/heads/master", + "commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83", + "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", + "tool_name": "CodeQL command-line toolchain", + "environment": "{}", + "error": "", + "created_at": "2020-08-27T15:05:21Z" + }, + { + "ref": "refs/heads/my-branch", + "commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321", + "analysis_key": ".github/workflows/shiftleft.yml:build", + "tool_name": "Python Security Analysis", + "environment": "{}", + "error": "", + "created_at": "2020-08-31T22:46:44Z" + } + ] + }, + "collaborator-items": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "permissions": { "pull": true, "push": true, "admin": false } + } + ] + }, + "repository-invitation-response-when-a-new-invitation-is-created": { + "value": { + "id": 1, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "invitee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "inviter": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "permissions": "write", + "created_at": "2016-06-13T14:52:50-05:00", + "url": "https://api.github.com/user/repository_invitations/1296269", + "html_url": "https://github.com/octocat/Hello-World/invitations" + } + }, + "repository-collaborator-permission-response-if-user-has-admin-permissions": { + "value": { + "permission": "admin", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "commit-comment-items": { + "value": [ + { + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", + "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", + "id": 1, + "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", + "body": "Great stuff", + "path": "file1.txt", + "position": 4, + "line": 14, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "author_association": "collaborator" + } + ] + }, + "commit-comment": { + "value": { + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", + "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", + "id": 1, + "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", + "body": "Great stuff", + "path": "file1.txt", + "position": 4, + "line": 14, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author_association": "collaborator", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z" + } + }, + "commit-comment-2": { + "value": { + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", + "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", + "id": 1, + "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", + "body": "Nice change", + "path": "file1.txt", + "position": 4, + "line": 14, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author_association": "collaborator", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z" + } + }, + "commit-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "support@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "support@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ] + } + ] + }, + "branch-short-items": { + "value": [ + { + "name": "branch_5", + "commit": { + "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" + }, + "protected": false + } + ] + }, + "pull-request-simple-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "id": 1, + "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", + "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", + "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "number": 1347, + "state": "open", + "locked": true, + "title": "Amazing new feature", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Please pull these awesome changes in!", + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "active_lock_reason": "too heated", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:01:12Z", + "closed_at": "2011-01-26T19:01:12Z", + "merged_at": "2011-01-26T19:01:12Z", + "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + { + "login": "hubot", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": true + } + ], + "requested_reviewers": [ + { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + } + ], + "requested_teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + ], + "head": { + "label": "octocat:new-topic", + "ref": "new-topic", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "base": { + "label": "octocat:master", + "ref": "master", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1347" + }, + "issue": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + }, + "author_association": "OWNER", + "draft": false + } + ] + }, + "commit": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ], + "stats": { "additions": 104, "deletions": 4, "total": 108 }, + "files": [ + { + "filename": "file1.txt", + "additions": 10, + "deletions": 2, + "changes": 12, + "status": "modified", + "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "patch": "@@ -29,7 +29,7 @@\n....." + } + ] + } + }, + "check-suite-paginated": { + "value": { + "total_count": 1, + "check_suites": [ + { + "id": 5, + "node_id": "MDEwOkNoZWNrU3VpdGU1", + "head_branch": "master", + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "status": "completed", + "conclusion": "neutral", + "url": "https://api.github.com/repos/github/hello-world/check-suites/5", + "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", + "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "pull_requests": [], + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": ["push", "pull_request"] + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0 + }, + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "head_commit": { + "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "timestamp": "2016-10-10T00:00:00Z", + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com" + } + }, + "latest_check_runs_count": 1, + "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" + } + ] + } + }, + "combined-commit-status": { + "value": { + "state": "success", + "statuses": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "id": 1, + "node_id": "MDY6U3RhdHVzMQ==", + "state": "success", + "description": "Build has completed successfully", + "target_url": "https://ci.example.com/1000/output", + "context": "continuous-integration/jenkins", + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z" + }, + { + "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "id": 2, + "node_id": "MDY6U3RhdHVzMg==", + "state": "success", + "description": "Testing has completed successfully", + "target_url": "https://ci.example.com/2000/output", + "context": "security/brakeman", + "created_at": "2012-08-20T01:19:13Z", + "updated_at": "2012-08-20T01:19:13Z" + } + ], + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "total_count": 2, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "commit_url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status" + } + }, + "status-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "id": 1, + "node_id": "MDY6U3RhdHVzMQ==", + "state": "success", + "description": "Build has completed successfully", + "target_url": "https://ci.example.com/1000/output", + "context": "continuous-integration/jenkins", + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "code-of-conduct-2": { + "value": { + "key": "contributor_covenant", + "name": "Contributor Covenant", + "url": "https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md", + "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\nto any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\nposting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lindseyb@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n", + "html_url": "https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md" + } + }, + "community-profile": { + "value": { + "health_percentage": 100, + "description": "My first repository on GitHub!", + "documentation": null, + "files": { + "code_of_conduct": { + "name": "Contributor Covenant", + "key": "contributor_covenant", + "url": "https://api.github.com/codes_of_conduct/contributor_covenant", + "html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md" + }, + "contributing": { + "url": "https://api.github.com/repos/octocat/Hello-World/contents/CONTRIBUTING", + "html_url": "https://github.com/octocat/Hello-World/blob/master/CONTRIBUTING" + }, + "issue_template": { + "url": "https://api.github.com/repos/octocat/Hello-World/contents/ISSUE_TEMPLATE", + "html_url": "https://github.com/octocat/Hello-World/blob/master/ISSUE_TEMPLATE" + }, + "pull_request_template": { + "url": "https://api.github.com/repos/octocat/Hello-World/contents/PULL_REQUEST_TEMPLATE", + "html_url": "https://github.com/octocat/Hello-World/blob/master/PULL_REQUEST_TEMPLATE" + }, + "license": { + "name": "MIT License", + "key": "mit", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "html_url": "https://github.com/octocat/Hello-World/blob/master/LICENSE", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "readme": { + "url": "https://api.github.com/repos/octocat/Hello-World/contents/README.md", + "html_url": "https://github.com/octocat/Hello-World/blob/master/README.md" + } + }, + "updated_at": "2017-02-28T19:09:29Z", + "content_reports_enabled": true + } + }, + "commit-comparison": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic", + "html_url": "https://github.com/octocat/Hello-World/compare/master...topic", + "permalink_url": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17", + "diff_url": "https://github.com/octocat/Hello-World/compare/master...topic.diff", + "patch_url": "https://github.com/octocat/Hello-World/compare/master...topic.patch", + "base_commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ] + }, + "merge_base_commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ] + }, + "status": "behind", + "ahead_by": 1, + "behind_by": 2, + "total_commits": 1, + "commits": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ] + } + ], + "files": [ + { + "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", + "filename": "file1.txt", + "status": "added", + "additions": 103, + "deletions": 21, + "changes": 124, + "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", + "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + } + ] + } + }, + "content-file-response-if-content-is-a-file": { + "summary": "Response if content is a file", + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + }, + "content-file-response-if-content-is-a-directory": { + "summary": "Response if content is a directory", + "value": [ + { + "type": "file", + "size": 625, + "name": "octokit.rb", + "path": "lib/octokit.rb", + "sha": "fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb", + "_links": { + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb", + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", + "html": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb" + } + }, + { + "type": "dir", + "size": 0, + "name": "octokit", + "path": "lib/octokit", + "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "html_url": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit", + "download_url": null, + "_links": { + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit", + "git": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "html": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit" + } + } + ] + }, + "content-file-response-if-content-is-a-symlink": { + "summary": "Response if content is a symlink", + "value": { + "type": "symlink", + "target": "/path/to/symlink/target", + "size": 23, + "name": "some-symlink", + "path": "bin/some-symlink", + "sha": "452a98979c88e093d682cab404a3ec82babebb48", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink", + "html": "https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink" + } + } + }, + "content-file-response-if-content-is-a-submodule": { + "summary": "Response if content is a submodule", + "value": { + "type": "submodule", + "submodule_git_url": "git://github.com/jquery/qunit.git", + "size": 0, + "name": "qunit", + "path": "test/qunit", + "sha": "6ca3721222109997540bd6d9ccd396902e0ad2f9", + "url": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master", + "git_url": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9", + "html_url": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9", + "download_url": null, + "_links": { + "git": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9", + "self": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master", + "html": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9" + } + } + }, + "file-commit-example-for-updating-a-file": { + "value": { + "content": { + "name": "hello.txt", + "path": "notes/hello.txt", + "sha": "a56507ed892d05a37c6d6128c260937ea4d287bd", + "size": 9, + "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", + "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt", + "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd", + "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt", + "type": "file", + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", + "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd", + "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt" + } + }, + "commit": { + "sha": "18a43cd8e1e3a79c786e3d808a73d23b6d212b16", + "node_id": "MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16", + "html_url": "https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "my commit message", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f", + "sha": "9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6", + "html_url": "https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6", + "sha": "da5a433788da5c255edad7979b328b67d79f53f6" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + } + } + }, + "file-commit-example-for-creating-a-file": { + "value": { + "content": { + "name": "hello.txt", + "path": "notes/hello.txt", + "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3", + "size": 9, + "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", + "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt", + "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3", + "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt", + "type": "file", + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", + "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3", + "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt" + } + }, + "commit": { + "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", + "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "my commit message", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", + "sha": "691272480426f78a0138979dd3ce63b77f706feb" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", + "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5", + "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + } + } + }, + "file-commit": { + "value": { + "content": null, + "commit": { + "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", + "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "my commit message", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", + "sha": "691272480426f78a0138979dd3ce63b77f706feb" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", + "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5", + "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + } + } + }, + "contributor-items-response-if-repository-contains-content": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "contributions": 32 + } + ] + }, + "deployment-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/example/deployments/1", + "id": 1, + "node_id": "MDEwOkRlcGxveW1lbnQx", + "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "ref": "topic-branch", + "task": "deploy", + "payload": {}, + "original_environment": "staging", + "environment": "production", + "description": "Deploy request from hubot", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", + "repository_url": "https://api.github.com/repos/octocat/example", + "transient_environment": false, + "production_environment": true + } + ] + }, + "deployment-simple-example": { + "summary": "Simple example", + "value": { + "url": "https://api.github.com/repos/octocat/example/deployments/1", + "id": 1, + "node_id": "MDEwOkRlcGxveW1lbnQx", + "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "ref": "topic-branch", + "task": "deploy", + "payload": {}, + "original_environment": "staging", + "environment": "production", + "description": "Deploy request from hubot", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", + "repository_url": "https://api.github.com/repos/octocat/example", + "transient_environment": false, + "production_environment": true + } + }, + "deployment-advanced-example": { + "summary": "Advanced example", + "value": { + "url": "https://api.github.com/repos/octocat/example/deployments/1", + "id": 1, + "node_id": "MDEwOkRlcGxveW1lbnQx", + "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "ref": "topic-branch", + "task": "deploy", + "payload": {}, + "original_environment": "staging", + "environment": "production", + "description": "Deploy request from hubot", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", + "repository_url": "https://api.github.com/repos/octocat/example", + "transient_environment": false, + "production_environment": true + } + }, + "deployment": { + "value": { + "url": "https://api.github.com/repos/octocat/example/deployments/1", + "id": 1, + "node_id": "MDEwOkRlcGxveW1lbnQx", + "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "ref": "topic-branch", + "task": "deploy", + "payload": {}, + "original_environment": "staging", + "environment": "production", + "description": "Deploy request from hubot", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", + "repository_url": "https://api.github.com/repos/octocat/example", + "transient_environment": false, + "production_environment": true + } + }, + "deployment-status-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", + "id": 1, + "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", + "state": "success", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "description": "Deployment finished successfully.", + "environment": "production", + "target_url": "https://example.com/deployment/42/output", + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", + "repository_url": "https://api.github.com/repos/octocat/example", + "environment_url": "https://test-branch.lab.acme.com", + "log_url": "https://example.com/deployment/42/output" + } + ] + }, + "deployment-status": { + "value": { + "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", + "id": 1, + "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", + "state": "success", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "description": "Deployment finished successfully.", + "environment": "production", + "target_url": "https://example.com/deployment/42/output", + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", + "repository_url": "https://api.github.com/repos/octocat/example", + "environment_url": "https://test-branch.lab.acme.com", + "log_url": "https://example.com/deployment/42/output" + } + }, + "minimal-repository-items-2": { + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": true, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==" + } + } + ] + }, + "short-blob": { + "value": { + "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" + } + }, + "blob": { + "value": { + "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", + "encoding": "base64", + "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "size": 19, + "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg==" + } + }, + "git-commit": { + "value": { + "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", + "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "my commit message", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132", + "sha": "827efc6d56897b048c772eb4087f854f46256132" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0", + "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0", + "html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + }, + "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + } + }, + "git-commit-2": { + "value": { + "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "added readme, because im a good github citizen", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", + "sha": "691272480426f78a0138979dd3ce63b77f706feb" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", + "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5", + "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + } + }, + "git-ref-items": { + "value": [ + { + "ref": "refs/heads/feature-a", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a", + "object": { + "type": "commit", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + } + }, + { + "ref": "refs/heads/feature-b", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b", + "object": { + "type": "commit", + "sha": "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac" + } + } + ] + }, + "git-ref": { + "value": { + "ref": "refs/heads/featureA", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", + "object": { + "type": "commit", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + } + } + }, + "git-tag": { + "value": { + "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", + "tag": "v0.0.1", + "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "message": "initial version", + "tagger": { + "name": "Monalisa Octocat", + "email": "octocat@github.com", + "date": "2014-11-07T22:01:45Z" + }, + "object": { + "type": "commit", + "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + } + }, + "git-tree": { + "value": { + "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", + "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", + "tree": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 132, + "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" + } + ], + "truncated": true + } + }, + "git-tree-default-response": { + "summary": "Default response", + "value": { + "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", + "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", + "tree": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 30, + "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" + }, + { + "path": "subdir", + "mode": "040000", + "type": "tree", + "sha": "f484d249c660418515fb01c2b9662073663c242e", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e" + }, + { + "path": "exec_file", + "mode": "100755", + "type": "blob", + "size": 75, + "sha": "45b983be36b73c0788dc9cbcb76cbb80fc7bb057", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057" + } + ], + "truncated": false + } + }, + "git-tree-response-recursively-retrieving-a-tree": { + "summary": "Response recursively retrieving a tree", + "value": { + "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", + "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", + "tree": [ + { + "path": "subdir/file.txt", + "mode": "100644", + "type": "blob", + "size": 132, + "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", + "url": "https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" + } + ], + "truncated": false + } + }, + "hook-items": { + "value": [ + { + "type": "Repository", + "id": 12345678, + "name": "web", + "active": true, + "events": ["push", "pull_request"], + "config": { + "content_type": "json", + "insecure_ssl": "0", + "url": "https://example.com/webhook" + }, + "updated_at": "2019-06-03T00:57:16Z", + "created_at": "2019-06-03T00:57:16Z", + "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", + "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "last_response": { + "code": null, + "status": "unused", + "message": null + } + } + ] + }, + "hook": { + "value": { + "type": "Repository", + "id": 12345678, + "name": "web", + "active": true, + "events": ["push", "pull_request"], + "config": { + "content_type": "json", + "insecure_ssl": "0", + "url": "https://example.com/webhook" + }, + "updated_at": "2019-06-03T00:57:16Z", + "created_at": "2019-06-03T00:57:16Z", + "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", + "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "last_response": { "code": null, "status": "unused", "message": null } + } + }, + "import": { + "value": { + "vcs": "subversion", + "use_lfs": "opt_in", + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "complete", + "status_text": "Done", + "has_large_files": true, + "large_files_size": 132331036, + "large_files_count": 1, + "authors_count": 4, + "url": "https://api.github.com/repos/octocat/socm/import", + "html_url": "https://import.github.com/octocat/socm/import", + "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", + "repository_url": "https://api.github.com/repos/octocat/socm" + } + }, + "import-2": { + "value": { + "vcs": "subversion", + "use_lfs": "undecided", + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "importing", + "status_text": "Importing...", + "has_large_files": false, + "large_files_size": 0, + "large_files_count": 0, + "authors_count": 0, + "commit_count": 1042, + "url": "https://api.github.com/repos/octocat/socm/import", + "html_url": "https://import.github.com/octocat/socm/import", + "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", + "repository_url": "https://api.github.com/repos/octocat/socm" + } + }, + "import-example-1": { + "summary": "Example 1", + "value": { + "vcs": "subversion", + "use_lfs": "undecided", + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "detecting", + "url": "https://api.github.com/repos/octocat/socm/import", + "html_url": "https://import.github.com/octocat/socm/import", + "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", + "repository_url": "https://api.github.com/repos/octocat/socm" + } + }, + "import-example-2": { + "summary": "Example 2", + "value": { + "vcs": "tfvc", + "use_lfs": "undecided", + "vcs_url": "http://tfs.mycompany.com/tfs/myproject", + "tfvc_project": "project1", + "status": "importing", + "status_text": "Importing...", + "has_large_files": false, + "large_files_size": 0, + "large_files_count": 0, + "authors_count": 0, + "commit_count": 1042, + "url": "https://api.github.com/repos/octocat/socm/import", + "html_url": "https://import.github.com/octocat/socm/import", + "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", + "repository_url": "https://api.github.com/repos/octocat/socm" + } + }, + "import-response": { + "summary": "Response", + "value": { + "vcs": "subversion", + "use_lfs": "undecided", + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "importing", + "status_text": "Importing...", + "has_large_files": false, + "large_files_size": 0, + "large_files_count": 0, + "authors_count": 0, + "commit_count": 1042, + "url": "https://api.github.com/repos/octocat/socm/import", + "html_url": "https://import.github.com/octocat/socm/import", + "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", + "repository_url": "https://api.github.com/repos/octocat/socm" + } + }, + "porter-author-items": { + "value": [ + { + "id": 2268557, + "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "nobody", + "email": "hubot@github.com", + "name": "Hubot", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", + "import_url": "https://api.github.com/repos/octocat/socm/import" + }, + { + "id": 2268558, + "remote_id": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "svner", + "email": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "name": "svner", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268558", + "import_url": "https://api.github.com/repos/octocat/socm/import" + }, + { + "id": 2268559, + "remote_id": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "svner@example.com", + "email": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "name": "svner@example.com", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268559", + "import_url": "https://api.github.com/repos/octocat/socm/import" + } + ] + }, + "porter-author": { + "value": { + "id": 2268557, + "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "nobody", + "email": "hubot@github.com", + "name": "Hubot", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", + "import_url": "https://api.github.com/repos/octocat/socm/import" + } + }, + "porter-large-file-items": { + "value": [ + { + "ref_name": "refs/heads/master", + "path": "foo/bar/1", + "oid": "d3d9446802a44259755d38e6d163e820", + "size": 10485760 + }, + { + "ref_name": "refs/heads/master", + "path": "foo/bar/2", + "oid": "6512bd43d9caa6e02c990b0a82652dca", + "size": 11534336 + }, + { + "ref_name": "refs/heads/master", + "path": "foo/bar/3", + "oid": "c20ad4d76fe97759aa27a0c99bff6710", + "size": 12582912 + } + ] + }, + "interaction-limit-2": { + "value": { + "limit": "collaborators_only", + "origin": "repository", + "expires_at": "2018-08-17T04:18:39Z" + } + }, + "repository-invitation-items": { + "value": [ + { + "id": 1, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "invitee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "inviter": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "permissions": "write", + "created_at": "2016-06-13T14:52:50-05:00", + "url": "https://api.github.com/user/repository_invitations/1296269", + "html_url": "https://github.com/octocat/Hello-World/invitations", + "node_id": "MDQ6VXNlcjE=" + } + ] + }, + "repository-invitation": { + "value": { + "id": 1, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "invitee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "inviter": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "permissions": "write", + "created_at": "2016-06-13T14:52:50-05:00", + "expired": false, + "url": "https://api.github.com/user/repository_invitations/1296269", + "html_url": "https://github.com/octocat/Hello-World/invitations" + } + }, + "issue-simple-items": { + "value": [ + { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "collaborator" + } + ] + }, + "issue": { + "value": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "collaborator" + } + }, + "issue-comment-items": { + "value": [ + { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "collaborator" + } + ] + }, + "issue-comment": { + "value": { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "collaborator" + } + }, + "issue-event-items": { + "value": [ + { + "id": 1, + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "issue": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "collaborator" + } + } + ] + }, + "issue-event": { + "value": { + "id": 1, + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "issue": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "collaborator" + } + } + }, + "issue-simple": { + "value": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + { + "login": "hubot", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": true + }, + { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "collaborator" + } + }, + "issue-event-for-issue-items": { + "value": [ + { + "id": 1, + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z" + } + ] + }, + "label-items": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false + } + ] + }, + "label-items-2": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ] + }, + "deploy-key-items": { + "value": [ + { + "id": 1, + "key": "ssh-rsa AAA...", + "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "title": "octocat@octomac", + "verified": true, + "created_at": "2014-12-10T15:53:42Z", + "read_only": true + } + ] + }, + "deploy-key": { + "value": { + "id": 1, + "key": "ssh-rsa AAA...", + "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "title": "octocat@octomac", + "verified": true, + "created_at": "2014-12-10T15:53:42Z", + "read_only": true + } + }, + "label": { + "value": { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + }, + "label-2": { + "value": { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "description": "Small bug fix required", + "color": "b01f26", + "default": true + } + }, + "language": { "value": { "C": 78769, "Python": 7769 } }, + "license-content": { + "value": { + "name": "LICENSE", + "path": "LICENSE", + "sha": "401c59dcc4570b954dd6d345e76199e1f4e76266", + "size": 1077, + "url": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master", + "html_url": "https://github.com/benbalter/gman/blob/master/LICENSE", + "git_url": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266", + "download_url": "https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true", + "type": "file", + "content": "VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\n", + "encoding": "base64", + "_links": { + "self": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master", + "git": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266", + "html": "https://github.com/benbalter/gman/blob/master/LICENSE" + }, + "license": { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==" + } + } + }, + "milestone-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + } + ] + }, + "milestone": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + } + }, + "page": { + "value": { + "url": "https://api.github.com/repos/github/developer.github.com/pages", + "status": "built", + "cname": "developer.github.com", + "custom_404": false, + "html_url": "https://developer.github.com", + "source": { "branch": "master", "path": "/" } + } + }, + "page-build-items": { + "value": [ + { + "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", + "status": "built", + "error": { "message": null }, + "pusher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", + "duration": 2104, + "created_at": "2014-02-10T19:00:49Z", + "updated_at": "2014-02-10T19:00:51Z" + } + ] + }, + "page-build-status": { + "value": { + "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest", + "status": "queued" + } + }, + "page-build": { + "value": { + "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", + "status": "built", + "error": { "message": null }, + "pusher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", + "duration": 2104, + "created_at": "2014-02-10T19:00:49Z", + "updated_at": "2014-02-10T19:00:51Z" + } + }, + "project-items-2": { + "value": [ + { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + } + ] + }, + "pull-request": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "id": 1, + "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", + "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", + "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "number": 1347, + "state": "open", + "locked": true, + "title": "Amazing new feature", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Please pull these awesome changes in!", + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "active_lock_reason": "too heated", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:01:12Z", + "closed_at": "2011-01-26T19:01:12Z", + "merged_at": "2011-01-26T19:01:12Z", + "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + { + "login": "hubot", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": true + } + ], + "requested_reviewers": [ + { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + } + ], + "requested_teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + ], + "head": { + "label": "octocat:new-topic", + "ref": "new-topic", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_merge_commit": true, + "forks": 123, + "open_issues": 123, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "watchers": 123 + } + }, + "base": { + "label": "octocat:master", + "ref": "master", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_merge_commit": true, + "forks": 123, + "open_issues": 123, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "watchers": 123 + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1347" + }, + "issue": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + }, + "author_association": "OWNER", + "draft": false, + "merged": false, + "mergeable": true, + "rebaseable": true, + "mergeable_state": "clean", + "merged_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "comments": 10, + "review_comments": 0, + "maintainer_can_modify": true, + "commits": 3, + "additions": 100, + "deletions": 3, + "changed_files": 5 + } + }, + "pull-request-review-comment-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "pull_request_review_id": 42, + "id": 10, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", + "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", + "path": "file1.txt", + "position": 1, + "original_position": 4, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", + "in_reply_to_id": 8, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Great stuff!", + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "author_association": "NONE", + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + } + }, + "start_line": 1, + "original_start_line": 1, + "start_side": "RIGHT", + "line": 2, + "original_line": 2, + "side": "RIGHT" + } + ] + }, + "pull-request-review-comment-2": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "pull_request_review_id": 42, + "id": 10, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", + "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", + "path": "file1.txt", + "position": 1, + "original_position": 4, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", + "in_reply_to_id": 8, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Great stuff!", + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "author_association": "NONE", + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + } + }, + "start_line": 1, + "original_start_line": 1, + "start_side": "RIGHT", + "line": 2, + "original_line": 2, + "side": "RIGHT" + } + }, + "pull-request-review-comment-example-for-a-multi-line-comment": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "pull_request_review_id": 42, + "id": 10, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", + "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", + "path": "file1.txt", + "position": 1, + "original_position": 4, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", + "in_reply_to_id": 8, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Great stuff!", + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "author_association": "NONE", + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + } + }, + "start_line": 1, + "original_start_line": 1, + "start_side": "RIGHT", + "line": 2, + "original_line": 2, + "side": "RIGHT" + } + }, + "pull-request-review-comment": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "pull_request_review_id": 42, + "id": 10, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", + "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", + "path": "file1.txt", + "position": 1, + "original_position": 4, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", + "in_reply_to_id": 426899381, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Great stuff!", + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "author_association": "NONE", + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + } + }, + "start_line": 1, + "original_start_line": 1, + "start_side": "RIGHT", + "line": 2, + "original_line": 2, + "side": "RIGHT" + } + }, + "diff-entry-items": { + "value": [ + { + "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", + "filename": "file1.txt", + "status": "added", + "additions": 103, + "deletions": 21, + "changes": 124, + "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", + "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + } + ] + }, + "pull-request-merge-result-response-if-merge-was-successful": { + "value": { + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "merged": true, + "message": "Pull Request successfully merged" + } + }, + "simple-pull-request-review-request": { + "value": { + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + ] + } + }, + "pull-request-review-request": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "id": 1, + "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", + "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", + "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "number": 1347, + "state": "open", + "locked": true, + "title": "Amazing new feature", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Please pull these awesome changes in!", + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "active_lock_reason": "too heated", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:01:12Z", + "closed_at": "2011-01-26T19:01:12Z", + "merged_at": "2011-01-26T19:01:12Z", + "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + { + "login": "hubot", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": true + } + ], + "requested_reviewers": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + { + "login": "hubot", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": true + }, + { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + } + ], + "requested_teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + ], + "head": { + "label": "octocat:new-topic", + "ref": "new-topic", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "base": { + "label": "octocat:master", + "ref": "master", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1347" + }, + "issue": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + }, + "author_association": "OWNER", + "draft": false + } + }, + "pull-request-review-items": { + "value": [ + { + "id": 80, + "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Here is the body for the review.", + "state": "APPROVED", + "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", + "_links": { + "html": { + "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + } + }, + "submitted_at": "2019-11-17T17:43:43Z", + "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", + "author_association": "collaborator" + } + ] + }, + "pull-request-review": { + "value": { + "id": 80, + "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "This is close to perfect! Please address the suggested inline change.", + "state": "CHANGES_REQUESTED", + "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", + "_links": { + "html": { + "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + } + }, + "submitted_at": "2019-11-17T17:43:43Z", + "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", + "author_association": "collaborator" + } + }, + "pull-request-review-4": { + "value": { + "id": 80, + "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Here is the body for the review.", + "state": "APPROVED", + "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", + "_links": { + "html": { + "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + } + }, + "submitted_at": "2019-11-17T17:43:43Z", + "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", + "author_association": "collaborator" + } + }, + "pull-request-review-5": { + "value": { + "id": 80, + "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "This is close to perfect! Please address the suggested inline change. And add more about this.", + "state": "CHANGES_REQUESTED", + "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", + "_links": { + "html": { + "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + } + }, + "submitted_at": "2019-11-17T17:43:43Z", + "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", + "author_association": "collaborator" + } + }, + "review-comment-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "pull_request_review_id": 42, + "id": 10, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", + "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", + "path": "file1.txt", + "position": 1, + "original_position": 4, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", + "in_reply_to_id": 8, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Great stuff!", + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "author_association": "NONE", + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + } + } + } + ] + }, + "pull-request-review-3": { + "value": { + "id": 80, + "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Here is the body for the review.", + "state": "DISMISSED", + "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", + "_links": { + "html": { + "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + } + }, + "submitted_at": "2019-11-17T17:43:43Z", + "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", + "author_association": "collaborator" + } + }, + "content-file": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + }, + "release-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", + "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", + "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", + "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", + "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", + "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", + "id": 1, + "node_id": "MDc6UmVsZWFzZTE=", + "tag_name": "v1.0.0", + "target_commitish": "master", + "name": "v1.0.0", + "body": "Description of the release", + "draft": false, + "prerelease": false, + "created_at": "2013-02-27T19:35:32Z", + "published_at": "2013-02-27T19:35:32Z", + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assets": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", + "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", + "id": 1, + "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", + "name": "example.zip", + "label": "short description", + "state": "uploaded", + "content_type": "application/zip", + "size": 1024, + "download_count": 42, + "created_at": "2013-02-27T19:35:32Z", + "updated_at": "2013-02-27T19:35:32Z", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + } + ] + }, + "release": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", + "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", + "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", + "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", + "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", + "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", + "id": 1, + "node_id": "MDc6UmVsZWFzZTE=", + "tag_name": "v1.0.0", + "target_commitish": "master", + "name": "v1.0.0", + "body": "Description of the release", + "draft": false, + "prerelease": false, + "created_at": "2013-02-27T19:35:32Z", + "published_at": "2013-02-27T19:35:32Z", + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assets": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", + "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", + "id": 1, + "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", + "name": "example.zip", + "label": "short description", + "state": "uploaded", + "content_type": "application/zip", + "size": 1024, + "download_count": 42, + "created_at": "2013-02-27T19:35:32Z", + "updated_at": "2013-02-27T19:35:32Z", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + } + }, + "release-asset": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", + "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", + "id": 1, + "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", + "name": "example.zip", + "label": "short description", + "state": "uploaded", + "content_type": "application/zip", + "size": 1024, + "download_count": 42, + "created_at": "2013-02-27T19:35:32Z", + "updated_at": "2013-02-27T19:35:32Z", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "release-asset-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", + "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", + "id": 1, + "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", + "name": "example.zip", + "label": "short description", + "state": "uploaded", + "content_type": "application/zip", + "size": 1024, + "download_count": 42, + "created_at": "2013-02-27T19:35:32Z", + "updated_at": "2013-02-27T19:35:32Z", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "release-asset-response-for-successful-upload": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", + "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", + "id": 1, + "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", + "name": "example.zip", + "label": "short description", + "state": "uploaded", + "content_type": "application/zip", + "size": 1024, + "download_count": 42, + "created_at": "2013-02-27T19:35:32Z", + "updated_at": "2013-02-27T19:35:32Z", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "secret-scanning-alert-list": { + "value": [ + { + "number": 2, + "created_at": "2020-11-06T18:48:51Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", + "state": "resolved", + "resolution": "false_positive", + "resolved_at": "2020-11-07T02:47:13Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "adafruit_io_key", + "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX" + }, + { + "number": 1, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/repo/secret-scanning/alerts/1", + "html_url": "https://github.com/owner/repo/security/secret-scanning/1", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + ] + }, + "secret-scanning-alert-open": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + }, + "secret-scanning-alert-resolved": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "state": "resolved", + "resolution": "used_in_tests", + "resolved_at": "2020-11-16T22:42:07Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + } + }, + "simple-user-items-default-response": { + "summary": "Default response", + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + }, + "stargazer-items-alternative-response-with-star-creation-timestamps": { + "summary": "Alternative response with star creation timestamps", + "value": [ + { + "starred_at": "2011-01-16T19:06:43Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "code-frequency-stat-items": { "value": [[1302998400, 1124, -435]] }, + "commit-activity-items": { + "value": [ + { "days": [0, 3, 26, 20, 39, 1, 0], "total": 89, "week": 1336280400 } + ] + }, + "contributor-activity-items": { + "value": [ + { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "total": 135, + "weeks": [{ "w": "1367712000", "a": 6898, "d": 77, "c": 10 }] + } + ] + }, + "participation-stats": { + "value": { + "all": [ + 11, + 21, + 15, + 2, + 8, + 1, + 8, + 23, + 17, + 21, + 11, + 10, + 33, + 91, + 38, + 34, + 22, + 23, + 32, + 3, + 43, + 87, + 71, + 18, + 13, + 5, + 13, + 16, + 66, + 27, + 12, + 45, + 110, + 117, + 13, + 8, + 18, + 9, + 19, + 26, + 39, + 12, + 20, + 31, + 46, + 91, + 45, + 10, + 24, + 9, + 29, + 7 + ], + "owner": [ + 3, + 2, + 3, + 0, + 2, + 0, + 5, + 14, + 7, + 9, + 1, + 5, + 0, + 48, + 19, + 2, + 0, + 1, + 10, + 2, + 23, + 40, + 35, + 8, + 8, + 2, + 10, + 6, + 30, + 0, + 2, + 9, + 53, + 104, + 3, + 3, + 10, + 4, + 7, + 11, + 21, + 4, + 4, + 22, + 26, + 63, + 11, + 2, + 14, + 1, + 10, + 3 + ] + } + }, + "code-frequency-stat-items-2": { + "value": [ + [0, 0, 5], + [0, 1, 43], + [0, 2, 21] + ] + }, + "status": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "id": 1, + "node_id": "MDY6U3RhdHVzMQ==", + "state": "success", + "description": "Build has completed successfully", + "target_url": "https://ci.example.com/1000/output", + "context": "continuous-integration/jenkins", + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "repository-subscription-response-if-you-subscribe-to-the-repository": { + "value": { + "subscribed": true, + "ignored": false, + "reason": null, + "created_at": "2012-10-06T21:34:12Z", + "url": "https://api.github.com/repos/octocat/example/subscription", + "repository_url": "https://api.github.com/repos/octocat/example" + } + }, + "repository-subscription": { + "value": { + "subscribed": true, + "ignored": false, + "reason": null, + "created_at": "2012-10-06T21:34:12Z", + "url": "https://api.github.com/repos/octocat/example/subscription", + "repository_url": "https://api.github.com/repos/octocat/example" + } + }, + "tag-items": { + "value": [ + { + "name": "v0.1", + "commit": { + "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" + }, + "zipball_url": "https://github.com/octocat/Hello-World/zipball/v0.1", + "tarball_url": "https://github.com/octocat/Hello-World/tarball/v0.1", + "node_id": "MDQ6VXNlcjE=" + } + ] + }, + "topic": { "value": { "names": ["octocat", "atom", "electron", "api"] } }, + "clone-traffic": { + "value": { + "count": 173, + "uniques": 128, + "clones": [ + { "timestamp": "2016-10-10T00:00:00Z", "count": 2, "uniques": 1 }, + { "timestamp": "2016-10-11T00:00:00Z", "count": 17, "uniques": 16 }, + { "timestamp": "2016-10-12T00:00:00Z", "count": 21, "uniques": 15 }, + { "timestamp": "2016-10-13T00:00:00Z", "count": 8, "uniques": 7 }, + { "timestamp": "2016-10-14T00:00:00Z", "count": 5, "uniques": 5 }, + { "timestamp": "2016-10-15T00:00:00Z", "count": 2, "uniques": 2 }, + { "timestamp": "2016-10-16T00:00:00Z", "count": 8, "uniques": 7 }, + { "timestamp": "2016-10-17T00:00:00Z", "count": 26, "uniques": 15 }, + { "timestamp": "2016-10-18T00:00:00Z", "count": 19, "uniques": 17 }, + { "timestamp": "2016-10-19T00:00:00Z", "count": 19, "uniques": 14 }, + { "timestamp": "2016-10-20T00:00:00Z", "count": 19, "uniques": 15 }, + { "timestamp": "2016-10-21T00:00:00Z", "count": 9, "uniques": 7 }, + { "timestamp": "2016-10-22T00:00:00Z", "count": 5, "uniques": 5 }, + { "timestamp": "2016-10-23T00:00:00Z", "count": 6, "uniques": 5 }, + { "timestamp": "2016-10-24T00:00:00Z", "count": 7, "uniques": 5 } + ] + } + }, + "content-traffic-items": { + "value": [ + { + "path": "/github/hubot", + "title": "github/hubot: A customizable life embetterment robot.", + "count": 3542, + "uniques": 2225 + }, + { + "path": "/github/hubot/blob/master/docs/scripting.md", + "title": "hubot/scripting.md at master · github/hubot · GitHub", + "count": 1707, + "uniques": 804 + }, + { + "path": "/github/hubot/tree/master/docs", + "title": "hubot/docs at master · github/hubot · GitHub", + "count": 685, + "uniques": 435 + }, + { + "path": "/github/hubot/tree/master/src", + "title": "hubot/src at master · github/hubot · GitHub", + "count": 577, + "uniques": 347 + }, + { + "path": "/github/hubot/blob/master/docs/index.md", + "title": "hubot/index.md at master · github/hubot · GitHub", + "count": 379, + "uniques": 259 + }, + { + "path": "/github/hubot/blob/master/docs/adapters.md", + "title": "hubot/adapters.md at master · github/hubot · GitHub", + "count": 354, + "uniques": 201 + }, + { + "path": "/github/hubot/tree/master/examples", + "title": "hubot/examples at master · github/hubot · GitHub", + "count": 340, + "uniques": 260 + }, + { + "path": "/github/hubot/blob/master/docs/deploying/heroku.md", + "title": "hubot/heroku.md at master · github/hubot · GitHub", + "count": 324, + "uniques": 217 + }, + { + "path": "/github/hubot/blob/master/src/robot.coffee", + "title": "hubot/robot.coffee at master · github/hubot · GitHub", + "count": 293, + "uniques": 191 + }, + { + "path": "/github/hubot/blob/master/LICENSE.md", + "title": "hubot/LICENSE.md at master · github/hubot · GitHub", + "count": 281, + "uniques": 222 + } + ] + }, + "referrer-traffic-items": { + "value": [ + { "referrer": "Google", "count": 4, "uniques": 3 }, + { "referrer": "stackoverflow.com", "count": 2, "uniques": 2 }, + { "referrer": "eggsonbread.com", "count": 1, "uniques": 1 }, + { "referrer": "yandex.ru", "count": 1, "uniques": 1 } + ] + }, + "view-traffic": { + "value": { + "count": 14850, + "uniques": 3782, + "views": [ + { + "timestamp": "2016-10-10T00:00:00Z", + "count": 440, + "uniques": 143 + }, + { + "timestamp": "2016-10-11T00:00:00Z", + "count": 1308, + "uniques": 414 + }, + { + "timestamp": "2016-10-12T00:00:00Z", + "count": 1486, + "uniques": 452 + }, + { + "timestamp": "2016-10-13T00:00:00Z", + "count": 1170, + "uniques": 401 + }, + { + "timestamp": "2016-10-14T00:00:00Z", + "count": 868, + "uniques": 266 + }, + { + "timestamp": "2016-10-15T00:00:00Z", + "count": 495, + "uniques": 157 + }, + { + "timestamp": "2016-10-16T00:00:00Z", + "count": 524, + "uniques": 175 + }, + { + "timestamp": "2016-10-17T00:00:00Z", + "count": 1263, + "uniques": 412 + }, + { + "timestamp": "2016-10-18T00:00:00Z", + "count": 1402, + "uniques": 417 + }, + { + "timestamp": "2016-10-19T00:00:00Z", + "count": 1394, + "uniques": 424 + }, + { + "timestamp": "2016-10-20T00:00:00Z", + "count": 1492, + "uniques": 448 + }, + { + "timestamp": "2016-10-21T00:00:00Z", + "count": 1153, + "uniques": 332 + }, + { + "timestamp": "2016-10-22T00:00:00Z", + "count": 566, + "uniques": 168 + }, + { + "timestamp": "2016-10-23T00:00:00Z", + "count": 675, + "uniques": 184 + }, + { + "timestamp": "2016-10-24T00:00:00Z", + "count": 614, + "uniques": 237 + } + ] + } + }, + "repository-3": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + } + } + }, + "public-repository-items": { + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + }, + "scim-enterprise-group-list": { + "value": { + "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"], + "totalResults": 2, + "itemsPerPage": 2, + "startIndex": 1, + "Resources": [ + { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:00", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + }, + { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"], + "id": "5e75bbbb-aa1a-11ea-8644-75ff655cdddd", + "externalId": null, + "displayName": "octo-docs-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T16:28:01.000+10:00", + "lastModified": "2020-06-09T16:28:01.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd" + } + } + ] + } + }, + "scim-enterprise-group": { + "value": { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:0", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + }, + "scim-enterprise-group-2": { + "value": { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:00", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + }, + "scim-enterprise-user-list": { + "value": { + "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"], + "totalResults": 2, + "itemsPerPage": 2, + "startIndex": 1, + "Resources": [ + { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], + "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "externalId": "00dowz5dr9oSfDFRA0h7", + "userName": "octocat@github.com", + "name": { "givenName": "Mona", "familyName": "Octocat" }, + "emails": [ + { + "value": "octocat@github.com", + "primary": true, + "type": "work" + } + ], + "groups": [{ "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" }], + "active": true, + "meta": { + "resourceType": "User", + "created": "2020-05-30T04:02:34.000+10:00", + "lastModified": "2020-05-30T04:05:04.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + } + }, + { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], + "id": "e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5", + "externalId": "sdfoiausdofiua", + "userName": "hubot@example.com", + "name": { "givenName": "hu", "familyName": "bot" }, + "emails": [ + { + "value": "hubot@example.com", + "type": "work", + "primary": true + } + ], + "groups": [], + "active": true, + "meta": { + "resourceType": "User", + "created": "2020-06-05T08:29:40.000+10:00", + "lastModified": "2020-06-05T08:30:19.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5" + } + } + ] + } + }, + "scim-enterprise-user": { + "value": { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], + "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "externalId": "00dowz5dr9oSfDFRA0h7", + "userName": "mona.octocat@okta.example.com", + "name": { "givenName": "Mona", "familyName": "Octocat" }, + "emails": [ + { + "value": "mona.octocat@okta.example.com", + "type": "work", + "primary": true + } + ], + "groups": [{ "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" }], + "active": true, + "meta": { + "resourceType": "User", + "created": "2017-03-09T16:11:13-05:00", + "lastModified": "2017-03-09T16:11:13-05:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + } + } + }, + "scim-enterprise-user-2": { + "value": { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], + "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "externalId": "00dowz5dr9oSfDFRA0h7", + "userName": "mona.octocat@okta.example.com", + "name": { "givenName": "Monalisa", "familyName": "Octocat" }, + "emails": [ + { + "value": "mona.octocat@okta.example.com", + "type": "work", + "primary": true + }, + { "value": "monalisa@octocat.github.com", "type": "home" } + ], + "groups": [{ "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d" }], + "active": true, + "meta": { + "resourceType": "User", + "created": "2017-03-09T16:11:13-05:00", + "lastModified": "2017-03-09T16:11:13-05:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + } + } + }, + "scim-user-list-response-with-filter": { + "summary": "Response with filter", + "value": { + "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"], + "totalResults": 1, + "itemsPerPage": 1, + "startIndex": 1, + "Resources": [ + { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], + "id": "5fc0c238-1112-11e8-8e45-920c87bdbd75", + "externalId": "00u1dhhb1fkIGP7RL1d8", + "userName": "octocat@github.com", + "displayName": "Mona Octocat", + "name": { + "givenName": "Mona", + "familyName": "Octocat", + "formatted": "Mona Octocat" + }, + "emails": [{ "value": "octocat@github.com", "primary": true }], + "active": true, + "meta": { + "resourceType": "User", + "created": "2018-02-13T15:05:24.000-08:00", + "lastModified": "2018-02-13T15:05:55.000-08:00", + "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/5fc0c238-1112-11e8-8e45-920c87bdbd75" + } + } + ] + } + }, + "scim-user-list-response-without-filter": { + "summary": "Response without filter", + "value": { + "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"], + "totalResults": 2, + "itemsPerPage": 2, + "startIndex": 1, + "Resources": [ + { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], + "id": "edefdfedf-050c-11e7-8d32", + "externalId": "a7d0f98382", + "userName": "mona.octocat@okta.example.com", + "displayName": "Mona Octocat", + "name": { + "givenName": "Mona", + "familyName": "Octocat", + "formatted": "Mona Octocat" + }, + "emails": [ + { "value": "mona.octocat@okta.example.com", "primary": true } + ], + "active": true, + "meta": { + "resourceType": "User", + "created": "2017-03-09T16:11:13-05:00", + "lastModified": "2017-03-09T16:11:13-05:00", + "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" + } + }, + { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], + "id": "77563764-eb6-24-0598234-958243", + "externalId": "sdfoiausdofiua", + "userName": "hubot@example.com", + "displayName": "hu bot", + "name": { + "givenName": "hu", + "familyName": "bot", + "formatted": "hu bot" + }, + "emails": [{ "value": "hubot@example.com", "primary": true }], + "active": true, + "meta": { + "resourceType": "User", + "created": "2017-03-09T16:11:13-05:00", + "lastModified": "2017-03-09T16:11:13-05:00", + "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243" + } + } + ] + } + }, + "scim-user": { + "value": { + "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], + "id": "edefdfedf-050c-11e7-8d32", + "externalId": "a7d0f98382", + "userName": "mona.octocat@okta.example.com", + "displayName": "Monalisa Octocat", + "name": { + "givenName": "Monalisa", + "familyName": "Octocat", + "formatted": "Monalisa Octocat" + }, + "emails": [ + { "value": "mona.octocat@okta.example.com", "primary": true }, + { "value": "monalisa@octocat.github.com" } + ], + "active": true, + "meta": { + "resourceType": "User", + "created": "2017-03-09T16:11:13-05:00", + "lastModified": "2017-03-09T16:11:13-05:00", + "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" + } + } + }, + "code-search-result-item-paginated": { + "value": { + "total_count": 7, + "incomplete_results": false, + "items": [ + { + "name": "classes.js", + "path": "src/attributes/classes.js", + "sha": "d7212f9dee2dcc18f084d7df8f417b80846ded5a", + "url": "https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4", + "git_url": "https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a", + "html_url": "https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js", + "repository": { + "id": 167174, + "node_id": "MDEwOlJlcG9zaXRvcnkxNjcxNzQ=", + "name": "jquery", + "full_name": "jquery/jquery", + "owner": { + "login": "jquery", + "id": 70142, + "node_id": "MDQ6VXNlcjcwMTQy", + "avatar_url": "https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png", + "gravatar_id": "", + "url": "https://api.github.com/users/jquery", + "html_url": "https://github.com/jquery", + "followers_url": "https://api.github.com/users/jquery/followers", + "following_url": "https://api.github.com/users/jquery/following{/other_user}", + "gists_url": "https://api.github.com/users/jquery/gists{/gist_id}", + "starred_url": "https://api.github.com/users/jquery/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/jquery/subscriptions", + "organizations_url": "https://api.github.com/users/jquery/orgs", + "repos_url": "https://api.github.com/users/jquery/repos", + "events_url": "https://api.github.com/users/jquery/events{/privacy}", + "received_events_url": "https://api.github.com/users/jquery/received_events", + "type": "Organization", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/jquery/jquery", + "description": "jQuery JavaScript Library", + "fork": false, + "url": "https://api.github.com/repos/jquery/jquery", + "forks_url": "https://api.github.com/repos/jquery/jquery/forks", + "keys_url": "https://api.github.com/repos/jquery/jquery/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/jquery/jquery/teams", + "hooks_url": "https://api.github.com/repos/jquery/jquery/hooks", + "issue_events_url": "https://api.github.com/repos/jquery/jquery/issues/events{/number}", + "events_url": "https://api.github.com/repos/jquery/jquery/events", + "assignees_url": "https://api.github.com/repos/jquery/jquery/assignees{/user}", + "branches_url": "https://api.github.com/repos/jquery/jquery/branches{/branch}", + "tags_url": "https://api.github.com/repos/jquery/jquery/tags", + "blobs_url": "https://api.github.com/repos/jquery/jquery/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/jquery/jquery/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/jquery/jquery/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/jquery/jquery/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/jquery/jquery/statuses/{sha}", + "languages_url": "https://api.github.com/repos/jquery/jquery/languages", + "stargazers_url": "https://api.github.com/repos/jquery/jquery/stargazers", + "contributors_url": "https://api.github.com/repos/jquery/jquery/contributors", + "subscribers_url": "https://api.github.com/repos/jquery/jquery/subscribers", + "subscription_url": "https://api.github.com/repos/jquery/jquery/subscription", + "commits_url": "https://api.github.com/repos/jquery/jquery/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/jquery/jquery/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/jquery/jquery/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/jquery/jquery/issues/comments/{number}", + "contents_url": "https://api.github.com/repos/jquery/jquery/contents/{+path}", + "compare_url": "https://api.github.com/repos/jquery/jquery/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/jquery/jquery/merges", + "archive_url": "https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/jquery/jquery/downloads", + "issues_url": "https://api.github.com/repos/jquery/jquery/issues{/number}", + "pulls_url": "https://api.github.com/repos/jquery/jquery/pulls{/number}", + "milestones_url": "https://api.github.com/repos/jquery/jquery/milestones{/number}", + "notifications_url": "https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/jquery/jquery/labels{/name}", + "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments", + "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "score": 1 + } + ] + } + }, + "commit-search-result-item-paginated": { + "value": { + "total_count": 1, + "incomplete_results": false, + "items": [ + { + "url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", + "sha": "bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", + "html_url": "https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", + "comments_url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", + "author": { + "date": "2014-02-04T14:38:36-08:00", + "name": "The Octocat", + "email": "octocat@nowhere.com" + }, + "committer": { + "date": "2014-02-12T15:18:55-08:00", + "name": "The Octocat", + "email": "octocat@nowhere.com" + }, + "message": "Create styles.css and updated README", + "tree": { + "url": "https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68", + "sha": "a639e96f9038797fba6e0469f94a4b0cc459fa68" + }, + "comment_count": 8 + }, + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": {}, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4", + "html_url": "https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4", + "sha": "a30c19e3f13765a3b48829788bc1cb8b4e95cee4" + } + ], + "repository": { + "id": 1300192, + "node_id": "MDEwOlJlcG9zaXRvcnkxMzAwMTky", + "name": "Spoon-Knife", + "full_name": "octocat/Spoon-Knife", + "owner": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Spoon-Knife", + "description": "This repo is for demonstration purposes only.", + "fork": false, + "url": "https://api.github.com/repos/octocat/Spoon-Knife", + "forks_url": "https://api.github.com/repos/octocat/Spoon-Knife/forks", + "keys_url": "https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat/Spoon-Knife/teams", + "hooks_url": "https://api.github.com/repos/octocat/Spoon-Knife/hooks", + "issue_events_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat/Spoon-Knife/events", + "assignees_url": "https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat/Spoon-Knife/tags", + "blobs_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat/Spoon-Knife/languages", + "stargazers_url": "https://api.github.com/repos/octocat/Spoon-Knife/stargazers", + "contributors_url": "https://api.github.com/repos/octocat/Spoon-Knife/contributors", + "subscribers_url": "https://api.github.com/repos/octocat/Spoon-Knife/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Spoon-Knife/subscription", + "commits_url": "https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat/Spoon-Knife/merges", + "archive_url": "https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat/Spoon-Knife/downloads", + "issues_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat/Spoon-Knife/deployments" + }, + "score": 1, + "node_id": "MDQ6VXNlcjU4MzIzMQ==" + } + ] + } + }, + "issue-search-result-item-paginated": { + "value": { + "total_count": 280, + "incomplete_results": false, + "items": [ + { + "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", + "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", + "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", + "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", + "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", + "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", + "id": 35802, + "node_id": "MDU6SXNzdWUzNTgwMg==", + "number": 132, + "title": "Line Number Indexes Beyond 20 Not Displayed", + "user": { + "login": "Nick3C", + "id": 90254, + "node_id": "MDQ6VXNlcjkwMjU0", + "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/Nick3C", + "html_url": "https://github.com/Nick3C", + "followers_url": "https://api.github.com/users/Nick3C/followers", + "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", + "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", + "organizations_url": "https://api.github.com/users/Nick3C/orgs", + "repos_url": "https://api.github.com/users/Nick3C/repos", + "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", + "received_events_url": "https://api.github.com/users/Nick3C/received_events", + "type": "User", + "site_admin": true + }, + "labels": [ + { + "id": 4, + "node_id": "MDU6TGFiZWw0", + "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", + "name": "bug", + "color": "ff0000" + } + ], + "state": "open", + "assignee": null, + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "comments": 15, + "created_at": "2009-07-12T20:10:41Z", + "updated_at": "2009-07-19T09:23:43Z", + "closed_at": null, + "pull_request": { + "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "body": "...", + "score": 1, + "locked": true, + "author_association": "collaborator" + } + ] + } + }, + "label-search-result-item-paginated": { + "value": { + "total_count": 2, + "incomplete_results": false, + "items": [ + { + "id": 418327088, + "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", + "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", + "name": "enhancement", + "color": "84b6eb", + "default": true, + "description": "New feature or request.", + "score": 1 + }, + { + "id": 418327086, + "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", + "url": "https://api.github.com/repos/octocat/linguist/labels/bug", + "name": "bug", + "color": "ee0701", + "default": true, + "description": "Something isn't working.", + "score": 1 + } + ] + } + }, + "repo-search-result-item-paginated": { + "value": { + "total_count": 40, + "incomplete_results": false, + "items": [ + { + "id": 3081286, + "node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2", + "name": "Tetris", + "full_name": "dtrupenn/Tetris", + "owner": { + "login": "dtrupenn", + "id": 872147, + "node_id": "MDQ6VXNlcjg3MjE0Nw==", + "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/dtrupenn", + "received_events_url": "https://api.github.com/users/dtrupenn/received_events", + "type": "User", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "site_admin": true + }, + "private": false, + "html_url": "https://github.com/dtrupenn/Tetris", + "description": "A C implementation of Tetris using Pennsim through LC4", + "fork": false, + "url": "https://api.github.com/repos/dtrupenn/Tetris", + "created_at": "2012-01-01T00:31:50Z", + "updated_at": "2013-01-05T17:58:47Z", + "pushed_at": "2012-01-01T00:37:02Z", + "homepage": "https://github.com", + "size": 524, + "stargazers_count": 1, + "watchers_count": 1, + "language": "Assembly", + "forks_count": 0, + "open_issues_count": 0, + "master_branch": "master", + "default_branch": "master", + "score": 1, + "archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}", + "blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}", + "commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}", + "compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}", + "contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors", + "deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments", + "downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads", + "events_url": "https://api.github.com/repos/dtrupenn/Tetris/events", + "forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks", + "git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}", + "git_url": "git:github.com/dtrupenn/Tetris.git", + "issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}", + "issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}", + "keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}", + "labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}", + "languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages", + "merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges", + "milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}", + "notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}", + "releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}", + "ssh_url": "git@github.com:dtrupenn/Tetris.git", + "stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers", + "statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers", + "subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription", + "tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags", + "teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams", + "trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}", + "clone_url": "https://github.com/dtrupenn/Tetris.git", + "mirror_url": "git:git.example.com/dtrupenn/Tetris", + "hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks", + "svn_url": "https://svn.github.com/dtrupenn/Tetris", + "forks": 1, + "open_issues": 1, + "watchers": 1, + "has_issues": true, + "has_projects": true, + "has_pages": true, + "has_wiki": true, + "has_downloads": true, + "archived": true, + "disabled": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + } + } + ] + } + }, + "topic-search-result-item-paginated": { + "value": { + "total_count": 6, + "incomplete_results": false, + "items": [ + { + "name": "ruby", + "display_name": "Ruby", + "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.", + "description": "Ruby was developed by Yukihiro \"Matz\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.", + "created_by": "Yukihiro Matsumoto", + "released": "December 21, 1995", + "created_at": "2016-11-28T22:03:59Z", + "updated_at": "2017-10-30T18:16:32Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "rails", + "display_name": "Rails", + "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.", + "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.", + "created_by": "David Heinemeier Hansson", + "released": "December 13 2005", + "created_at": "2016-12-09T17:03:50Z", + "updated_at": "2017-10-30T16:20:19Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "python", + "display_name": "Python", + "short_description": "Python is a dynamically typed programming language.", + "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.", + "created_by": "Guido van Rossum", + "released": "February 20, 1991", + "created_at": "2016-12-07T00:07:02Z", + "updated_at": "2017-10-27T22:45:43Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "jekyll", + "display_name": "Jekyll", + "short_description": "Jekyll is a simple, blog-aware static site generator.", + "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.", + "created_by": "Tom Preston-Werner", + "released": "2008", + "created_at": "2016-12-16T21:53:08Z", + "updated_at": "2017-10-27T19:00:24Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "sass", + "display_name": "Sass", + "short_description": "Sass is a stable extension to classic CSS.", + "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.", + "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein", + "released": "November 28, 2006", + "created_at": "2016-12-16T21:53:45Z", + "updated_at": "2018-01-16T16:30:40Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "homebrew", + "display_name": "Homebrew", + "short_description": "Homebrew is a package manager for macOS.", + "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.", + "created_by": "Max Howell", + "released": "2009", + "created_at": "2016-12-17T20:30:44Z", + "updated_at": "2018-02-06T16:14:56Z", + "featured": true, + "curated": true, + "score": 1 + } + ] + } + }, + "user-search-result-item-paginated": { + "value": { + "total_count": 12, + "incomplete_results": false, + "items": [ + { + "login": "mojombo", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/mojombo", + "html_url": "https://github.com/mojombo", + "followers_url": "https://api.github.com/users/mojombo/followers", + "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions", + "organizations_url": "https://api.github.com/users/mojombo/orgs", + "repos_url": "https://api.github.com/users/mojombo/repos", + "received_events_url": "https://api.github.com/users/mojombo/received_events", + "type": "User", + "score": 1, + "following_url": "https://api.github.com/users/mojombo/following{/other_user}", + "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}", + "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}", + "events_url": "https://api.github.com/users/mojombo/events{/privacy}", + "site_admin": true + } + ] + } + }, + "team-repository-alternative-response-with-extra-repository-information": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "group-mapping-2": { + "value": { + "groups": [ + { + "group_id": "123", + "group_name": "Octocat admins", + "group_description": "The people who configure your octoworld." + } + ] + } + }, + "private-user-response-with-public-and-private-profile-information": { + "summary": "Response with public and private profile information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "private_gists": 81, + "total_private_repos": 100, + "owned_private_repos": 100, + "disk_usage": 10000, + "collaborators": 8, + "two_factor_authentication": true, + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "collaborators": 0 + } + } + }, + "private-user-response-with-public-profile-information": { + "summary": "Response with public profile information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "private-user": { + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "private_gists": 81, + "total_private_repos": 100, + "owned_private_repos": 100, + "disk_usage": 10000, + "collaborators": 8, + "two_factor_authentication": true, + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "collaborators": 0 + } + } + }, + "email-items-3": { + "value": [ + { + "email": "octocat@github.com", + "primary": true, + "verified": true, + "visibility": "private" + } + ] + }, + "email-items-2": { + "value": [ + { + "email": "octocat@github.com", + "verified": true, + "primary": true, + "visibility": "public" + } + ] + }, + "email-items": { + "value": [ + { + "email": "octocat@octocat.org", + "primary": false, + "verified": false, + "visibility": "public" + }, + { + "email": "octocat@github.com", + "primary": false, + "verified": false, + "visibility": null + }, + { + "email": "mona@github.com", + "primary": false, + "verified": false, + "visibility": null + } + ] + }, + "gpg-key-items": { + "value": [ + { + "id": 3, + "primary_key_id": 2, + "key_id": "3262EFF25BA0D270", + "public_key": "xsBNBFayYZ...", + "emails": [ + { + "email": "mastahyeti@users.noreply.github.com", + "verified": true + } + ], + "subkeys": [ + { + "id": 4, + "primary_key_id": 3, + "key_id": "4A595D4C72EE49C7", + "public_key": "zsBNBFayYZ...", + "emails": [], + "subkeys": [], + "can_sign": false, + "can_encrypt_comms": true, + "can_encrypt_storage": true, + "can_certify": false, + "created_at": "2016-03-24T11:31:04-06:00", + "expires_at": "2016-03-24T11:31:04-07:00" + } + ], + "can_sign": true, + "can_encrypt_comms": false, + "can_encrypt_storage": false, + "can_certify": true, + "created_at": "2016-03-24T11:31:04-06:00", + "expires_at": "2016-03-24T11:31:04-07:00", + "raw_key": "string" + } + ] + }, + "gpg-key": { + "value": { + "id": 3, + "primary_key_id": 2, + "key_id": "3262EFF25BA0D270", + "public_key": "xsBNBFayYZ...", + "emails": [ + { "email": "mastahyeti@users.noreply.github.com", "verified": true } + ], + "subkeys": [ + { + "id": 4, + "primary_key_id": 3, + "key_id": "4A595D4C72EE49C7", + "public_key": "zsBNBFayYZ...", + "emails": [], + "subkeys": [], + "can_sign": false, + "can_encrypt_comms": true, + "can_encrypt_storage": true, + "can_certify": false, + "created_at": "2016-03-24T11:31:04-06:00", + "expires_at": "2016-03-24T11:31:04-07:00" + } + ], + "can_sign": true, + "can_encrypt_comms": false, + "can_encrypt_storage": false, + "can_certify": true, + "created_at": "2016-03-24T11:31:04-06:00", + "expires_at": "2016-03-24T11:31:04-07:00", + "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\"" + } + }, + "base-installation-for-auth-user-paginated": { + "value": { + "total_count": 2, + "installations": [ + { + "id": 1, + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": ["push", "pull_request"], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": ["config.yml", ".github/issue_TEMPLATE.md"], + "repository_selection": "all", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions" + }, + { + "id": 3, + "account": { + "login": "octocat", + "id": 2, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": ["push", "pull_request"], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": ["config.yml", ".github/issue_TEMPLATE.md"], + "repository_selection": "all", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions" + } + ] + } + }, + "interaction-limit-user": { + "value": { + "limit": "collaborators_only", + "origin": "user", + "expires_at": "2018-08-17T04:18:39Z" + } + }, + "key-items": { + "value": [ + { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z", + "verified": false, + "read_only": false + }, + { + "key_id": "012345678912345608", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "id": 3, + "url": "https://api.github.com/user/keys/3", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z", + "verified": false, + "read_only": false + } + ] + }, + "key": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z", + "verified": false, + "read_only": false + } + }, + "user-marketplace-purchase-items": { + "value": [ + { + "billing_cycle": "monthly", + "next_billing_date": "2017-11-11T00:00:00Z", + "unit_count": null, + "on_free_trial": true, + "free_trial_ends_on": "2017-11-11T00:00:00Z", + "updated_at": "2017-11-02T01:12:12Z", + "account": { + "login": "github", + "id": 4, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "email": null, + "organization_billing_email": "billing@github.com", + "type": "Organization" + }, + "plan": { + "url": "https://api.github.com/marketplace_listing/plans/1313", + "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", + "id": 1313, + "number": 3, + "name": "Pro", + "description": "A professional-grade CI solution", + "monthly_price_in_cents": 1099, + "yearly_price_in_cents": 11870, + "price_model": "flat-rate", + "has_free_trial": true, + "unit_name": null, + "state": "published", + "bullets": [ + "Up to 25 private repositories", + "11 concurrent builds" + ] + } + } + ] + }, + "org-membership-items": { + "value": [ + { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", + "state": "pending", + "role": "admin", + "organization_url": "https://api.github.com/orgs/invitocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "org-membership": { + "value": { + "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", + "state": "pending", + "role": "admin", + "organization_url": "https://api.github.com/orgs/invitocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "org-membership-2": { + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "migration-items": { + "value": [ + { + "id": 79, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00", + "node_id": "MDQ6VXNlcjE=" + } + ] + }, + "migration-2": { + "value": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + } + }, + "migration": { + "value": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "exported", + "lock_repositories": true, + "exclude_attachments": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + } + }, + "project": { + "value": { + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + } + }, + "repository-items-default-response": { + "summary": "Default response", + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + }, + "starred-repository-items-alternative-response-with-star-creation-timestamps": { + "summary": "Alternative response with star creation timestamps", + "value": [ + { + "starred_at": "2011-01-16T19:06:43Z", + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": ["octocat", "atom", "electron", "api"], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { "admin": false, "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + ] + }, + "team-full-items": { + "value": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + ] + }, + "public-user-default-response": { + "summary": "Default response", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "public-user-response-with-git-hub-plan-information": { + "summary": "Response with GitHub plan information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + } + }, + "hovercard": { + "value": { + "contexts": [{ "message": "Owns this repository", "octicon": "repo" }] + } + }, + "key-simple-items": { "value": [{ "id": 1, "key": "ssh-rsa AAA..." }] }, + "project-items-3": { + "value": [ + { + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + } + ] + } + }, + "responses": { + "not_found": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + }, + "validation_failed_simple": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/validation-error-simple" } + } + } + }, + "preview_header_missing": { + "description": "Preview Header Missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["message", "documentation_url"], + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + } + } + } + }, + "forbidden": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + }, + "requires_authentication": { + "description": "Requires Authentication", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + }, + "validation_failed": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/validation-error" } + } + } + }, + "not_modified": { "description": "Not Modified" }, + "gone": { + "description": "Gone", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + }, + "service_unavailable": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { "type": "string" }, + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + } + } + } + }, + "forbidden_gist": { + "description": "Forbidden Gist", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "block": { + "type": "object", + "properties": { + "reason": { "type": "string" }, + "created_at": { "type": "string" }, + "html_url": { "type": "string", "nullable": true } + } + }, + "message": { "type": "string" }, + "documentation_url": { "type": "string" } + } + } + } + } + }, + "moved_permanently": { "description": "Moved Permanently" }, + "conflict": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + }, + "internal_error": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + } + } + }, + "bad_request": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/basic-error" } + }, + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + } + } + }, + "found": { "description": "Found" }, + "scim_not_found": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + }, + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + } + } + }, + "scim_forbidden": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + }, + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + } + } + }, + "scim_bad_request": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + }, + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + } + } + }, + "scim_internal_error": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + }, + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + } + } + }, + "scim_conflict": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + }, + "application/scim+json": { + "schema": { "$ref": "#/components/schemas/scim-error" } + } + } + } + }, + "parameters": { + "per_page": { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "query", + "schema": { "type": "integer", "default": 30 } + }, + "page": { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { "type": "integer", "default": 1 } + }, + "since": { + "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" } + }, + "installation_id": { + "name": "installation_id", + "description": "installation_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "grant_id": { + "name": "grant_id", + "description": "grant_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "client-id": { + "name": "client_id", + "in": "path", + "required": true, + "description": "The client ID of your GitHub app.", + "schema": { "type": "string" } + }, + "access-token": { + "name": "access_token", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "app_slug": { + "name": "app_slug", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "authorization_id": { + "name": "authorization_id", + "description": "authorization_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "enterprise": { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "org_id": { + "name": "org_id", + "description": "Unique identifier of an organization.", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "runner_group_id": { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "runner_id": { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "audit-log-phrase": { + "name": "phrase", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + "audit-log-include": { + "name": "include", + "description": "The event types to include:\n\n- `web` - returns web (non-Git) events\n- `git` - returns Git events\n- `all` - returns both web and Git events\n\nThe default is `web`.", + "in": "query", + "required": false, + "schema": { "type": "string", "enum": ["web", "git", "all"] } + }, + "audit-log-after": { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + "audit-log-before": { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + "gist_id": { + "name": "gist_id", + "description": "gist_id parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "comment_id": { + "name": "comment_id", + "description": "comment_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "labels": { + "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + "direction": { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["asc", "desc"], + "default": "desc" + } + }, + "account_id": { + "name": "account_id", + "description": "account_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "plan_id": { + "name": "plan_id", + "description": "plan_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "sort": { + "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": ["created", "updated"], + "default": "created" + } + }, + "owner": { + "name": "owner", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "repo": { + "name": "repo", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "all": { + "name": "all", + "description": "If `true`, show notifications marked as read.", + "in": "query", + "required": false, + "schema": { "type": "boolean", "default": false } + }, + "participating": { + "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 } + }, + "before": { + "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" } + }, + "thread_id": { + "name": "thread_id", + "description": "thread_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "since-org": { + "name": "since", + "description": "An organization ID. Only return organizations with an ID greater than this ID.", + "in": "query", + "required": false, + "schema": { "type": "integer" } + }, + "org": { + "name": "org", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "repository_id": { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "secret_name": { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "username": { + "name": "username", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "hook-id": { + "name": "hook_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "invitation_id": { + "name": "invitation_id", + "description": "invitation_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "migration_id": { + "name": "migration_id", + "description": "migration_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "repo_name": { + "name": "repo_name", + "description": "repo_name parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "team_slug": { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "discussion-number": { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "comment-number": { + "name": "comment_number", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "reaction-id": { + "name": "reaction_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "project-id": { + "name": "project_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "card_id": { + "name": "card_id", + "description": "card_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "column_id": { + "name": "column_id", + "description": "column_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "artifact_id": { + "name": "artifact_id", + "description": "artifact_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "job_id": { + "name": "job_id", + "description": "job_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "actor": { + "name": "actor", + "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + "workflow-run-branch": { + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + "event": { + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + "workflow-run-status": { + "name": "status", + "description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run).\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["completed", "status", "conclusion"] + } + }, + "run-id": { + "name": "run_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "workflow-id": { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { "oneOf": [{ "type": "integer" }, { "type": "string" }] } + }, + "branch": { + "name": "branch", + "description": "branch+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "check_run_id": { + "name": "check_run_id", + "description": "check_run_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "check_suite_id": { + "name": "check_suite_id", + "description": "check_suite_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "check_name": { + "name": "check_name", + "description": "Returns check runs with the specified `name`.", + "in": "query", + "required": false, + "schema": { "type": "string" } + }, + "status": { + "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": ["queued", "in_progress", "completed"] + } + }, + "alert_number": { + "name": "alert_number", + "in": "path", + "description": "The security alert number, found at the end of the security alert's URL.", + "required": true, + "schema": { "$ref": "#/components/schemas/alert-number" } + }, + "commit_sha": { + "name": "commit_sha", + "description": "commit_sha+ parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "deployment_id": { + "name": "deployment_id", + "description": "deployment_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "since-user": { + "name": "since", + "description": "A user ID. Only return users with an ID greater than this ID.", + "in": "query", + "required": false, + "schema": { "type": "integer" } + }, + "issue_number": { + "name": "issue_number", + "description": "issue_number parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "key_id": { + "name": "key_id", + "description": "key_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "milestone_number": { + "name": "milestone_number", + "description": "milestone_number parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "pull-number": { + "name": "pull_number", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "review_id": { + "name": "review_id", + "description": "review_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "asset_id": { + "name": "asset_id", + "description": "asset_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "release_id": { + "name": "release_id", + "description": "release_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "per": { + "name": "per", + "description": "Must be one of: `day`, `week`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": ["day", "week"], + "default": "day" + } + }, + "since-repo": { + "name": "since", + "description": "A repository ID. Only return repositories with an ID greater than this ID.", + "in": "query", + "required": false, + "schema": { "type": "integer" } + }, + "start_index": { + "name": "startIndex", + "description": "Used for pagination: the index of the first result to return.", + "in": "query", + "required": false, + "schema": { "type": "integer" } + }, + "count": { + "name": "count", + "description": "Used for pagination: the number of results to return.", + "in": "query", + "required": false, + "schema": { "type": "integer" } + }, + "scim_group_id": { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "scim_user_id": { + "name": "scim_user_id", + "description": "scim_user_id parameter", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + "order": { + "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": ["desc", "asc"], + "default": "desc" + } + }, + "team-id": { + "name": "team_id", + "in": "path", + "required": true, + "schema": { "type": "integer" } + }, + "gpg_key_id": { + "name": "gpg_key_id", + "description": "gpg_key_id parameter", + "in": "path", + "required": true, + "schema": { "type": "integer" } + } + }, + "headers": { + "link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { "type": "string" } + }, + "content-type": { + "example": "text/html", + "schema": { "type": "string" } + }, + "x-common-marker-version": { + "example": "0.17.4", + "schema": { "type": "string" } + }, + "x-rate-limit-limit": { + "example": 5000, + "schema": { "type": "integer" } + }, + "x-rate-limit-remaining": { + "example": 4999, + "schema": { "type": "integer" } + }, + "x-rate-limit-reset": { + "example": 1590701888, + "schema": { "type": "integer", "format": "timestamp" } + }, + "location": { + "example": "https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D", + "schema": { "type": "string" } + } + } + } +} diff --git a/node_modules/@octokit/openapi-types/generated/types.ts b/node_modules/@octokit/openapi-types/generated/types.ts new file mode 100644 index 0000000..6cd9fe1 --- /dev/null +++ b/node_modules/@octokit/openapi-types/generated/types.ts @@ -0,0 +1,28039 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + "/": { + get: operations["meta/root"]; + }; + "/app": { + get: operations["apps/get-authenticated"]; + }; + "/app-manifests/{code}/conversions": { + post: operations["apps/create-from-manifest"]; + }; + "/app/hook/config": { + get: operations["apps/get-webhook-config-for-app"]; + patch: operations["apps/update-webhook-config-for-app"]; + }; + "/app/installations": { + get: operations["apps/list-installations"]; + }; + "/app/installations/{installation_id}": { + get: operations["apps/get-installation"]; + delete: operations["apps/delete-installation"]; + }; + "/app/installations/{installation_id}/access_tokens": { + post: operations["apps/create-installation-access-token"]; + }; + "/app/installations/{installation_id}/suspended": { + put: operations["apps/suspend-installation"]; + delete: operations["apps/unsuspend-installation"]; + }; + "/applications/grants": { + get: operations["oauth-authorizations/list-grants"]; + }; + "/applications/grants/{grant_id}": { + get: operations["oauth-authorizations/get-grant"]; + delete: operations["oauth-authorizations/delete-grant"]; + }; + "/applications/{client_id}/grant": { + delete: operations["apps/delete-authorization"]; + }; + "/applications/{client_id}/grants/{access_token}": { + delete: operations["apps/revoke-grant-for-application"]; + }; + "/applications/{client_id}/token": { + post: operations["apps/check-token"]; + patch: operations["apps/reset-token"]; + delete: operations["apps/delete-token"]; + }; + "/applications/{client_id}/token/scoped": { + post: operations["apps/scope-token"]; + }; + "/applications/{client_id}/tokens/{access_token}": { + get: operations["apps/check-authorization"]; + post: operations["apps/reset-authorization"]; + delete: operations["apps/revoke-authorization-for-application"]; + }; + "/apps/{app_slug}": { + get: operations["apps/get-by-slug"]; + }; + "/authorizations": { + get: operations["oauth-authorizations/list-authorizations"]; + post: operations["oauth-authorizations/create-authorization"]; + }; + "/authorizations/clients/{client_id}": { + put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; + }; + "/authorizations/clients/{client_id}/{fingerprint}": { + put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; + }; + "/authorizations/{authorization_id}": { + get: operations["oauth-authorizations/get-authorization"]; + patch: operations["oauth-authorizations/update-authorization"]; + delete: operations["oauth-authorizations/delete-authorization"]; + }; + "/codes_of_conduct": { + get: operations["codes-of-conduct/get-all-codes-of-conduct"]; + }; + "/codes_of_conduct/{key}": { + get: operations["codes-of-conduct/get-conduct-code"]; + }; + "/content_references/{content_reference_id}/attachments": { + post: operations["apps/create-content-attachment"]; + }; + "/emojis": { + get: operations["emojis/get"]; + }; + "/enterprises/{enterprise}/actions/permissions": { + get: operations["enterprise-admin/get-github-actions-permissions-enterprise"]; + put: operations["enterprise-admin/set-github-actions-permissions-enterprise"]; + }; + "/enterprises/{enterprise}/actions/permissions/organizations": { + get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"]; + put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"]; + }; + "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"]; + delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"]; + }; + "/enterprises/{enterprise}/actions/permissions/selected-actions": { + get: operations["enterprise-admin/get-allowed-actions-enterprise"]; + put: operations["enterprise-admin/set-allowed-actions-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runner-groups": { + get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; + post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; + patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; + delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; + put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; + delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; + put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; + delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runners": { + get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runners/downloads": { + get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runners/registration-token": { + post: operations["enterprise-admin/create-registration-token-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runners/remove-token": { + post: operations["enterprise-admin/create-remove-token-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runners/{runner_id}": { + get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; + delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; + }; + "/enterprises/{enterprise}/audit-log": { + get: operations["audit-log/get-audit-log"]; + }; + "/enterprises/{enterprise}/settings/billing/actions": { + get: operations["billing/get-github-actions-billing-ghe"]; + }; + "/enterprises/{enterprise}/settings/billing/packages": { + get: operations["billing/get-github-packages-billing-ghe"]; + }; + "/enterprises/{enterprise}/settings/billing/shared-storage": { + get: operations["billing/get-shared-storage-billing-ghe"]; + }; + "/events": { + get: operations["activity/list-public-events"]; + }; + "/feeds": { + get: operations["activity/get-feeds"]; + }; + "/gists": { + get: operations["gists/list"]; + post: operations["gists/create"]; + }; + "/gists/public": { + get: operations["gists/list-public"]; + }; + "/gists/starred": { + get: operations["gists/list-starred"]; + }; + "/gists/{gist_id}": { + get: operations["gists/get"]; + patch: operations["gists/update"]; + delete: operations["gists/delete"]; + }; + "/gists/{gist_id}/comments": { + get: operations["gists/list-comments"]; + post: operations["gists/create-comment"]; + }; + "/gists/{gist_id}/comments/{comment_id}": { + get: operations["gists/get-comment"]; + patch: operations["gists/update-comment"]; + delete: operations["gists/delete-comment"]; + }; + "/gists/{gist_id}/commits": { + get: operations["gists/list-commits"]; + }; + "/gists/{gist_id}/forks": { + get: operations["gists/list-forks"]; + post: operations["gists/fork"]; + }; + "/gists/{gist_id}/star": { + get: operations["gists/check-is-starred"]; + put: operations["gists/star"]; + delete: operations["gists/unstar"]; + }; + "/gists/{gist_id}/{sha}": { + get: operations["gists/get-revision"]; + }; + "/gitignore/templates": { + get: operations["gitignore/get-all-templates"]; + }; + "/gitignore/templates/{name}": { + get: operations["gitignore/get-template"]; + }; + "/installation/repositories": { + get: operations["apps/list-repos-accessible-to-installation"]; + }; + "/installation/token": { + delete: operations["apps/revoke-installation-access-token"]; + }; + "/issues": { + get: operations["issues/list"]; + }; + "/licenses": { + get: operations["licenses/get-all-commonly-used"]; + }; + "/licenses/{license}": { + get: operations["licenses/get"]; + }; + "/markdown": { + post: operations["markdown/render"]; + }; + "/markdown/raw": { + post: operations["markdown/render-raw"]; + }; + "/marketplace_listing/accounts/{account_id}": { + get: operations["apps/get-subscription-plan-for-account"]; + }; + "/marketplace_listing/plans": { + get: operations["apps/list-plans"]; + }; + "/marketplace_listing/plans/{plan_id}/accounts": { + get: operations["apps/list-accounts-for-plan"]; + }; + "/marketplace_listing/stubbed/accounts/{account_id}": { + get: operations["apps/get-subscription-plan-for-account-stubbed"]; + }; + "/marketplace_listing/stubbed/plans": { + get: operations["apps/list-plans-stubbed"]; + }; + "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + get: operations["apps/list-accounts-for-plan-stubbed"]; + }; + "/meta": { + get: operations["meta/get"]; + }; + "/networks/{owner}/{repo}/events": { + get: operations["activity/list-public-events-for-repo-network"]; + }; + "/notifications": { + get: operations["activity/list-notifications-for-authenticated-user"]; + put: operations["activity/mark-notifications-as-read"]; + }; + "/notifications/threads/{thread_id}": { + get: operations["activity/get-thread"]; + patch: operations["activity/mark-thread-as-read"]; + }; + "/notifications/threads/{thread_id}/subscription": { + get: operations["activity/get-thread-subscription-for-authenticated-user"]; + put: operations["activity/set-thread-subscription"]; + delete: operations["activity/delete-thread-subscription"]; + }; + "/octocat": { + get: operations["meta/get-octocat"]; + }; + "/organizations": { + get: operations["orgs/list"]; + }; + "/orgs/{org}": { + get: operations["orgs/get"]; + patch: operations["orgs/update"]; + }; + "/orgs/{org}/actions/permissions": { + get: operations["actions/get-github-actions-permissions-organization"]; + put: operations["actions/set-github-actions-permissions-organization"]; + }; + "/orgs/{org}/actions/permissions/repositories": { + get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; + put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; + }; + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + put: operations["actions/enable-selected-repository-github-actions-organization"]; + delete: operations["actions/disable-selected-repository-github-actions-organization"]; + }; + "/orgs/{org}/actions/permissions/selected-actions": { + get: operations["actions/get-allowed-actions-organization"]; + put: operations["actions/set-allowed-actions-organization"]; + }; + "/orgs/{org}/actions/runner-groups": { + get: operations["actions/list-self-hosted-runner-groups-for-org"]; + post: operations["actions/create-self-hosted-runner-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + get: operations["actions/get-self-hosted-runner-group-for-org"]; + patch: operations["actions/update-self-hosted-runner-group-for-org"]; + delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + }; + "/orgs/{org}/actions/runners": { + get: operations["actions/list-self-hosted-runners-for-org"]; + }; + "/orgs/{org}/actions/runners/downloads": { + get: operations["actions/list-runner-applications-for-org"]; + }; + "/orgs/{org}/actions/runners/registration-token": { + post: operations["actions/create-registration-token-for-org"]; + }; + "/orgs/{org}/actions/runners/remove-token": { + post: operations["actions/create-remove-token-for-org"]; + }; + "/orgs/{org}/actions/runners/{runner_id}": { + get: operations["actions/get-self-hosted-runner-for-org"]; + delete: operations["actions/delete-self-hosted-runner-from-org"]; + }; + "/orgs/{org}/actions/secrets": { + get: operations["actions/list-org-secrets"]; + }; + "/orgs/{org}/actions/secrets/public-key": { + get: operations["actions/get-org-public-key"]; + }; + "/orgs/{org}/actions/secrets/{secret_name}": { + get: operations["actions/get-org-secret"]; + put: operations["actions/create-or-update-org-secret"]; + delete: operations["actions/delete-org-secret"]; + }; + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + get: operations["actions/list-selected-repos-for-org-secret"]; + put: operations["actions/set-selected-repos-for-org-secret"]; + }; + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + put: operations["actions/add-selected-repo-to-org-secret"]; + delete: operations["actions/remove-selected-repo-from-org-secret"]; + }; + "/orgs/{org}/audit-log": { + get: operations["orgs/get-audit-log"]; + }; + "/orgs/{org}/blocks": { + get: operations["orgs/list-blocked-users"]; + }; + "/orgs/{org}/blocks/{username}": { + get: operations["orgs/check-blocked-user"]; + put: operations["orgs/block-user"]; + delete: operations["orgs/unblock-user"]; + }; + "/orgs/{org}/credential-authorizations": { + get: operations["orgs/list-saml-sso-authorizations"]; + }; + "/orgs/{org}/credential-authorizations/{credential_id}": { + delete: operations["orgs/remove-saml-sso-authorization"]; + }; + "/orgs/{org}/events": { + get: operations["activity/list-public-org-events"]; + }; + "/orgs/{org}/hooks": { + get: operations["orgs/list-webhooks"]; + post: operations["orgs/create-webhook"]; + }; + "/orgs/{org}/hooks/{hook_id}": { + get: operations["orgs/get-webhook"]; + patch: operations["orgs/update-webhook"]; + delete: operations["orgs/delete-webhook"]; + }; + "/orgs/{org}/hooks/{hook_id}/config": { + get: operations["orgs/get-webhook-config-for-org"]; + patch: operations["orgs/update-webhook-config-for-org"]; + }; + "/orgs/{org}/hooks/{hook_id}/pings": { + post: operations["orgs/ping-webhook"]; + }; + "/orgs/{org}/installation": { + get: operations["apps/get-org-installation"]; + }; + "/orgs/{org}/installations": { + get: operations["orgs/list-app-installations"]; + }; + "/orgs/{org}/interaction-limits": { + get: operations["interactions/get-restrictions-for-org"]; + put: operations["interactions/set-restrictions-for-org"]; + delete: operations["interactions/remove-restrictions-for-org"]; + }; + "/orgs/{org}/invitations": { + get: operations["orgs/list-pending-invitations"]; + post: operations["orgs/create-invitation"]; + }; + "/orgs/{org}/invitations/{invitation_id}/teams": { + get: operations["orgs/list-invitation-teams"]; + }; + "/orgs/{org}/issues": { + get: operations["issues/list-for-org"]; + }; + "/orgs/{org}/members": { + get: operations["orgs/list-members"]; + }; + "/orgs/{org}/members/{username}": { + get: operations["orgs/check-membership-for-user"]; + delete: operations["orgs/remove-member"]; + }; + "/orgs/{org}/memberships/{username}": { + get: operations["orgs/get-membership-for-user"]; + put: operations["orgs/set-membership-for-user"]; + delete: operations["orgs/remove-membership-for-user"]; + }; + "/orgs/{org}/migrations": { + get: operations["migrations/list-for-org"]; + post: operations["migrations/start-for-org"]; + }; + "/orgs/{org}/migrations/{migration_id}": { + get: operations["migrations/get-status-for-org"]; + }; + "/orgs/{org}/migrations/{migration_id}/archive": { + get: operations["migrations/download-archive-for-org"]; + delete: operations["migrations/delete-archive-for-org"]; + }; + "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + delete: operations["migrations/unlock-repo-for-org"]; + }; + "/orgs/{org}/migrations/{migration_id}/repositories": { + get: operations["migrations/list-repos-for-org"]; + }; + "/orgs/{org}/outside_collaborators": { + get: operations["orgs/list-outside-collaborators"]; + }; + "/orgs/{org}/outside_collaborators/{username}": { + put: operations["orgs/convert-member-to-outside-collaborator"]; + delete: operations["orgs/remove-outside-collaborator"]; + }; + "/orgs/{org}/projects": { + get: operations["projects/list-for-org"]; + post: operations["projects/create-for-org"]; + }; + "/orgs/{org}/public_members": { + get: operations["orgs/list-public-members"]; + }; + "/orgs/{org}/public_members/{username}": { + get: operations["orgs/check-public-membership-for-user"]; + put: operations["orgs/set-public-membership-for-authenticated-user"]; + delete: operations["orgs/remove-public-membership-for-authenticated-user"]; + }; + "/orgs/{org}/repos": { + get: operations["repos/list-for-org"]; + post: operations["repos/create-in-org"]; + }; + "/orgs/{org}/settings/billing/actions": { + get: operations["billing/get-github-actions-billing-org"]; + }; + "/orgs/{org}/settings/billing/packages": { + get: operations["billing/get-github-packages-billing-org"]; + }; + "/orgs/{org}/settings/billing/shared-storage": { + get: operations["billing/get-shared-storage-billing-org"]; + }; + "/orgs/{org}/team-sync/groups": { + get: operations["teams/list-idp-groups-for-org"]; + }; + "/orgs/{org}/teams": { + get: operations["teams/list"]; + post: operations["teams/create"]; + }; + "/orgs/{org}/teams/{team_slug}": { + get: operations["teams/get-by-name"]; + patch: operations["teams/update-in-org"]; + delete: operations["teams/delete-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions": { + get: operations["teams/list-discussions-in-org"]; + post: operations["teams/create-discussion-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + get: operations["teams/get-discussion-in-org"]; + patch: operations["teams/update-discussion-in-org"]; + delete: operations["teams/delete-discussion-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + get: operations["teams/list-discussion-comments-in-org"]; + post: operations["teams/create-discussion-comment-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + get: operations["teams/get-discussion-comment-in-org"]; + patch: operations["teams/update-discussion-comment-in-org"]; + delete: operations["teams/delete-discussion-comment-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + get: operations["reactions/list-for-team-discussion-comment-in-org"]; + post: operations["reactions/create-for-team-discussion-comment-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + delete: operations["reactions/delete-for-team-discussion-comment"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + get: operations["reactions/list-for-team-discussion-in-org"]; + post: operations["reactions/create-for-team-discussion-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + delete: operations["reactions/delete-for-team-discussion"]; + }; + "/orgs/{org}/teams/{team_slug}/invitations": { + get: operations["teams/list-pending-invitations-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/members": { + get: operations["teams/list-members-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + get: operations["teams/get-membership-for-user-in-org"]; + put: operations["teams/add-or-update-membership-for-user-in-org"]; + delete: operations["teams/remove-membership-for-user-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/projects": { + get: operations["teams/list-projects-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + get: operations["teams/check-permissions-for-project-in-org"]; + put: operations["teams/add-or-update-project-permissions-in-org"]; + delete: operations["teams/remove-project-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/repos": { + get: operations["teams/list-repos-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + get: operations["teams/check-permissions-for-repo-in-org"]; + put: operations["teams/add-or-update-repo-permissions-in-org"]; + delete: operations["teams/remove-repo-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { + get: operations["teams/list-idp-groups-in-org"]; + patch: operations["teams/create-or-update-idp-group-connections-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/teams": { + get: operations["teams/list-child-in-org"]; + }; + "/projects/columns/cards/{card_id}": { + get: operations["projects/get-card"]; + patch: operations["projects/update-card"]; + delete: operations["projects/delete-card"]; + }; + "/projects/columns/cards/{card_id}/moves": { + post: operations["projects/move-card"]; + }; + "/projects/columns/{column_id}": { + get: operations["projects/get-column"]; + patch: operations["projects/update-column"]; + delete: operations["projects/delete-column"]; + }; + "/projects/columns/{column_id}/cards": { + get: operations["projects/list-cards"]; + post: operations["projects/create-card"]; + }; + "/projects/columns/{column_id}/moves": { + post: operations["projects/move-column"]; + }; + "/projects/{project_id}": { + get: operations["projects/get"]; + patch: operations["projects/update"]; + delete: operations["projects/delete"]; + }; + "/projects/{project_id}/collaborators": { + get: operations["projects/list-collaborators"]; + }; + "/projects/{project_id}/collaborators/{username}": { + put: operations["projects/add-collaborator"]; + delete: operations["projects/remove-collaborator"]; + }; + "/projects/{project_id}/collaborators/{username}/permission": { + get: operations["projects/get-permission-for-user"]; + }; + "/projects/{project_id}/columns": { + get: operations["projects/list-columns"]; + post: operations["projects/create-column"]; + }; + "/rate_limit": { + get: operations["rate-limit/get"]; + }; + "/reactions/{reaction_id}": { + delete: operations["reactions/delete-legacy"]; + }; + "/repos/{owner}/{repo}": { + get: operations["repos/get"]; + patch: operations["repos/update"]; + delete: operations["repos/delete"]; + }; + "/repos/{owner}/{repo}/actions/artifacts": { + get: operations["actions/list-artifacts-for-repo"]; + }; + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + get: operations["actions/get-artifact"]; + delete: operations["actions/delete-artifact"]; + }; + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + get: operations["actions/download-artifact"]; + }; + "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + get: operations["actions/get-job-for-workflow-run"]; + }; + "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + get: operations["actions/download-job-logs-for-workflow-run"]; + }; + "/repos/{owner}/{repo}/actions/permissions": { + get: operations["actions/get-github-actions-permissions-repository"]; + put: operations["actions/set-github-actions-permissions-repository"]; + }; + "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + get: operations["actions/get-allowed-actions-repository"]; + put: operations["actions/set-allowed-actions-repository"]; + }; + "/repos/{owner}/{repo}/actions/runners": { + get: operations["actions/list-self-hosted-runners-for-repo"]; + }; + "/repos/{owner}/{repo}/actions/runners/downloads": { + get: operations["actions/list-runner-applications-for-repo"]; + }; + "/repos/{owner}/{repo}/actions/runners/registration-token": { + post: operations["actions/create-registration-token-for-repo"]; + }; + "/repos/{owner}/{repo}/actions/runners/remove-token": { + post: operations["actions/create-remove-token-for-repo"]; + }; + "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + get: operations["actions/get-self-hosted-runner-for-repo"]; + delete: operations["actions/delete-self-hosted-runner-from-repo"]; + }; + "/repos/{owner}/{repo}/actions/runs": { + get: operations["actions/list-workflow-runs-for-repo"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}": { + get: operations["actions/get-workflow-run"]; + delete: operations["actions/delete-workflow-run"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + get: operations["actions/list-workflow-run-artifacts"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + post: operations["actions/cancel-workflow-run"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + get: operations["actions/list-jobs-for-workflow-run"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + get: operations["actions/download-workflow-run-logs"]; + delete: operations["actions/delete-workflow-run-logs"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + post: operations["actions/re-run-workflow"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + get: operations["actions/get-workflow-run-usage"]; + }; + "/repos/{owner}/{repo}/actions/secrets": { + get: operations["actions/list-repo-secrets"]; + }; + "/repos/{owner}/{repo}/actions/secrets/public-key": { + get: operations["actions/get-repo-public-key"]; + }; + "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + get: operations["actions/get-repo-secret"]; + put: operations["actions/create-or-update-repo-secret"]; + delete: operations["actions/delete-repo-secret"]; + }; + "/repos/{owner}/{repo}/actions/workflows": { + get: operations["actions/list-repo-workflows"]; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + get: operations["actions/get-workflow"]; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + put: operations["actions/disable-workflow"]; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + post: operations["actions/create-workflow-dispatch"]; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + put: operations["actions/enable-workflow"]; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + get: operations["actions/list-workflow-runs"]; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + get: operations["actions/get-workflow-usage"]; + }; + "/repos/{owner}/{repo}/assignees": { + get: operations["issues/list-assignees"]; + }; + "/repos/{owner}/{repo}/assignees/{assignee}": { + get: operations["issues/check-user-can-be-assigned"]; + }; + "/repos/{owner}/{repo}/automated-security-fixes": { + put: operations["repos/enable-automated-security-fixes"]; + delete: operations["repos/disable-automated-security-fixes"]; + }; + "/repos/{owner}/{repo}/branches": { + get: operations["repos/list-branches"]; + }; + "/repos/{owner}/{repo}/branches/{branch}": { + get: operations["repos/get-branch"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection": { + get: operations["repos/get-branch-protection"]; + put: operations["repos/update-branch-protection"]; + delete: operations["repos/delete-branch-protection"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + get: operations["repos/get-admin-branch-protection"]; + post: operations["repos/set-admin-branch-protection"]; + delete: operations["repos/delete-admin-branch-protection"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + get: operations["repos/get-pull-request-review-protection"]; + patch: operations["repos/update-pull-request-review-protection"]; + delete: operations["repos/delete-pull-request-review-protection"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + get: operations["repos/get-commit-signature-protection"]; + post: operations["repos/create-commit-signature-protection"]; + delete: operations["repos/delete-commit-signature-protection"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + get: operations["repos/get-status-checks-protection"]; + patch: operations["repos/update-status-check-protection"]; + delete: operations["repos/remove-status-check-protection"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + get: operations["repos/get-all-status-check-contexts"]; + post: operations["repos/add-status-check-contexts"]; + put: operations["repos/set-status-check-contexts"]; + delete: operations["repos/remove-status-check-contexts"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + get: operations["repos/get-access-restrictions"]; + delete: operations["repos/delete-access-restrictions"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + get: operations["repos/get-apps-with-access-to-protected-branch"]; + post: operations["repos/add-app-access-restrictions"]; + put: operations["repos/set-app-access-restrictions"]; + delete: operations["repos/remove-app-access-restrictions"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + get: operations["repos/get-teams-with-access-to-protected-branch"]; + post: operations["repos/add-team-access-restrictions"]; + put: operations["repos/set-team-access-restrictions"]; + delete: operations["repos/remove-team-access-restrictions"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + get: operations["repos/get-users-with-access-to-protected-branch"]; + post: operations["repos/add-user-access-restrictions"]; + put: operations["repos/set-user-access-restrictions"]; + delete: operations["repos/remove-user-access-restrictions"]; + }; + "/repos/{owner}/{repo}/check-runs": { + post: operations["checks/create"]; + }; + "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + get: operations["checks/get"]; + patch: operations["checks/update"]; + }; + "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + get: operations["checks/list-annotations"]; + }; + "/repos/{owner}/{repo}/check-suites": { + post: operations["checks/create-suite"]; + }; + "/repos/{owner}/{repo}/check-suites/preferences": { + patch: operations["checks/set-suites-preferences"]; + }; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + get: operations["checks/get-suite"]; + }; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + get: operations["checks/list-for-suite"]; + }; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + post: operations["checks/rerequest-suite"]; + }; + "/repos/{owner}/{repo}/code-scanning/alerts": { + get: operations["code-scanning/list-alerts-for-repo"]; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + get: operations["code-scanning/get-alert"]; + patch: operations["code-scanning/update-alert"]; + }; + "/repos/{owner}/{repo}/code-scanning/analyses": { + get: operations["code-scanning/list-recent-analyses"]; + }; + "/repos/{owner}/{repo}/code-scanning/sarifs": { + post: operations["code-scanning/upload-sarif"]; + }; + "/repos/{owner}/{repo}/collaborators": { + get: operations["repos/list-collaborators"]; + }; + "/repos/{owner}/{repo}/collaborators/{username}": { + get: operations["repos/check-collaborator"]; + put: operations["repos/add-collaborator"]; + delete: operations["repos/remove-collaborator"]; + }; + "/repos/{owner}/{repo}/collaborators/{username}/permission": { + get: operations["repos/get-collaborator-permission-level"]; + }; + "/repos/{owner}/{repo}/comments": { + get: operations["repos/list-commit-comments-for-repo"]; + }; + "/repos/{owner}/{repo}/comments/{comment_id}": { + get: operations["repos/get-commit-comment"]; + patch: operations["repos/update-commit-comment"]; + delete: operations["repos/delete-commit-comment"]; + }; + "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + get: operations["reactions/list-for-commit-comment"]; + post: operations["reactions/create-for-commit-comment"]; + }; + "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + delete: operations["reactions/delete-for-commit-comment"]; + }; + "/repos/{owner}/{repo}/commits": { + get: operations["repos/list-commits"]; + }; + "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + get: operations["repos/list-branches-for-head-commit"]; + }; + "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + get: operations["repos/list-comments-for-commit"]; + post: operations["repos/create-commit-comment"]; + }; + "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + get: operations["repos/list-pull-requests-associated-with-commit"]; + }; + "/repos/{owner}/{repo}/commits/{ref}": { + get: operations["repos/get-commit"]; + }; + "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + get: operations["checks/list-for-ref"]; + }; + "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + get: operations["checks/list-suites-for-ref"]; + }; + "/repos/{owner}/{repo}/commits/{ref}/status": { + get: operations["repos/get-combined-status-for-ref"]; + }; + "/repos/{owner}/{repo}/commits/{ref}/statuses": { + get: operations["repos/list-commit-statuses-for-ref"]; + }; + "/repos/{owner}/{repo}/community/code_of_conduct": { + get: operations["codes-of-conduct/get-for-repo"]; + }; + "/repos/{owner}/{repo}/community/profile": { + get: operations["repos/get-community-profile-metrics"]; + }; + "/repos/{owner}/{repo}/compare/{base}...{head}": { + get: operations["repos/compare-commits"]; + }; + "/repos/{owner}/{repo}/contents/{path}": { + get: operations["repos/get-content"]; + put: operations["repos/create-or-update-file-contents"]; + delete: operations["repos/delete-file"]; + }; + "/repos/{owner}/{repo}/contributors": { + get: operations["repos/list-contributors"]; + }; + "/repos/{owner}/{repo}/deployments": { + get: operations["repos/list-deployments"]; + post: operations["repos/create-deployment"]; + }; + "/repos/{owner}/{repo}/deployments/{deployment_id}": { + get: operations["repos/get-deployment"]; + delete: operations["repos/delete-deployment"]; + }; + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + get: operations["repos/list-deployment-statuses"]; + post: operations["repos/create-deployment-status"]; + }; + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + get: operations["repos/get-deployment-status"]; + }; + "/repos/{owner}/{repo}/dispatches": { + post: operations["repos/create-dispatch-event"]; + }; + "/repos/{owner}/{repo}/events": { + get: operations["activity/list-repo-events"]; + }; + "/repos/{owner}/{repo}/forks": { + get: operations["repos/list-forks"]; + post: operations["repos/create-fork"]; + }; + "/repos/{owner}/{repo}/git/blobs": { + post: operations["git/create-blob"]; + }; + "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + get: operations["git/get-blob"]; + }; + "/repos/{owner}/{repo}/git/commits": { + post: operations["git/create-commit"]; + }; + "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + get: operations["git/get-commit"]; + }; + "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + get: operations["git/list-matching-refs"]; + }; + "/repos/{owner}/{repo}/git/ref/{ref}": { + get: operations["git/get-ref"]; + }; + "/repos/{owner}/{repo}/git/refs": { + post: operations["git/create-ref"]; + }; + "/repos/{owner}/{repo}/git/refs/{ref}": { + patch: operations["git/update-ref"]; + delete: operations["git/delete-ref"]; + }; + "/repos/{owner}/{repo}/git/tags": { + post: operations["git/create-tag"]; + }; + "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + get: operations["git/get-tag"]; + }; + "/repos/{owner}/{repo}/git/trees": { + post: operations["git/create-tree"]; + }; + "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + get: operations["git/get-tree"]; + }; + "/repos/{owner}/{repo}/hooks": { + get: operations["repos/list-webhooks"]; + post: operations["repos/create-webhook"]; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}": { + get: operations["repos/get-webhook"]; + patch: operations["repos/update-webhook"]; + delete: operations["repos/delete-webhook"]; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + get: operations["repos/get-webhook-config-for-repo"]; + patch: operations["repos/update-webhook-config-for-repo"]; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + post: operations["repos/ping-webhook"]; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + post: operations["repos/test-push-webhook"]; + }; + "/repos/{owner}/{repo}/import": { + get: operations["migrations/get-import-status"]; + put: operations["migrations/start-import"]; + patch: operations["migrations/update-import"]; + delete: operations["migrations/cancel-import"]; + }; + "/repos/{owner}/{repo}/import/authors": { + get: operations["migrations/get-commit-authors"]; + }; + "/repos/{owner}/{repo}/import/authors/{author_id}": { + patch: operations["migrations/map-commit-author"]; + }; + "/repos/{owner}/{repo}/import/large_files": { + get: operations["migrations/get-large-files"]; + }; + "/repos/{owner}/{repo}/import/lfs": { + patch: operations["migrations/set-lfs-preference"]; + }; + "/repos/{owner}/{repo}/installation": { + get: operations["apps/get-repo-installation"]; + }; + "/repos/{owner}/{repo}/interaction-limits": { + get: operations["interactions/get-restrictions-for-repo"]; + put: operations["interactions/set-restrictions-for-repo"]; + delete: operations["interactions/remove-restrictions-for-repo"]; + }; + "/repos/{owner}/{repo}/invitations": { + get: operations["repos/list-invitations"]; + }; + "/repos/{owner}/{repo}/invitations/{invitation_id}": { + patch: operations["repos/update-invitation"]; + delete: operations["repos/delete-invitation"]; + }; + "/repos/{owner}/{repo}/issues": { + get: operations["issues/list-for-repo"]; + post: operations["issues/create"]; + }; + "/repos/{owner}/{repo}/issues/comments": { + get: operations["issues/list-comments-for-repo"]; + }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + get: operations["issues/get-comment"]; + patch: operations["issues/update-comment"]; + delete: operations["issues/delete-comment"]; + }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + get: operations["reactions/list-for-issue-comment"]; + post: operations["reactions/create-for-issue-comment"]; + }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + delete: operations["reactions/delete-for-issue-comment"]; + }; + "/repos/{owner}/{repo}/issues/events": { + get: operations["issues/list-events-for-repo"]; + }; + "/repos/{owner}/{repo}/issues/events/{event_id}": { + get: operations["issues/get-event"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}": { + get: operations["issues/get"]; + patch: operations["issues/update"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + post: operations["issues/add-assignees"]; + delete: operations["issues/remove-assignees"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + get: operations["issues/list-comments"]; + post: operations["issues/create-comment"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/events": { + get: operations["issues/list-events"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + get: operations["issues/list-labels-on-issue"]; + post: operations["issues/add-labels"]; + put: operations["issues/set-labels"]; + delete: operations["issues/remove-all-labels"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + delete: operations["issues/remove-label"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + put: operations["issues/lock"]; + delete: operations["issues/unlock"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + get: operations["reactions/list-for-issue"]; + post: operations["reactions/create-for-issue"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + delete: operations["reactions/delete-for-issue"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + get: operations["issues/list-events-for-timeline"]; + }; + "/repos/{owner}/{repo}/keys": { + get: operations["repos/list-deploy-keys"]; + post: operations["repos/create-deploy-key"]; + }; + "/repos/{owner}/{repo}/keys/{key_id}": { + get: operations["repos/get-deploy-key"]; + delete: operations["repos/delete-deploy-key"]; + }; + "/repos/{owner}/{repo}/labels": { + get: operations["issues/list-labels-for-repo"]; + post: operations["issues/create-label"]; + }; + "/repos/{owner}/{repo}/labels/{name}": { + get: operations["issues/get-label"]; + patch: operations["issues/update-label"]; + delete: operations["issues/delete-label"]; + }; + "/repos/{owner}/{repo}/languages": { + get: operations["repos/list-languages"]; + }; + "/repos/{owner}/{repo}/license": { + get: operations["licenses/get-for-repo"]; + }; + "/repos/{owner}/{repo}/merges": { + post: operations["repos/merge"]; + }; + "/repos/{owner}/{repo}/milestones": { + get: operations["issues/list-milestones"]; + post: operations["issues/create-milestone"]; + }; + "/repos/{owner}/{repo}/milestones/{milestone_number}": { + get: operations["issues/get-milestone"]; + patch: operations["issues/update-milestone"]; + delete: operations["issues/delete-milestone"]; + }; + "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + get: operations["issues/list-labels-for-milestone"]; + }; + "/repos/{owner}/{repo}/notifications": { + get: operations["activity/list-repo-notifications-for-authenticated-user"]; + put: operations["activity/mark-repo-notifications-as-read"]; + }; + "/repos/{owner}/{repo}/pages": { + get: operations["repos/get-pages"]; + post: operations["repos/create-pages-site"]; + put: operations["repos/update-information-about-pages-site"]; + delete: operations["repos/delete-pages-site"]; + }; + "/repos/{owner}/{repo}/pages/builds": { + get: operations["repos/list-pages-builds"]; + post: operations["repos/request-pages-build"]; + }; + "/repos/{owner}/{repo}/pages/builds/latest": { + get: operations["repos/get-latest-pages-build"]; + }; + "/repos/{owner}/{repo}/pages/builds/{build_id}": { + get: operations["repos/get-pages-build"]; + }; + "/repos/{owner}/{repo}/projects": { + get: operations["projects/list-for-repo"]; + post: operations["projects/create-for-repo"]; + }; + "/repos/{owner}/{repo}/pulls": { + get: operations["pulls/list"]; + post: operations["pulls/create"]; + }; + "/repos/{owner}/{repo}/pulls/comments": { + get: operations["pulls/list-review-comments-for-repo"]; + }; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + get: operations["pulls/get-review-comment"]; + patch: operations["pulls/update-review-comment"]; + delete: operations["pulls/delete-review-comment"]; + }; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + get: operations["reactions/list-for-pull-request-review-comment"]; + post: operations["reactions/create-for-pull-request-review-comment"]; + }; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + delete: operations["reactions/delete-for-pull-request-comment"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}": { + get: operations["pulls/get"]; + patch: operations["pulls/update"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + get: operations["pulls/list-review-comments"]; + post: operations["pulls/create-review-comment"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + post: operations["pulls/create-reply-for-review-comment"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + get: operations["pulls/list-commits"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + get: operations["pulls/list-files"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + get: operations["pulls/check-if-merged"]; + put: operations["pulls/merge"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + get: operations["pulls/list-requested-reviewers"]; + post: operations["pulls/request-reviewers"]; + delete: operations["pulls/remove-requested-reviewers"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + get: operations["pulls/list-reviews"]; + post: operations["pulls/create-review"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + get: operations["pulls/get-review"]; + put: operations["pulls/update-review"]; + delete: operations["pulls/delete-pending-review"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + get: operations["pulls/list-comments-for-review"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + put: operations["pulls/dismiss-review"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + post: operations["pulls/submit-review"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + put: operations["pulls/update-branch"]; + }; + "/repos/{owner}/{repo}/readme": { + get: operations["repos/get-readme"]; + }; + "/repos/{owner}/{repo}/releases": { + get: operations["repos/list-releases"]; + post: operations["repos/create-release"]; + }; + "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + get: operations["repos/get-release-asset"]; + patch: operations["repos/update-release-asset"]; + delete: operations["repos/delete-release-asset"]; + }; + "/repos/{owner}/{repo}/releases/latest": { + get: operations["repos/get-latest-release"]; + }; + "/repos/{owner}/{repo}/releases/tags/{tag}": { + get: operations["repos/get-release-by-tag"]; + }; + "/repos/{owner}/{repo}/releases/{release_id}": { + get: operations["repos/get-release"]; + patch: operations["repos/update-release"]; + delete: operations["repos/delete-release"]; + }; + "/repos/{owner}/{repo}/releases/{release_id}/assets": { + get: operations["repos/list-release-assets"]; + post: operations["repos/upload-release-asset"]; + }; + "/repos/{owner}/{repo}/secret-scanning/alerts": { + get: operations["secret-scanning/list-alerts-for-repo"]; + }; + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + get: operations["secret-scanning/get-alert"]; + patch: operations["secret-scanning/update-alert"]; + }; + "/repos/{owner}/{repo}/stargazers": { + get: operations["activity/list-stargazers-for-repo"]; + }; + "/repos/{owner}/{repo}/stats/code_frequency": { + get: operations["repos/get-code-frequency-stats"]; + }; + "/repos/{owner}/{repo}/stats/commit_activity": { + get: operations["repos/get-commit-activity-stats"]; + }; + "/repos/{owner}/{repo}/stats/contributors": { + get: operations["repos/get-contributors-stats"]; + }; + "/repos/{owner}/{repo}/stats/participation": { + get: operations["repos/get-participation-stats"]; + }; + "/repos/{owner}/{repo}/stats/punch_card": { + get: operations["repos/get-punch-card-stats"]; + }; + "/repos/{owner}/{repo}/statuses/{sha}": { + post: operations["repos/create-commit-status"]; + }; + "/repos/{owner}/{repo}/subscribers": { + get: operations["activity/list-watchers-for-repo"]; + }; + "/repos/{owner}/{repo}/subscription": { + get: operations["activity/get-repo-subscription"]; + put: operations["activity/set-repo-subscription"]; + delete: operations["activity/delete-repo-subscription"]; + }; + "/repos/{owner}/{repo}/tags": { + get: operations["repos/list-tags"]; + }; + "/repos/{owner}/{repo}/tarball/{ref}": { + get: operations["repos/download-tarball-archive"]; + }; + "/repos/{owner}/{repo}/teams": { + get: operations["repos/list-teams"]; + }; + "/repos/{owner}/{repo}/topics": { + get: operations["repos/get-all-topics"]; + put: operations["repos/replace-all-topics"]; + }; + "/repos/{owner}/{repo}/traffic/clones": { + get: operations["repos/get-clones"]; + }; + "/repos/{owner}/{repo}/traffic/popular/paths": { + get: operations["repos/get-top-paths"]; + }; + "/repos/{owner}/{repo}/traffic/popular/referrers": { + get: operations["repos/get-top-referrers"]; + }; + "/repos/{owner}/{repo}/traffic/views": { + get: operations["repos/get-views"]; + }; + "/repos/{owner}/{repo}/transfer": { + post: operations["repos/transfer"]; + }; + "/repos/{owner}/{repo}/vulnerability-alerts": { + get: operations["repos/check-vulnerability-alerts"]; + put: operations["repos/enable-vulnerability-alerts"]; + delete: operations["repos/disable-vulnerability-alerts"]; + }; + "/repos/{owner}/{repo}/zipball/{ref}": { + get: operations["repos/download-zipball-archive"]; + }; + "/repos/{template_owner}/{template_repo}/generate": { + post: operations["repos/create-using-template"]; + }; + "/repositories": { + get: operations["repos/list-public"]; + }; + "/scim/v2/enterprises/{enterprise}/Groups": { + get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; + post: operations["enterprise-admin/provision-and-invite-enterprise-group"]; + }; + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; + put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; + patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; + delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; + }; + "/scim/v2/enterprises/{enterprise}/Users": { + get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; + post: operations["enterprise-admin/provision-and-invite-enterprise-user"]; + }; + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; + put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; + patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; + delete: operations["enterprise-admin/delete-user-from-enterprise"]; + }; + "/scim/v2/organizations/{org}/Users": { + get: operations["scim/list-provisioned-identities"]; + post: operations["scim/provision-and-invite-user"]; + }; + "/scim/v2/organizations/{org}/Users/{scim_user_id}": { + get: operations["scim/get-provisioning-information-for-user"]; + put: operations["scim/set-information-for-provisioned-user"]; + patch: operations["scim/update-attribute-for-user"]; + delete: operations["scim/delete-user-from-org"]; + }; + "/search/code": { + get: operations["search/code"]; + }; + "/search/commits": { + get: operations["search/commits"]; + }; + "/search/issues": { + get: operations["search/issues-and-pull-requests"]; + }; + "/search/labels": { + get: operations["search/labels"]; + }; + "/search/repositories": { + get: operations["search/repos"]; + }; + "/search/topics": { + get: operations["search/topics"]; + }; + "/search/users": { + get: operations["search/users"]; + }; + "/teams/{team_id}": { + get: operations["teams/get-legacy"]; + patch: operations["teams/update-legacy"]; + delete: operations["teams/delete-legacy"]; + }; + "/teams/{team_id}/discussions": { + get: operations["teams/list-discussions-legacy"]; + post: operations["teams/create-discussion-legacy"]; + }; + "/teams/{team_id}/discussions/{discussion_number}": { + get: operations["teams/get-discussion-legacy"]; + patch: operations["teams/update-discussion-legacy"]; + delete: operations["teams/delete-discussion-legacy"]; + }; + "/teams/{team_id}/discussions/{discussion_number}/comments": { + get: operations["teams/list-discussion-comments-legacy"]; + post: operations["teams/create-discussion-comment-legacy"]; + }; + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + get: operations["teams/get-discussion-comment-legacy"]; + patch: operations["teams/update-discussion-comment-legacy"]; + delete: operations["teams/delete-discussion-comment-legacy"]; + }; + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + get: operations["reactions/list-for-team-discussion-comment-legacy"]; + post: operations["reactions/create-for-team-discussion-comment-legacy"]; + }; + "/teams/{team_id}/discussions/{discussion_number}/reactions": { + get: operations["reactions/list-for-team-discussion-legacy"]; + post: operations["reactions/create-for-team-discussion-legacy"]; + }; + "/teams/{team_id}/invitations": { + get: operations["teams/list-pending-invitations-legacy"]; + }; + "/teams/{team_id}/members": { + get: operations["teams/list-members-legacy"]; + }; + "/teams/{team_id}/members/{username}": { + get: operations["teams/get-member-legacy"]; + put: operations["teams/add-member-legacy"]; + delete: operations["teams/remove-member-legacy"]; + }; + "/teams/{team_id}/memberships/{username}": { + get: operations["teams/get-membership-for-user-legacy"]; + put: operations["teams/add-or-update-membership-for-user-legacy"]; + delete: operations["teams/remove-membership-for-user-legacy"]; + }; + "/teams/{team_id}/projects": { + get: operations["teams/list-projects-legacy"]; + }; + "/teams/{team_id}/projects/{project_id}": { + get: operations["teams/check-permissions-for-project-legacy"]; + put: operations["teams/add-or-update-project-permissions-legacy"]; + delete: operations["teams/remove-project-legacy"]; + }; + "/teams/{team_id}/repos": { + get: operations["teams/list-repos-legacy"]; + }; + "/teams/{team_id}/repos/{owner}/{repo}": { + get: operations["teams/check-permissions-for-repo-legacy"]; + put: operations["teams/add-or-update-repo-permissions-legacy"]; + delete: operations["teams/remove-repo-legacy"]; + }; + "/teams/{team_id}/team-sync/group-mappings": { + get: operations["teams/list-idp-groups-for-legacy"]; + patch: operations["teams/create-or-update-idp-group-connections-legacy"]; + }; + "/teams/{team_id}/teams": { + get: operations["teams/list-child-legacy"]; + }; + "/user": { + get: operations["users/get-authenticated"]; + patch: operations["users/update-authenticated"]; + }; + "/user/blocks": { + get: operations["users/list-blocked-by-authenticated"]; + }; + "/user/blocks/{username}": { + get: operations["users/check-blocked"]; + put: operations["users/block"]; + delete: operations["users/unblock"]; + }; + "/user/email/visibility": { + patch: operations["users/set-primary-email-visibility-for-authenticated"]; + }; + "/user/emails": { + get: operations["users/list-emails-for-authenticated"]; + post: operations["users/add-email-for-authenticated"]; + delete: operations["users/delete-email-for-authenticated"]; + }; + "/user/followers": { + get: operations["users/list-followers-for-authenticated-user"]; + }; + "/user/following": { + get: operations["users/list-followed-by-authenticated"]; + }; + "/user/following/{username}": { + get: operations["users/check-person-is-followed-by-authenticated"]; + put: operations["users/follow"]; + delete: operations["users/unfollow"]; + }; + "/user/gpg_keys": { + get: operations["users/list-gpg-keys-for-authenticated"]; + post: operations["users/create-gpg-key-for-authenticated"]; + }; + "/user/gpg_keys/{gpg_key_id}": { + get: operations["users/get-gpg-key-for-authenticated"]; + delete: operations["users/delete-gpg-key-for-authenticated"]; + }; + "/user/installations": { + get: operations["apps/list-installations-for-authenticated-user"]; + }; + "/user/installations/{installation_id}/repositories": { + get: operations["apps/list-installation-repos-for-authenticated-user"]; + }; + "/user/installations/{installation_id}/repositories/{repository_id}": { + put: operations["apps/add-repo-to-installation"]; + delete: operations["apps/remove-repo-from-installation"]; + }; + "/user/interaction-limits": { + get: operations["interactions/get-restrictions-for-your-public-repos"]; + put: operations["interactions/set-restrictions-for-your-public-repos"]; + delete: operations["interactions/remove-restrictions-for-your-public-repos"]; + }; + "/user/issues": { + get: operations["issues/list-for-authenticated-user"]; + }; + "/user/keys": { + get: operations["users/list-public-ssh-keys-for-authenticated"]; + post: operations["users/create-public-ssh-key-for-authenticated"]; + }; + "/user/keys/{key_id}": { + get: operations["users/get-public-ssh-key-for-authenticated"]; + delete: operations["users/delete-public-ssh-key-for-authenticated"]; + }; + "/user/marketplace_purchases": { + get: operations["apps/list-subscriptions-for-authenticated-user"]; + }; + "/user/marketplace_purchases/stubbed": { + get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; + }; + "/user/memberships/orgs": { + get: operations["orgs/list-memberships-for-authenticated-user"]; + }; + "/user/memberships/orgs/{org}": { + get: operations["orgs/get-membership-for-authenticated-user"]; + patch: operations["orgs/update-membership-for-authenticated-user"]; + }; + "/user/migrations": { + get: operations["migrations/list-for-authenticated-user"]; + post: operations["migrations/start-for-authenticated-user"]; + }; + "/user/migrations/{migration_id}": { + get: operations["migrations/get-status-for-authenticated-user"]; + }; + "/user/migrations/{migration_id}/archive": { + get: operations["migrations/get-archive-for-authenticated-user"]; + delete: operations["migrations/delete-archive-for-authenticated-user"]; + }; + "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + delete: operations["migrations/unlock-repo-for-authenticated-user"]; + }; + "/user/migrations/{migration_id}/repositories": { + get: operations["migrations/list-repos-for-user"]; + }; + "/user/orgs": { + get: operations["orgs/list-for-authenticated-user"]; + }; + "/user/projects": { + post: operations["projects/create-for-authenticated-user"]; + }; + "/user/public_emails": { + get: operations["users/list-public-emails-for-authenticated"]; + }; + "/user/repos": { + get: operations["repos/list-for-authenticated-user"]; + post: operations["repos/create-for-authenticated-user"]; + }; + "/user/repository_invitations": { + get: operations["repos/list-invitations-for-authenticated-user"]; + }; + "/user/repository_invitations/{invitation_id}": { + patch: operations["repos/accept-invitation"]; + delete: operations["repos/decline-invitation"]; + }; + "/user/starred": { + get: operations["activity/list-repos-starred-by-authenticated-user"]; + }; + "/user/starred/{owner}/{repo}": { + get: operations["activity/check-repo-is-starred-by-authenticated-user"]; + put: operations["activity/star-repo-for-authenticated-user"]; + delete: operations["activity/unstar-repo-for-authenticated-user"]; + }; + "/user/subscriptions": { + get: operations["activity/list-watched-repos-for-authenticated-user"]; + }; + "/user/teams": { + get: operations["teams/list-for-authenticated-user"]; + }; + "/users": { + get: operations["users/list"]; + }; + "/users/{username}": { + get: operations["users/get-by-username"]; + }; + "/users/{username}/events": { + get: operations["activity/list-events-for-authenticated-user"]; + }; + "/users/{username}/events/orgs/{org}": { + get: operations["activity/list-org-events-for-authenticated-user"]; + }; + "/users/{username}/events/public": { + get: operations["activity/list-public-events-for-user"]; + }; + "/users/{username}/followers": { + get: operations["users/list-followers-for-user"]; + }; + "/users/{username}/following": { + get: operations["users/list-following-for-user"]; + }; + "/users/{username}/following/{target_user}": { + get: operations["users/check-following-for-user"]; + }; + "/users/{username}/gists": { + get: operations["gists/list-for-user"]; + }; + "/users/{username}/gpg_keys": { + get: operations["users/list-gpg-keys-for-user"]; + }; + "/users/{username}/hovercard": { + get: operations["users/get-context-for-user"]; + }; + "/users/{username}/installation": { + get: operations["apps/get-user-installation"]; + }; + "/users/{username}/keys": { + get: operations["users/list-public-keys-for-user"]; + }; + "/users/{username}/orgs": { + get: operations["orgs/list-for-user"]; + }; + "/users/{username}/projects": { + get: operations["projects/list-for-user"]; + }; + "/users/{username}/received_events": { + get: operations["activity/list-received-events-for-user"]; + }; + "/users/{username}/received_events/public": { + get: operations["activity/list-received-public-events-for-user"]; + }; + "/users/{username}/repos": { + get: operations["repos/list-for-user"]; + }; + "/users/{username}/settings/billing/actions": { + get: operations["billing/get-github-actions-billing-user"]; + }; + "/users/{username}/settings/billing/packages": { + get: operations["billing/get-github-packages-billing-user"]; + }; + "/users/{username}/settings/billing/shared-storage": { + get: operations["billing/get-shared-storage-billing-user"]; + }; + "/users/{username}/starred": { + get: operations["activity/list-repos-starred-by-user"]; + }; + "/users/{username}/subscriptions": { + get: operations["activity/list-repos-watched-by-user"]; + }; + "/zen": { + get: operations["meta/get-zen"]; + }; +} + +export interface operations { + /** + * Get Hypermedia links to resources accessible in GitHub's REST API + */ + "meta/root": { + responses: { + /** + * response + */ + "200": { + "application/json": { + current_user_url: string; + current_user_authorizations_html_url: string; + authorizations_url: string; + code_search_url: string; + commit_search_url: string; + emails_url: string; + emojis_url: string; + events_url: string; + feeds_url: string; + followers_url: string; + following_url: string; + gists_url: string; + hub_url: string; + issue_search_url: string; + issues_url: string; + keys_url: string; + label_search_url: string; + notifications_url: string; + organization_url: string; + organization_repositories_url: string; + organization_teams_url: string; + public_gists_url: string; + rate_limit_url: string; + repository_url: string; + repository_search_url: string; + current_user_repositories_url: string; + starred_url: string; + starred_gists_url: string; + topic_search_url?: string; + user_url: string; + user_organizations_url: string; + user_repositories_url: string; + user_search_url: string; + }; + }; + }; + }; + /** + * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/get-authenticated": { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["integration"]; + }; + }; + }; + /** + * Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. + */ + "apps/create-from-manifest": { + parameters: { + path: { + code: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["integration"] & + ({ + client_id: string; + client_secret: string; + webhook_secret: string; + pem: string; + } & { [key: string]: any }); + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/get-webhook-config-for-app": { + responses: { + /** + * Default response + */ + "200": { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + /** + * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/update-webhook-config-for-app": { + requestBody: { + "application/json": { + url?: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + }; + responses: { + /** + * Default response + */ + "200": { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + /** + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * + * The permissions the installation has are included under the `permissions` key. + */ + "apps/list-installations": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + since?: components["parameters"]["since"]; + outdated?: string; + }; + }; + responses: { + /** + * The permissions the installation has are included under the `permissions` key. + */ + "200": { + "application/json": components["schemas"]["installation"][]; + }; + }; + }; + /** + * Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/get-installation": { + parameters: { + path: { + installation_id: components["parameters"]["installation_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["installation"]; + }; + "404": unknown; + "415": unknown; + }; + }; + /** + * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/v3/apps/#suspend-an-app-installation)" endpoint. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/delete-installation": { + parameters: { + path: { + installation_id: components["parameters"]["installation_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + /** + * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/create-installation-access-token": { + parameters: { + path: { + installation_id: components["parameters"]["installation_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * List of repository names that the token should have access to + */ + repositories?: string[]; + /** + * List of repository IDs that the token should have access to + */ + repository_ids?: number[]; + permissions?: components["schemas"]["app-permissions"]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["installation-token"]; + }; + "401": unknown; + "403": unknown; + "404": unknown; + "415": unknown; + "422": unknown; + }; + }; + /** + * **Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see "[Suspending a GitHub App installation](https://docs.github.com/apps/managing-github-apps/suspending-a-github-app-installation/)." + * + * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/suspend-installation": { + parameters: { + path: { + installation_id: components["parameters"]["installation_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + /** + * **Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see "[Suspending a GitHub App installation](https://docs.github.com/apps/managing-github-apps/suspending-a-github-app-installation/)." + * + * Removes a GitHub App installation suspension. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/unsuspend-installation": { + parameters: { + path: { + installation_id: components["parameters"]["installation_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + */ + "oauth-authorizations/list-grants": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["application-grant"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + */ + "oauth-authorizations/get-grant": { + parameters: { + path: { + grant_id: components["parameters"]["grant_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["application-grant"]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + */ + "oauth-authorizations/delete-grant": { + parameters: { + path: { + grant_id: components["parameters"]["grant_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + */ + "apps/delete-authorization": { + parameters: { + path: { + client_id: components["parameters"]["client-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "422": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). + * + * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted. + * + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under "Authorized OAuth Apps" on GitHub](https://github.com/settings/applications#authorized). + */ + "apps/revoke-grant-for-application": { + parameters: { + path: { + client_id: components["parameters"]["client-id"]; + access_token: components["parameters"]["access-token"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + */ + "apps/check-token": { + parameters: { + path: { + client_id: components["parameters"]["client-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The access_token of the OAuth application. + */ + access_token: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + */ + "apps/reset-token": { + parameters: { + path: { + client_id: components["parameters"]["client-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The access_token of the OAuth application. + */ + access_token: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + "422": unknown; + }; + }; + /** + * OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. + */ + "apps/delete-token": { + parameters: { + path: { + client_id: components["parameters"]["client-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "422": unknown; + }; + }; + /** + * Exchanges a non-repository scoped user-to-server OAuth access token for a repository scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + */ + "apps/scope-token": { + parameters: { + path: { + client_id: components["parameters"]["client-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * **Required.** The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; + /** + * The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified. + */ + target?: string; + /** + * The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified. + */ + target_id?: number; + /** + * The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified. + */ + repositories?: string[]; + /** + * The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified. + */ + repository_ids?: number[]; + permissions?: components["schemas"]["app-permissions"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + "401": unknown; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). + * + * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + */ + "apps/check-authorization": { + parameters: { + path: { + client_id: components["parameters"]["client-id"]; + access_token: components["parameters"]["access-token"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + "404": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). + * + * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + */ + "apps/reset-authorization": { + parameters: { + path: { + client_id: components["parameters"]["client-id"]; + access_token: components["parameters"]["access-token"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). + * + * OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. + */ + "apps/revoke-authorization-for-application": { + parameters: { + path: { + client_id: components["parameters"]["client-id"]; + access_token: components["parameters"]["access-token"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * + * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + "apps/get-by-slug": { + parameters: { + path: { + app_slug: components["parameters"]["app_slug"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["integration"]; + }; + "403": unknown; + "404": unknown; + "415": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + */ + "oauth-authorizations/list-authorizations": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * **Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * + * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. + * + * You can also create tokens on GitHub from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use). + * + * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). + */ + "oauth-authorizations/create-authorization": { + parameters: {}; + requestBody: { + "application/json": { + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[] | null; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * The OAuth app client key for which to create the token. + */ + client_id?: string; + /** + * The OAuth app client secret for which to create the token. + */ + client_secret?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authorization"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "410": unknown; + "422": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * **Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * + * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + * + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + */ + "oauth-authorizations/get-or-create-authorization-for-app": { + parameters: { + path: { + client_id: components["parameters"]["client-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The OAuth app client secret for which to create the token. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[] | null; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; + }; + }; + responses: { + /** + * Response if returning an existing token + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + */ + "201": { + "application/json": components["schemas"]["authorization"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "422": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * **Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * + * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + * + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + */ + "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { + parameters: { + path: { + client_id: components["parameters"]["client-id"]; + fingerprint: string; + }; + }; + requestBody: { + "application/json": { + /** + * The OAuth app client secret for which to create the token. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[] | null; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + }; + }; + responses: { + /** + * Response if returning an existing token + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + /** + * Response if returning a new token + */ + "201": { + "application/json": components["schemas"]["authorization"]; + }; + "422": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + */ + "oauth-authorizations/get-authorization": { + parameters: { + path: { + authorization_id: components["parameters"]["authorization_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * + * You can only send one of these scope keys at a time. + */ + "oauth-authorizations/update-authorization": { + parameters: { + path: { + authorization_id: components["parameters"]["authorization_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[] | null; + /** + * A list of scopes to add to this authorization. + */ + add_scopes?: string[]; + /** + * A list of scopes to remove from this authorization. + */ + remove_scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + "422": unknown; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + */ + "oauth-authorizations/delete-authorization": { + parameters: { + path: { + authorization_id: components["parameters"]["authorization_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + "codes-of-conduct/get-all-codes-of-conduct": { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["code-of-conduct"][]; + }; + "304": never; + "415": unknown; + }; + }; + "codes-of-conduct/get-conduct-code": { + parameters: { + path: { + key: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["code-of-conduct"]; + }; + "304": never; + "404": unknown; + "415": unknown; + }; + }; + /** + * Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. + * + * The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + "apps/create-content-attachment": { + parameters: { + path: { + content_reference_id: number; + }; + }; + requestBody: { + "application/json": { + /** + * The title of the attachment + */ + title: string; + /** + * The body of the attachment + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["content-reference-attachment"]; + }; + "304": never; + "403": unknown; + "404": unknown; + "410": unknown; + "415": unknown; + "422": unknown; + }; + }; + /** + * Lists all the emojis available to use on GitHub. + */ + "emojis/get": { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": { [key: string]: string }; + }; + "304": never; + }; + }; + /** + * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/get-github-actions-permissions-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-enterprise-permissions"]; + }; + }; + }; + /** + * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/set-github-actions-permissions-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + "application/json": { + enabled_organizations: components["schemas"]["enabled-organizations"]; + allowed_actions?: components["schemas"]["allowed-actions"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + organizations: components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + /** + * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + "application/json": { + /** + * List of organization IDs to enable for GitHub Actions. + */ + selected_organization_ids: number[]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/enable-selected-organization-github-actions-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + org_id: components["parameters"]["org_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/disable-selected-organization-github-actions-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + org_id: components["parameters"]["org_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/get-allowed-actions-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + }; + /** + * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/set-allowed-actions-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + "application/json": components["schemas"]["selected-actions"]; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists all self-hosted runner groups for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-enterprise"][]; + }; + }; + }; + }; + /** + * Creates a new self-hosted runner group for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + "application/json": { + /** + * Name of the runner group. + */ + name: string; + /** + * Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected` + */ + visibility?: "selected" | "all"; + /** + * List of organization IDs that can access the runner group. + */ + selected_organization_ids?: number[]; + /** + * List of runner IDs to add to the runner group. + */ + runners?: number[]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["runner-groups-enterprise"]; + }; + }; + }; + /** + * Gets a specific self-hosted runner group for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner-groups-enterprise"]; + }; + }; + }; + /** + * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * Name of the runner group. + */ + name?: string; + /** + * Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected` + */ + visibility?: "selected" | "all"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner-groups-enterprise"]; + }; + }; + }; + /** + * Deletes a self-hosted runner group for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists the organizations with access to a self-hosted runner group. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + organizations: components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + /** + * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * List of organization IDs that can access the runner group. + */ + selected_organization_ids: number[]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_group_id: components["parameters"]["runner_group_id"]; + org_id: components["parameters"]["org_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_group_id: components["parameters"]["runner_group_id"]; + org_id: components["parameters"]["org_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists the self-hosted runners that are in a specific enterprise group. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + }; + }; + }; + }; + /** + * Replaces the list of self-hosted runners that that are part of an enterprise runner group. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * List of runner IDs to add to the runner group. + */ + runners: number[]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Adds a self-hosted runner to a runner group configured in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` + * scope to use this endpoint. + */ + "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_group_id: components["parameters"]["runner_group_id"]; + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_group_id: components["parameters"]["runner_group_id"]; + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists all self-hosted runners configured for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/list-self-hosted-runners-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + runners?: components["schemas"]["runner"][]; + }; + }; + }; + }; + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/list-runner-applications-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner-application"][]; + }; + }; + }; + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN + * ``` + */ + "enterprise-admin/create-registration-token-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + /** + * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this + * endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + "enterprise-admin/create-remove-token-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + /** + * Gets a specific self-hosted runner configured in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/get-self-hosted-runner-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner"]; + }; + }; + }; + /** + * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/delete-self-hosted-runner-from-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * **Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub. + * + * Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. + */ + "audit-log/get-audit-log": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + query: { + phrase?: components["parameters"]["audit-log-phrase"]; + include?: components["parameters"]["audit-log-include"]; + after?: components["parameters"]["audit-log-after"]; + before?: components["parameters"]["audit-log-before"]; + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** + * Response + */ + "200": { + "application/json": components["schemas"]["audit-log-event"][]; + }; + }; + }; + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * The authenticated user must be an enterprise admin. + */ + "billing/get-github-actions-billing-ghe": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-billing-usage"]; + }; + }; + }; + /** + * Gets the free and paid storage used for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * The authenticated user must be an enterprise admin. + */ + "billing/get-github-packages-billing-ghe": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["packages-billing-usage"]; + }; + }; + }; + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * The authenticated user must be an enterprise admin. + */ + "billing/get-shared-storage-billing-ghe": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["combined-billing-usage"]; + }; + }; + }; + /** + * We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + */ + "activity/list-public-events": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + "304": never; + "403": unknown; + "503": unknown; + }; + }; + /** + * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + * + * * **Timeline**: The GitHub global public timeline + * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + * * **Current user public**: The public timeline for the authenticated user + * * **Current user**: The private timeline for the authenticated user + * * **Current user actor**: The private timeline for activity created by the authenticated user + * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. + * + * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + */ + "activity/get-feeds": { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["feed"]; + }; + }; + }; + /** + * Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: + */ + "gists/list": { + parameters: { + query: { + since?: components["parameters"]["since"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["base-gist"][]; + }; + "304": never; + "403": unknown; + }; + }; + /** + * Allows you to add a new gist with one or more files. + * + * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + */ + "gists/create": { + parameters: {}; + requestBody: { + "application/json": { + /** + * Description of the gist + */ + description?: string; + /** + * Names and content for the files that make up the gist + */ + files: { + [key: string]: { + /** + * Content of the file + */ + content: string; + }; + }; + public?: boolean | ("true" | "false"); + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["gist-full"]; + }; + "304": never; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * List public gists sorted by most recently updated to least recently updated. + * + * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + */ + "gists/list-public": { + parameters: { + query: { + since?: components["parameters"]["since"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["base-gist"][]; + }; + "304": never; + "403": unknown; + "422": unknown; + }; + }; + /** + * List the authenticated user's starred gists: + */ + "gists/list-starred": { + parameters: { + query: { + since?: components["parameters"]["since"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["base-gist"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + "gists/get": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-full"]; + }; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. + */ + "gists/update": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + }; + }; + requestBody: { + "application/json": Partial<{ [key: string]: any }> & + Partial<{ [key: string]: any }>; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-full"]; + }; + "404": unknown; + "422": unknown; + }; + }; + "gists/delete": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + "gists/list-comments": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-comment"][]; + }; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + "gists/create-comment": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The comment text. + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["gist-comment"]; + }; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + "gists/get-comment": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-comment"]; + }; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + "gists/update-comment": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The comment text. + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-comment"]; + }; + "404": unknown; + }; + }; + "gists/delete-comment": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + "gists/list-commits": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-commit"][]; + }; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + "gists/list-forks": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-full"][]; + }; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * **Note**: This was previously `/gists/:gist_id/fork`. + */ + "gists/fork": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["base-gist"]; + }; + "304": never; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + "gists/check-is-starred": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** + * Response if gist is starred + */ + "204": never; + "304": never; + "403": unknown; + /** + * Response if gist is not starred + */ + "404": { + "application/json": { [key: string]: any }; + }; + }; + }; + /** + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + "gists/star": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + "gists/unstar": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + "gists/get-revision": { + parameters: { + path: { + gist_id: components["parameters"]["gist_id"]; + sha: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-full"]; + }; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). + */ + "gitignore/get-all-templates": { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": string[]; + }; + "304": never; + }; + }; + /** + * The API also allows fetching the source of a single template. + * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. + */ + "gitignore/get-template": { + parameters: { + path: { + name: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gitignore-template"]; + }; + "304": never; + }; + }; + /** + * List repositories that an app installation can access. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + "apps/list-repos-accessible-to-installation": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + repositories: components["schemas"]["repository"][]; + repository_selection?: string; + }; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * Revokes the installation token you're using to authenticate as an installation and access this endpoint. + * + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + "apps/revoke-installation-access-token": { + parameters: {}; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * List issues assigned to the authenticated user across all visible repositories including owned repositories, member + * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + * necessarily assigned to you. + * + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + "issues/list": { + parameters: { + query: { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + labels?: components["parameters"]["labels"]; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + direction?: components["parameters"]["direction"]; + since?: components["parameters"]["since"]; + collab?: boolean; + orgs?: boolean; + owned?: boolean; + pulls?: boolean; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue"][]; + }; + "304": never; + "404": unknown; + "422": unknown; + }; + }; + "licenses/get-all-commonly-used": { + parameters: { + query: { + featured?: boolean; + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["license-simple"][]; + }; + "304": never; + }; + }; + "licenses/get": { + parameters: { + path: { + license: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["license"]; + }; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + "markdown/render": { + parameters: {}; + requestBody: { + "application/json": { + /** + * The Markdown text to render in HTML. + */ + text: string; + /** + * The rendering mode. + */ + mode?: "markdown" | "gfm"; + /** + * The repository context to use when creating references in `gfm` mode. + */ + context?: string; + }; + }; + responses: { + /** + * response + */ + "200": unknown; + "304": never; + }; + }; + /** + * You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. + */ + "markdown/render-raw": { + parameters: {}; + requestBody: { + "text/plain": string; + "text/x-markdown": string; + }; + responses: { + /** + * response + */ + "200": { + "text/html": string; + }; + "304": never; + }; + }; + /** + * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + "apps/get-subscription-plan-for-account": { + parameters: { + path: { + account_id: components["parameters"]["account_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["marketplace-purchase"]; + }; + "401": unknown; + /** + * Response when the account has not purchased the listing + */ + "404": { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + /** + * Lists all plans that are part of your GitHub Marketplace listing. + * + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + "apps/list-plans": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["marketplace-listing-plan"][]; + }; + "401": unknown; + "404": unknown; + }; + }; + /** + * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + "apps/list-accounts-for-plan": { + parameters: { + path: { + plan_id: components["parameters"]["plan_id"]; + }; + query: { + sort?: components["parameters"]["sort"]; + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["marketplace-purchase"][]; + }; + "401": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + "apps/get-subscription-plan-for-account-stubbed": { + parameters: { + path: { + account_id: components["parameters"]["account_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["marketplace-purchase"]; + }; + "401": unknown; + /** + * Response when the account has not purchased the listing + */ + "404": unknown; + }; + }; + /** + * Lists all plans that are part of your GitHub Marketplace listing. + * + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + "apps/list-plans-stubbed": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["marketplace-listing-plan"][]; + }; + "401": unknown; + }; + }; + /** + * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + "apps/list-accounts-for-plan-stubbed": { + parameters: { + path: { + plan_id: components["parameters"]["plan_id"]; + }; + query: { + sort?: components["parameters"]["sort"]; + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["marketplace-purchase"][]; + }; + "401": unknown; + }; + }; + /** + * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)." + * + * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. + */ + "meta/get": { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["api-overview"]; + }; + "304": never; + }; + }; + "activity/list-public-events-for-repo-network": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + "301": never; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * List all notifications for the current user, sorted by most recently updated. + */ + "activity/list-notifications-for-authenticated-user": { + parameters: { + query: { + all?: components["parameters"]["all"]; + participating?: components["parameters"]["participating"]; + since?: components["parameters"]["since"]; + before?: components["parameters"]["before"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["thread"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "422": unknown; + }; + }; + /** + * Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + */ + "activity/mark-notifications-as-read": { + parameters: {}; + requestBody: { + "application/json": { + /** + * Describes the last point that notifications were checked. + */ + last_read_at?: string; + /** + * Whether the notification has been read. + */ + read?: boolean; + }; + }; + responses: { + /** + * response + */ + "202": { + "application/json": { message?: string }; + }; + /** + * response + */ + "205": unknown; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + "activity/get-thread": { + parameters: { + path: { + thread_id: components["parameters"]["thread_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["thread"]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + "activity/mark-thread-as-read": { + parameters: { + path: { + thread_id: components["parameters"]["thread_id"]; + }; + }; + responses: { + /** + * response + */ + "205": unknown; + "304": never; + "403": unknown; + }; + }; + /** + * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). + * + * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + */ + "activity/get-thread-subscription-for-authenticated-user": { + parameters: { + path: { + thread_id: components["parameters"]["thread_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["thread-subscription"]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. + * + * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. + * + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. + */ + "activity/set-thread-subscription": { + parameters: { + path: { + thread_id: components["parameters"]["thread_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * Whether to block all notifications from a thread. + */ + ignored?: boolean; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["thread-subscription"]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. + */ + "activity/delete-thread-subscription": { + parameters: { + path: { + thread_id: components["parameters"]["thread_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * Get the octocat as ASCII art + */ + "meta/get-octocat": { + parameters: { + query: { + /** + * The words to show in Octocat's speech bubble + */ + s?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/octocat-stream": string; + }; + }; + }; + /** + * Lists all organizations, in the order that they were created on GitHub. + * + * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. + */ + "orgs/list": { + parameters: { + query: { + since?: components["parameters"]["since-org"]; + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-simple"][]; + }; + "304": never; + }; + }; + /** + * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * + * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + */ + "orgs/get": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-full"]; + }; + "404": unknown; + }; + }; + /** + * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * + * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. + */ + "orgs/update": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": { + /** + * Billing email address. This address is not publicized. + */ + billing_email?: string; + /** + * The company name. + */ + company?: string; + /** + * The publicly visible email address. + */ + email?: string; + /** + * The Twitter username of the company. + */ + twitter_username?: string; + /** + * The location. + */ + location?: string; + /** + * The shorthand name of the company. + */ + name?: string; + /** + * The description of the company. + */ + description?: string; + /** + * Toggles whether an organization can use organization projects. + */ + has_organization_projects?: boolean; + /** + * Toggles whether repositories that belong to the organization can use repository projects. + */ + has_repository_projects?: boolean; + /** + * Default permission level members have for organization repositories: + * \* `read` - can pull, but not push to or administer this repository. + * \* `write` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push, and administer this repository. + * \* `none` - no permissions granted by default. + */ + default_repository_permission?: "read" | "write" | "admin" | "none"; + /** + * Toggles the ability of non-admin organization members to create repositories. Can be one of: + * \* `true` - all organization members can create repositories. + * \* `false` - only organization owners can create repositories. + * Default: `true` + * **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. + */ + members_can_create_repositories?: boolean; + /** + * Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: + * \* `true` - all organization members can create internal repositories. + * \* `false` - only organization owners can create internal repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_internal_repositories?: boolean; + /** + * Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: + * \* `true` - all organization members can create private repositories. + * \* `false` - only organization owners can create private repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_private_repositories?: boolean; + /** + * Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: + * \* `true` - all organization members can create public repositories. + * \* `false` - only organization owners can create public repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_public_repositories?: boolean; + /** + * Specifies which types of repositories non-admin organization members can create. Can be one of: + * \* `all` - all organization members can create public and private repositories. + * \* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. + * \* `none` - only admin members can create repositories. + * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + */ + members_allowed_repository_creation_type?: "all" | "private" | "none"; + /** + * Toggles whether organization members can create GitHub Pages sites. Can be one of: + * \* `true` - all organization members can create GitHub Pages sites. + * \* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. + * Default: `true`. + */ + members_can_create_pages?: boolean; + blog?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-full"]; + }; + "409": unknown; + "415": unknown; + /** + * Validation Failed + */ + "422": { + "application/json": + | components["schemas"]["validation-error"] + | components["schemas"]["validation-error-simple"]; + }; + }; + }; + /** + * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + "actions/get-github-actions-permissions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-organization-permissions"]; + }; + }; + }; + /** + * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + * + * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + "actions/set-github-actions-permissions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": { + enabled_repositories: components["schemas"]["enabled-repositories"]; + allowed_actions?: components["schemas"]["allowed-actions"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + "actions/list-selected-repositories-enabled-github-actions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + repositories: components["schemas"]["repository"][]; + }; + }; + }; + }; + /** + * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + "actions/set-selected-repositories-enabled-github-actions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": { + /** + * List of repository IDs to enable for GitHub Actions. + */ + selected_repository_ids: number[]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + "actions/enable-selected-repository-github-actions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + repository_id: components["parameters"]["repository_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + "actions/disable-selected-repository-github-actions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + repository_id: components["parameters"]["repository_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + "actions/get-allowed-actions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + }; + /** + * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + * + * To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + "actions/set-allowed-actions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": components["schemas"]["selected-actions"]; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/list-self-hosted-runner-groups-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-org"][]; + }; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Creates a new self-hosted runner group for an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/create-self-hosted-runner-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": { + /** + * Name of the runner group. + */ + name: string; + /** + * Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`. + */ + visibility?: "selected" | "all" | "private"; + /** + * List of repository IDs that can access the runner group. + */ + selected_repository_ids?: number[]; + /** + * List of runner IDs to add to the runner group. + */ + runners?: number[]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Gets a specific self-hosted runner group for an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/get-self-hosted-runner-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Updates the `name` and `visibility` of a self-hosted runner group in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/update-self-hosted-runner-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * Name of the runner group. + */ + name?: string; + /** + * Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`. + */ + visibility?: "selected" | "all" | "private"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Deletes a self-hosted runner group for an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/delete-self-hosted-runner-group-from-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Lists the repositories with access to a self-hosted runner group configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + repositories: components["schemas"]["repository"][]; + }; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * List of repository IDs that can access the runner group. + */ + selected_repository_ids: number[]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * + * Adds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` + * scope to use this endpoint. + */ + "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner_group_id"]; + repository_id: components["parameters"]["repository_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * + * Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner_group_id"]; + repository_id: components["parameters"]["repository_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Lists self-hosted runners that are in a specific organization group. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/list-self-hosted-runners-in-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + }; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Replaces the list of self-hosted runners that are part of an organization runner group. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/set-self-hosted-runners-in-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * List of runner IDs to add to the runner group. + */ + runners: number[]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * + * Adds a self-hosted runner to a runner group configured in an organization. + * + * You must authenticate using an access token with the `admin:org` + * scope to use this endpoint. + */ + "actions/add-self-hosted-runner-to-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner_group_id"]; + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * + * Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/remove-self-hosted-runner-from-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner_group_id"]; + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists all self-hosted runners configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/list-self-hosted-runners-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + }; + }; + }; + }; + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/list-runner-applications-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner-application"][]; + }; + }; + }; + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` + */ + "actions/create-registration-token-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + /** + * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this + * endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + "actions/create-remove-token-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + /** + * Gets a specific self-hosted runner configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/get-self-hosted-runner-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner"]; + }; + }; + }; + /** + * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/delete-self-hosted-runner-from-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + "actions/list-org-secrets": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + secrets: components["schemas"]["organization-actions-secret"][]; + }; + }; + }; + }; + /** + * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + "actions/get-org-public-key": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + /** + * Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + "actions/get-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-actions-secret"]; + }; + }; + }; + /** + * Creates or updates an organization secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to + * use this endpoint. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + "actions/create-or-update-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret_name"]; + }; + }; + requestBody: { + "application/json": { + /** + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint. + */ + encrypted_value?: string; + /** + * ID of the key you used to encrypt the secret. + */ + key_id?: string; + /** + * Configures the access that repositories have to the organization secret. Can be one of: + * \- `all` - All repositories in an organization can access the secret. + * \- `private` - Private repositories in an organization can access the secret. + * \- `selected` - Only specific repositories can access the secret. + */ + visibility?: "all" | "private" | "selected"; + /** + * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. + */ + selected_repository_ids?: string[]; + }; + }; + responses: { + /** + * Response when creating a secret + */ + "201": unknown; + /** + * Response when updating a secret + */ + "204": never; + }; + }; + /** + * Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + "actions/delete-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + "actions/list-selected-repos-for-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + /** + * Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + "actions/set-selected-repos-for-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret_name"]; + }; + }; + requestBody: { + "application/json": { + /** + * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. + */ + selected_repository_ids?: number[]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + "actions/add-selected-repo-to-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret_name"]; + repository_id: number; + }; + }; + responses: { + /** + * Response when repository was added to the selected list + */ + "204": never; + /** + * Response when visibility type is not set to selected + */ + "409": unknown; + }; + }; + /** + * Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + "actions/remove-selected-repo-from-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret_name"]; + repository_id: number; + }; + }; + responses: { + /** + * Response when repository was removed from the selected list + */ + "204": never; + /** + * Response when visibility type not set to selected + */ + "409": unknown; + }; + }; + /** + * **Note:** The audit log REST API is currently in beta and is subject to change. To join the beta, talk to your services or sales contact at GitHub. + * + * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + * + * To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. + */ + "orgs/get-audit-log": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + phrase?: components["parameters"]["audit-log-phrase"]; + include?: components["parameters"]["audit-log-include"]; + after?: components["parameters"]["audit-log-after"]; + before?: components["parameters"]["audit-log-before"]; + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** + * Response + */ + "200": { + "application/json": components["schemas"]["audit-log-event"][]; + }; + }; + }; + /** + * List the users blocked by an organization. + */ + "orgs/list-blocked-users": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "415": unknown; + }; + }; + "orgs/check-blocked-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * If the user is blocked: + */ + "204": never; + /** + * If the user is not blocked: + */ + "404": { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + "orgs/block-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "422": unknown; + }; + }; + "orgs/unblock-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products). + * + * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://help.github.com/en/articles/about-authentication-with-saml-single-sign-on). + */ + "orgs/list-saml-sso-authorizations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["credential-authorization"][]; + }; + }; + }; + /** + * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products). + * + * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. + */ + "orgs/remove-saml-sso-authorization": { + parameters: { + path: { + org: components["parameters"]["org"]; + credential_id: number; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + "activity/list-public-org-events": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + "orgs/list-webhooks": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-hook"][]; + }; + "404": unknown; + }; + }; + /** + * Here's how you can create a hook that posts payloads in JSON format: + */ + "orgs/create-webhook": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": { + /** + * Must be passed as "web". + */ + name: string; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). + */ + config: { + url: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + username?: string; + password?: string; + }; + /** + * Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["org-hook"]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." + */ + "orgs/get-webhook": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-hook"]; + }; + "404": unknown; + }; + }; + /** + * Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." + */ + "orgs/update-webhook": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). + */ + config?: { + url: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + /** + * Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; + name?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-hook"]; + }; + "404": unknown; + "422": unknown; + }; + }; + "orgs/delete-webhook": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + /** + * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." + * + * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + */ + "orgs/get-webhook-config-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** + * Default response + */ + "200": { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + /** + * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." + * + * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + */ + "orgs/update-webhook-config-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + requestBody: { + "application/json": { + url?: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + }; + responses: { + /** + * Default response + */ + "200": { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + /** + * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + */ + "orgs/ping-webhook": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + /** + * Enables an authenticated GitHub App to find the organization's installation information. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/get-org-installation": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["installation"]; + }; + }; + }; + /** + * Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. + */ + "orgs/list-app-installations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + installations: components["schemas"]["installation"][]; + }; + }; + }; + }; + /** + * Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. + */ + "interactions/get-restrictions-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["interaction-limit-response"]; + }; + }; + }; + /** + * Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. + */ + "interactions/set-restrictions-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": components["schemas"]["interaction-limit"]; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["interaction-limit-response"]; + }; + "422": unknown; + }; + }; + /** + * Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. + */ + "interactions/remove-restrictions-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + */ + "orgs/list-pending-invitations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-invitation"][]; + }; + "404": unknown; + }; + }; + /** + * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "orgs/create-invitation": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": { + /** + * **Required unless you provide `email`**. GitHub user ID for the person you are inviting. + */ + invitee_id?: number; + /** + * **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. + */ + email?: string; + /** + * Specify role for new member. Can be one of: + * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * \* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * \* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + */ + role?: "admin" | "direct_member" | "billing_manager"; + /** + * Specify IDs for the teams you want to invite new members to. + */ + team_ids?: number[]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["organization-invitation"]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. + */ + "orgs/list-invitation-teams": { + parameters: { + path: { + org: components["parameters"]["org"]; + invitation_id: components["parameters"]["invitation_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "404": unknown; + }; + }; + /** + * List issues in an organization assigned to the authenticated user. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + "issues/list-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + labels?: components["parameters"]["labels"]; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + direction?: components["parameters"]["direction"]; + since?: components["parameters"]["since"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue"][]; + }; + "404": unknown; + }; + }; + /** + * List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. + */ + "orgs/list-members": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** + * Filter members returned in the list. Can be one of: + * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. + * \* `all` - All members the authenticated user can see. + */ + filter?: "2fa_disabled" | "all"; + /** + * Filter members returned by their role. Can be one of: + * \* `all` - All members of the organization, regardless of role. + * \* `admin` - Organization owners. + * \* `member` - Non-owner organization members. + */ + role?: "all" | "admin" | "member"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + /** + * Response if requester is not an organization member + */ + "302": never; + "422": unknown; + }; + }; + /** + * Check if a user is, publicly or privately, a member of the organization. + */ + "orgs/check-membership-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Response if requester is an organization member and user is a member + */ + "204": never; + /** + * Response if requester is not an organization member + */ + "302": never; + /** + * Response if requester is an organization member and user is not a member + */ + "404": unknown; + }; + }; + /** + * Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. + */ + "orgs/remove-member": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "403": unknown; + }; + }; + /** + * In order to get a user's membership with an organization, the authenticated user must be an organization member. + */ + "orgs/get-membership-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-membership"]; + }; + "403": unknown; + "404": unknown; + }; + }; + /** + * Only authenticated organization owners can add a member to the organization or update the member's role. + * + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * + * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. + * + * **Rate limits** + * + * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + */ + "orgs/set-membership-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + requestBody: { + "application/json": { + /** + * The role to give the user in the organization. Can be one of: + * \* `admin` - The user will become an owner of the organization. + * \* `member` - The user will become a non-owner member of the organization. + */ + role?: "admin" | "member"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-membership"]; + }; + "403": unknown; + "422": unknown; + }; + }; + /** + * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. + * + * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + */ + "orgs/remove-membership-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * Lists the most recent migrations. + */ + "migrations/list-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["migration"][]; + }; + }; + }; + /** + * Initiates the generation of a migration archive. + */ + "migrations/start-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": { + /** + * A list of arrays indicating which repositories should be migrated. + */ + repositories: string[]; + /** + * Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + */ + lock_repositories?: boolean; + /** + * Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + */ + exclude_attachments?: boolean; + exclude?: string[]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["migration"]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * Fetches the status of a migration. + * + * The `state` of a migration can be one of the following values: + * + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. + */ + "migrations/get-status-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + migration_id: components["parameters"]["migration_id"]; + }; + }; + responses: { + /** + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. + */ + "200": { + "application/json": components["schemas"]["migration"]; + }; + "404": unknown; + }; + }; + /** + * Fetches the URL to a migration archive. + */ + "migrations/download-archive-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + migration_id: components["parameters"]["migration_id"]; + }; + }; + responses: { + /** + * response + */ + "302": never; + "404": unknown; + }; + }; + /** + * Deletes a previous migration archive. Migration archives are automatically deleted after seven days. + */ + "migrations/delete-archive-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + migration_id: components["parameters"]["migration_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + /** + * Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. + */ + "migrations/unlock-repo-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + migration_id: components["parameters"]["migration_id"]; + repo_name: components["parameters"]["repo_name"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + /** + * List all the repositories for this organization migration. + */ + "migrations/list-repos-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + migration_id: components["parameters"]["migration_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + "404": unknown; + }; + }; + /** + * List all users who are outside collaborators of an organization. + */ + "orgs/list-outside-collaborators": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** + * Filter the list of outside collaborators. Can be one of: + * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. + * \* `all`: All outside collaborators. + */ + filter?: "2fa_disabled" | "all"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + /** + * When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". + */ + "orgs/convert-member-to-outside-collaborator": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * User is getting converted asynchronously + */ + "202": unknown; + /** + * User was converted + */ + "204": never; + /** + * response + */ + "403": { + "application/json": { message?: string; documentation_url?: string }; + }; + "404": unknown; + }; + }; + /** + * Removing a user from this list will remove them from all the organization's repositories. + */ + "orgs/remove-outside-collaborator": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + /** + * Response if user is a member of the organization + */ + "422": { + "application/json": { message?: string; documentation_url?: string }; + }; + }; + }; + /** + * Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + "projects/list-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project"][]; + }; + "422": unknown; + }; + }; + /** + * Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + "projects/create-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["project"]; + }; + "401": unknown; + "403": unknown; + "404": unknown; + "410": unknown; + "422": unknown; + }; + }; + /** + * Members of an organization can choose to have their membership publicized or not. + */ + "orgs/list-public-members": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + "orgs/check-public-membership-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Response if user is a public member + */ + "204": never; + /** + * Response if user is not a public member + */ + "404": unknown; + }; + }; + /** + * The user can publicize their own membership. (A user cannot publicize the membership for another user.) + * + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + "orgs/set-public-membership-for-authenticated-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "403": unknown; + }; + }; + "orgs/remove-public-membership-for-authenticated-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists repositories for the specified organization. + */ + "repos/list-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** + * Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. + */ + type?: + | "all" + | "public" + | "private" + | "forks" + | "sources" + | "member" + | "internal"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` + */ + direction?: "asc" | "desc"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + /** + * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository + * * `repo` scope to create a private repository + */ + "repos/create-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the repository. + */ + name: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to create a private repository or `false` to create a public one. + */ + private?: boolean; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see "[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * 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. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + */ + team_id?: number; + /** + * Pass `true` to create an initial commit with empty README. + */ + auto_init?: boolean; + /** + * 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". + */ + gitignore_template?: string; + /** + * 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". + */ + license_template?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["repository"]; + }; + "403": unknown; + "422": unknown; + }; + }; + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + "billing/get-github-actions-billing-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-billing-usage"]; + }; + }; + }; + /** + * Gets the free and paid storage usued for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + "billing/get-github-packages-billing-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["packages-billing-usage"]; + }; + }; + }; + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + "billing/get-shared-storage-billing-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["combined-billing-usage"]; + }; + }; + }; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." + * + * The `per_page` parameter provides pagination for a list of IdP groups the authenticated user can access in an organization. For example, if the user `octocat` wants to see two groups per page in `octo-org` via cURL, it would look like this: + */ + "teams/list-idp-groups-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["group-mapping"]; + }; + }; + }; + /** + * Lists all teams in an organization that are visible to the authenticated user. + */ + "teams/list": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "403": unknown; + }; + }; + /** + * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." + * + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". + */ + "teams/create": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * List GitHub IDs for organization members who will become team maintainers. + */ + maintainers?: string[]; + /** + * The full name (e.g., "organization-name/repository-name") of repositories to add the team to. + */ + repo_names?: string[]; + /** + * The level of privacy this team should have. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + * Default for child team: `closed` + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-full"]; + }; + "403": unknown; + "422": unknown; + }; + }; + /** + * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + */ + "teams/get-by-name": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-full"]; + }; + "404": unknown; + }; + }; + /** + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + */ + "teams/update-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-full"]; + }; + }; + }; + /** + * To delete a team, the authenticated user must be an organization owner or team maintainer. + * + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + */ + "teams/delete-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + */ + "teams/list-discussions-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + }; + query: { + direction?: components["parameters"]["direction"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-discussion"][]; + }; + }; + }; + /** + * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + */ + "teams/create-discussion-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + }; + }; + requestBody: { + "application/json": { + /** + * The discussion post's title. + */ + title: string; + /** + * The discussion post's body text. + */ + body: string; + /** + * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + */ + private?: boolean; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + /** + * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + "teams/get-discussion-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + /** + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + "teams/update-discussion-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The discussion post's title. + */ + title?: string; + /** + * The discussion post's body text. + */ + body?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + /** + * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + "teams/delete-discussion-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + */ + "teams/list-discussion-comments-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + query: { + direction?: components["parameters"]["direction"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-discussion-comment"][]; + }; + }; + }; + /** + * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + */ + "teams/create-discussion-comment-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The discussion comment's body text. + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + /** + * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + "teams/get-discussion-comment-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + /** + * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + "teams/update-discussion-comment-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The discussion comment's body text. + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + /** + * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + "teams/delete-discussion-comment-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + */ + "reactions/list-for-team-discussion-comment-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + query: { + /** + * Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + }; + }; + /** + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + */ + "reactions/create-for-team-discussion-comment-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + }; + }; + /** + * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "reactions/delete-for-team-discussion-comment": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + */ + "reactions/list-for-team-discussion-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + query: { + /** + * Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + }; + }; + /** + * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + */ + "reactions/create-for-team-discussion-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + }; + }; + /** + * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * + * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "reactions/delete-for-team-discussion": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + */ + "teams/list-pending-invitations-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-invitation"][]; + }; + }; + }; + /** + * Team members will include the members of child teams. + * + * To list members in a team, the team must be visible to the authenticated user. + */ + "teams/list-members-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + }; + query: { + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + /** + * Team members will include the members of child teams. + * + * To get a user's membership with a team, the team must be visible to the authenticated user. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * + * **Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). + */ + "teams/get-membership-for-user-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-membership"]; + }; + /** + * Response if user has no team membership + */ + "404": unknown; + }; + }; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. + * + * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + */ + "teams/add-or-update-membership-for-user-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + username: components["parameters"]["username"]; + }; + }; + requestBody: { + "application/json": { + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-membership"]; + }; + /** + * Response if team synchronization is set up + */ + "403": unknown; + /** + * Response if you attempt to add an organization to a team + */ + "422": { + "application/json": { + message?: string; + errors?: { code?: string; field?: string; resource?: string }[]; + }; + }; + }; + }; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + */ + "teams/remove-membership-for-user-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + /** + * Response if team synchronization is set up + */ + "403": unknown; + }; + }; + /** + * Lists the organization projects for a team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + */ + "teams/list-projects-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-project"][]; + }; + }; + }; + /** + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + "teams/check-permissions-for-project-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-project"]; + }; + /** + * Response if project is not managed by this team + */ + "404": unknown; + }; + }; + /** + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + "teams/add-or-update-project-permissions-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + project_id: components["parameters"]["project-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + permission?: "read" | "write" | "admin"; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + /** + * Response if the project is not owned by the organization + */ + "403": { + "application/json": { message?: string; documentation_url?: string }; + }; + }; + }; + /** + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + "teams/remove-project-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists a team's repositories visible to the authenticated user. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + */ + "teams/list-repos-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + /** + * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. + * + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * + * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + */ + "teams/check-permissions-for-repo-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Alternative response with repository permissions + */ + "200": { + "application/vnd.github.v3.repository+json": components["schemas"]["team-repository"]; + }; + /** + * Response if team has permission for the repository + */ + "204": never; + /** + * Response if team does not have permission for the repository + */ + "404": unknown; + }; + }; + /** + * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * + * For more information about the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + */ + "teams/add-or-update-repo-permissions-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * \* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. + * \* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + */ + permission?: "pull" | "push" | "admin" | "maintain" | "triage"; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + */ + "teams/remove-repo-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * List IdP groups connected to a team on GitHub. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. + */ + "teams/list-idp-groups-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["group-mapping"]; + }; + }; + }; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. + */ + "teams/create-or-update-idp-group-connections-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + }; + }; + requestBody: { + "application/json": { + /** + * 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. + */ + groups: { + /** + * ID of the IdP group. + */ + group_id: string; + /** + * Name of the IdP group. + */ + group_name: string; + /** + * Description of the IdP group. + */ + group_description: string; + }[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["group-mapping"]; + }; + }; + }; + /** + * Lists the child teams of the team specified by `{team_slug}`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + */ + "teams/list-child-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team_slug"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * Response if child teams exist + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + }; + }; + "projects/get-card": { + parameters: { + path: { + card_id: components["parameters"]["card_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project-card"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + "projects/update-card": { + parameters: { + path: { + card_id: components["parameters"]["card_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The project card's note + */ + note?: string | null; + /** + * Whether or not the card is archived + */ + archived?: boolean; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project-card"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + "projects/delete-card": { + parameters: { + path: { + card_id: components["parameters"]["card_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + /** + * Forbidden + */ + "403": { + "application/json": { + message?: string; + documentation_url?: string; + errors?: string[]; + }; + }; + "404": unknown; + }; + }; + "projects/move-card": { + parameters: { + path: { + card_id: components["parameters"]["card_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The position of the card in a column + */ + position: string; + /** + * The unique identifier of the column the card should be moved to + */ + column_id?: number; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": { [key: string]: any }; + }; + "304": never; + "401": unknown; + /** + * Forbidden + */ + "403": { + "application/json": { + message?: string; + documentation_url?: string; + errors?: { + code?: string; + message?: string; + resource?: string; + field?: string; + }[]; + }; + }; + "422": unknown; + /** + * Service Unavailable + */ + "503": { + "application/json": { + code?: string; + message?: string; + documentation_url?: string; + errors?: { code?: string; message?: string }[]; + }; + }; + }; + }; + "projects/get-column": { + parameters: { + path: { + column_id: components["parameters"]["column_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project-column"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + "projects/update-column": { + parameters: { + path: { + column_id: components["parameters"]["column_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * Name of the project column + */ + name: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project-column"]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + "projects/delete-column": { + parameters: { + path: { + column_id: components["parameters"]["column_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + "projects/list-cards": { + parameters: { + path: { + column_id: components["parameters"]["column_id"]; + }; + query: { + /** + * Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. + */ + archived_state?: "all" | "archived" | "not_archived"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project-card"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. + * + * Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + "projects/create-card": { + parameters: { + path: { + column_id: components["parameters"]["column_id"]; + }; + }; + requestBody: { + "application/json": + | { + /** + * The project card's note + */ + note: string | null; + } + | { + /** + * The unique identifier of the content associated with the card + */ + content_id: number; + /** + * The piece of content associated with the card + */ + content_type: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["project-card"]; + }; + "304": never; + "401": unknown; + "403": unknown; + /** + * Validation Failed + */ + "422": { + "application/json": + | components["schemas"]["validation-error"] + | components["schemas"]["validation-error-simple"]; + }; + /** + * Service Unavailable + */ + "503": { + "application/json": { + code?: string; + message?: string; + documentation_url?: string; + errors?: { code?: string; message?: string }[]; + }; + }; + }; + }; + "projects/move-column": { + parameters: { + path: { + column_id: components["parameters"]["column_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The position of the column in a project + */ + position: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": { [key: string]: any }; + }; + "304": never; + "401": unknown; + "403": unknown; + "422": unknown; + }; + }; + /** + * Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + "projects/get": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project"]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + "projects/update": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * Name of the project + */ + name?: string; + /** + * Body of the project + */ + body?: string | null; + /** + * State of the project; either 'open' or 'closed' + */ + state?: string; + /** + * The baseline permission that all organization members have on this project + */ + organization_permission?: "read" | "write" | "admin" | "none"; + /** + * Whether or not this project can be seen by everyone. + */ + private?: boolean; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project"]; + }; + "304": never; + "401": unknown; + /** + * Forbidden + */ + "403": { + "application/json": { + message?: string; + documentation_url?: string; + errors?: string[]; + }; + }; + /** + * Response if the authenticated user does not have access to the project + */ + "404": unknown; + "410": unknown; + "422": unknown; + }; + }; + /** + * Deletes a project board. Returns a `404 Not Found` status if projects are disabled. + */ + "projects/delete": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** + * Delete Success + */ + "204": never; + "304": never; + "401": unknown; + /** + * Forbidden + */ + "403": { + "application/json": { + message?: string; + documentation_url?: string; + errors?: string[]; + }; + }; + "404": unknown; + "410": unknown; + }; + }; + /** + * Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. + */ + "projects/list-collaborators": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + }; + query: { + /** + * Filters the collaborators by their affiliation. Can be one of: + * \* `outside`: Outside collaborators of a project that are not a member of the project's organization. + * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "415": unknown; + "422": unknown; + }; + }; + /** + * Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. + */ + "projects/add-collaborator": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + username: components["parameters"]["username"]; + }; + }; + requestBody: { + "application/json": { + /** + * The permission to grant the collaborator. + */ + permission?: "read" | "write" | "admin"; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "415": unknown; + "422": unknown; + }; + }; + /** + * Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. + */ + "projects/remove-collaborator": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "415": unknown; + "422": unknown; + }; + }; + /** + * Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. + */ + "projects/get-permission-for-user": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository-collaborator-permission"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "415": unknown; + "422": unknown; + }; + }; + "projects/list-columns": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project-column"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + "projects/create-column": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * Name of the project column + */ + name: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["project-column"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "422": unknown; + }; + }; + /** + * **Note:** Accessing this endpoint does not count against your REST API rate limit. + * + * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + */ + "rate-limit/get": { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["rate-limit-overview"]; + }; + "304": never; + "404": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). + * + * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). + */ + "reactions/delete-legacy": { + parameters: { + path: { + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "410": unknown; + "415": unknown; + }; + }; + /** + * When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file. + * + * The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. + */ + "repos/get": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["full-repository"]; + }; + "301": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. + */ + "repos/update": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the repository. + */ + name?: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to make the repository private or `false` to make it public. Default: `false`. + * **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. + */ + private?: boolean; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * 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. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * Updates the default branch for this repository. + */ + default_branch?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; + /** + * `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. + */ + archived?: boolean; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["full-repository"]; + }; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + * + * If an organization owner has configured the organization to prevent members from deleting organization-owned + * repositories, you will get a `403 Forbidden` response. + */ + "repos/delete": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + /** + * If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: + */ + "403": { + "application/json": { message?: string; documentation_url?: string }; + }; + "404": unknown; + }; + }; + /** + * Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + "actions/list-artifacts-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + artifacts: components["schemas"]["artifact"][]; + }; + }; + }; + }; + /** + * Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + "actions/get-artifact": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + artifact_id: components["parameters"]["artifact_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["artifact"]; + }; + }; + }; + /** + * Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + "actions/delete-artifact": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + artifact_id: components["parameters"]["artifact_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in + * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to + * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + * GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + "actions/download-artifact": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + artifact_id: components["parameters"]["artifact_id"]; + archive_format: string; + }; + }; + responses: { + /** + * response + */ + "302": never; + }; + }; + /** + * Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + "actions/get-job-for-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + job_id: components["parameters"]["job_id"]; + }; + }; + responses: { + /** + * response + */ + "202": { + "application/json": components["schemas"]["job"]; + }; + }; + }; + /** + * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look + * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can + * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must + * have the `actions:read` permission to use this endpoint. + */ + "actions/download-job-logs-for-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + job_id: components["parameters"]["job_id"]; + }; + }; + responses: { + /** + * response + */ + "302": never; + }; + }; + /** + * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. GitHub Apps must have the `administration` repository permission to use this API. + */ + "actions/get-github-actions-permissions-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-repository-permissions"]; + }; + }; + }; + /** + * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. + * + * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + */ + "actions/set-github-actions-permissions-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + enabled: components["schemas"]["actions-enabled"]; + allowed_actions?: components["schemas"]["allowed-actions"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + */ + "actions/get-allowed-actions-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + }; + /** + * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + * + * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + * + * To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + */ + "actions/set-allowed-actions-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": components["schemas"]["selected-actions"]; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. + */ + "actions/list-self-hosted-runners-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + }; + }; + }; + }; + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + */ + "actions/list-runner-applications-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner-application"][]; + }; + }; + }; + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate + * using an access token with the `repo` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN + * ``` + */ + "actions/create-registration-token-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + /** + * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + "actions/create-remove-token-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + /** + * Gets a specific self-hosted runner configured in a repository. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. + */ + "actions/get-self-hosted-runner-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner"]; + }; + }; + }; + /** + * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + * + * You must authenticate using an access token with the `repo` + * scope to use this endpoint. + */ + "actions/delete-self-hosted-runner-from-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * + * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + "actions/list-workflow-runs-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + actor?: components["parameters"]["actor"]; + branch?: components["parameters"]["workflow-run-branch"]; + event?: components["parameters"]["event"]; + status?: components["parameters"]["workflow-run-status"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + workflow_runs: components["schemas"]["workflow-run"][]; + }; + }; + }; + }; + /** + * Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + "actions/get-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["workflow-run"]; + }; + }; + }; + /** + * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is + * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use + * this endpoint. + */ + "actions/delete-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + "actions/list-workflow-run-artifacts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + artifacts: components["schemas"]["artifact"][]; + }; + }; + }; + }; + /** + * Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + "actions/cancel-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** + * response + */ + "202": unknown; + }; + }; + /** + * Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + */ + "actions/list-jobs-for-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + query: { + /** + * Filters jobs by their `completed_at` timestamp. Can be one of: + * \* `latest`: Returns jobs from the most recent execution of the workflow run. + * \* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run. + */ + filter?: "latest" | "all"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + jobs: components["schemas"]["job"][]; + }; + }; + }; + }; + /** + * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for + * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use + * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have + * the `actions:read` permission to use this endpoint. + */ + "actions/download-workflow-run-logs": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** + * response + */ + "302": never; + }; + }; + /** + * Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + "actions/delete-workflow-run-logs": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + "actions/re-run-workflow": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** + * response + */ + "201": unknown; + }; + }; + /** + * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + "actions/get-workflow-run-usage": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["workflow-run-usage"]; + }; + }; + }; + /** + * Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. + */ + "actions/list-repo-secrets": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + /** + * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. + */ + "actions/get-repo-public-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + /** + * Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. + */ + "actions/get-repo-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + /** + * Creates or updates a repository secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use + * this endpoint. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + "actions/create-or-update-repo-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + secret_name: components["parameters"]["secret_name"]; + }; + }; + requestBody: { + "application/json": { + /** + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint. + */ + encrypted_value?: string; + /** + * ID of the key you used to encrypt the secret. + */ + key_id?: string; + }; + }; + responses: { + /** + * Response when creating a secret + */ + "201": unknown; + /** + * Response when updating a secret + */ + "204": never; + }; + }; + /** + * Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. + */ + "actions/delete-repo-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + "actions/list-repo-workflows": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + workflows: components["schemas"]["workflow"][]; + }; + }; + }; + }; + /** + * Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + "actions/get-workflow": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + workflow_id: components["parameters"]["workflow-id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["workflow"]; + }; + }; + }; + /** + * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + "actions/disable-workflow": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + workflow_id: components["parameters"]["workflow-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + */ + "actions/create-workflow-dispatch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + workflow_id: components["parameters"]["workflow-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The git reference for the workflow. The reference can be a branch or tag name. + */ + ref: string; + /** + * Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. + */ + inputs?: { [key: string]: string }; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + "actions/enable-workflow": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + workflow_id: components["parameters"]["workflow-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * + * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + */ + "actions/list-workflow-runs": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + workflow_id: components["parameters"]["workflow-id"]; + }; + query: { + actor?: components["parameters"]["actor"]; + branch?: components["parameters"]["workflow-run-branch"]; + event?: components["parameters"]["event"]; + status?: components["parameters"]["workflow-run-status"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + workflow_runs: components["schemas"]["workflow-run"][]; + }; + }; + }; + }; + /** + * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + "actions/get-workflow-usage": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + workflow_id: components["parameters"]["workflow-id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["workflow-usage"]; + }; + }; + }; + /** + * Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + */ + "issues/list-assignees": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "404": unknown; + }; + }; + /** + * Checks if a user has permission to be assigned to an issue in this repository. + * + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + * + * Otherwise a `404` status code is returned. + */ + "issues/check-user-can-be-assigned": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + assignee: string; + }; + }; + responses: { + /** + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + */ + "204": never; + /** + * Otherwise a `404` status code is returned. + */ + "404": { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + /** + * Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)". + */ + "repos/enable-automated-security-fixes": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)". + */ + "repos/disable-automated-security-fixes": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + "repos/list-branches": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. + */ + protected?: boolean; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["short-branch"][]; + }; + "404": unknown; + }; + }; + "repos/get-branch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["branch-with-protection"]; + }; + "404": unknown; + "415": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "repos/get-branch-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["branch-protection"]; + }; + "404": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Protecting a branch requires admin or owner permissions to the repository. + * + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * + * **Note**: The list of users, apps, and teams in total is limited to 100 items. + */ + "repos/update-branch-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * Require status checks to pass before merging. Set to `null` to disable. + */ + required_status_checks: { + /** + * Require branches to be up to date before merging. + */ + strict: boolean; + /** + * The list of status checks to require in order to merge into this branch + */ + contexts: string[]; + } | null; + /** + * Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + */ + enforce_admins: boolean | null; + /** + * Require at least one approving review on a pull request, before merging. Set to `null` to disable. + */ + required_pull_request_reviews: { + /** + * 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. + */ + dismissal_restrictions?: { + /** + * The list of user `login`s with dismissal access + */ + users?: string[]; + /** + * The list of team `slug`s with dismissal access + */ + teams?: string[]; + }; + /** + * Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. + */ + dismiss_stale_reviews?: boolean; + /** + * Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them. + */ + require_code_owner_reviews?: boolean; + /** + * Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6. + */ + required_approving_review_count?: number; + } | null; + /** + * Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + */ + restrictions: { + /** + * The list of user `login`s with push access + */ + users: string[]; + /** + * The list of team `slug`s with push access + */ + teams: string[]; + /** + * The list of app `slug`s with push access + */ + apps?: string[]; + } | null; + /** + * Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. + */ + required_linear_history?: boolean; + /** + * Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." + */ + allow_force_pushes?: boolean | null; + /** + * Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. + */ + allow_deletions?: boolean; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["protected-branch"]; + }; + "403": unknown; + "404": unknown; + "415": unknown; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "repos/delete-branch-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "403": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "repos/get-admin-branch-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["protected-branch-admin-enforced"]; + }; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + */ + "repos/set-admin-branch-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["protected-branch-admin-enforced"]; + }; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + */ + "repos/delete-admin-branch-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * No Content + */ + "204": never; + "404": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "repos/get-pull-request-review-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/vnd.github.luke-cage-preview+json": components["schemas"]["protected-branch-pull-request-review"]; + }; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + */ + "repos/update-pull-request-review-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * 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. + */ + dismissal_restrictions?: { + /** + * The list of user `login`s with dismissal access + */ + users?: string[]; + /** + * The list of team `slug`s with dismissal access + */ + teams?: string[]; + }; + /** + * Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. + */ + dismiss_stale_reviews?: boolean; + /** + * Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed. + */ + require_code_owner_reviews?: boolean; + /** + * Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6. + */ + required_approving_review_count?: number; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["protected-branch-pull-request-review"]; + }; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "repos/delete-pull-request-review-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * No Content + */ + "204": never; + "404": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help. + * + * **Note**: You must enable branch protection to require signed commits. + */ + "repos/get-commit-signature-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["protected-branch-admin-enforced"]; + }; + "404": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. + */ + "repos/create-commit-signature-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["protected-branch-admin-enforced"]; + }; + "404": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. + */ + "repos/delete-commit-signature-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * No Content + */ + "204": never; + "404": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "repos/get-status-checks-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["status-check-policy"]; + }; + "404": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + */ + "repos/update-status-check-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * Require branches to be up to date before merging. + */ + strict?: boolean; + /** + * The list of status checks to require in order to merge into this branch + */ + contexts?: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["status-check-policy"]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "repos/remove-status-check-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * No Content + */ + "204": never; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "repos/get-all-status-check-contexts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": string[]; + }; + "404": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "repos/add-status-check-contexts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * contexts parameter + */ + contexts: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": string[]; + }; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "repos/set-status-check-contexts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * contexts parameter + */ + contexts: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": string[]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "repos/remove-status-check-contexts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * contexts parameter + */ + contexts: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": string[]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists who has access to this protected branch. + * + * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + */ + "repos/get-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["branch-restriction-policy"]; + }; + "404": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Disables the ability to restrict who can push to this branch. + */ + "repos/delete-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * No Content + */ + "204": never; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + */ + "repos/get-apps-with-access-to-protected-branch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["integration"][]; + }; + "404": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + "repos/add-app-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * apps parameter + */ + apps: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["integration"][]; + }; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + "repos/set-app-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * apps parameter + */ + apps: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["integration"][]; + }; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + "repos/remove-app-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * apps parameter + */ + apps: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["integration"][]; + }; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the teams who have push access to this branch. The list includes child teams. + */ + "repos/get-teams-with-access-to-protected-branch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "404": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified teams push access for this branch. You can also give push access to child teams. + * + * | Type | Description | + * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | + * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + "repos/add-team-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * teams parameter + */ + teams: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. + * + * | Type | Description | + * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | + * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + "repos/set-team-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * teams parameter + */ + teams: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of a team to push to this branch. You can also remove push access for child teams. + * + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + "repos/remove-team-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * teams parameter + */ + teams: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the people who have push access to this branch. + */ + "repos/get-users-with-access-to-protected-branch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "404": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified people push access for this branch. + * + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + "repos/add-user-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * users parameter + */ + users: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. + * + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + "repos/set-user-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * users parameter + */ + users: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "422": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of a user to push to this branch. + * + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + "repos/remove-user-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + requestBody: { + "application/json": { + /** + * users parameter + */ + users: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "422": unknown; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * + * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + */ + "checks/create": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the check. For example, "code-coverage". + */ + name: string; + /** + * The SHA of the commit. + */ + head_sha: string; + /** + * The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. + */ + details_url?: string; + /** + * A reference for the run on the integrator's system. + */ + external_id?: string; + /** + * The current status. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * 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`. + */ + started_at?: string; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`. + */ + conclusion?: + | "success" + | "failure" + | "neutral" + | "cancelled" + | "skipped" + | "timed_out" + | "action_required"; + /** + * 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`. + */ + completed_at?: string; + /** + * 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://docs.github.com/rest/reference/checks#output-object) description. + */ + output?: { + /** + * The title of the check run. + */ + title: string; + /** + * The summary of the check run. This parameter supports Markdown. + */ + summary: string; + /** + * The details of the check run. This parameter supports Markdown. + */ + text?: string; + /** + * 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://docs.github.com/rest/reference/checks#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://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter. + */ + annotations?: { + /** + * The path of the file to add an annotation to. For example, `assets/css/main.css`. + */ + path: string; + /** + * The start line of the annotation. + */ + start_line: number; + /** + * The end line of the annotation. + */ + end_line: number; + /** + * 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. + */ + start_column?: number; + /** + * 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. + */ + end_column?: number; + /** + * The level of the annotation. Can be one of `notice`, `warning`, or `failure`. + */ + annotation_level: "notice" | "warning" | "failure"; + /** + * A short description of the feedback for these lines of code. The maximum size is 64 KB. + */ + message: string; + /** + * The title that represents the annotation. The maximum size is 255 characters. + */ + title?: string; + /** + * Details about this annotation. The maximum size is 64 KB. + */ + raw_details?: string; + }[]; + /** + * Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details. + */ + images?: { + /** + * The alternative text for the image. + */ + alt: string; + /** + * The full URL of the image. + */ + image_url: string; + /** + * A short image description. + */ + caption?: string; + }[]; + }; + /** + * 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://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." + */ + actions?: { + /** + * The text to be displayed on a button in the web UI. The maximum size is 20 characters. + */ + label: string; + /** + * A short explanation of what this action would do. The maximum size is 40 characters. + */ + description: string; + /** + * A reference for the action on the integrator's system. The maximum size is 20 characters. + */ + identifier: string; + }[]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["check-run"]; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + "checks/get": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + check_run_id: components["parameters"]["check_run_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["check-run"]; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + */ + "checks/update": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + check_run_id: components["parameters"]["check_run_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the check. For example, "code-coverage". + */ + name?: string; + /** + * The URL of the integrator's site that has the full details of the check. + */ + details_url?: string; + /** + * A reference for the run on the integrator's system. + */ + external_id?: string; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * The current status. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * **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`, `skipped`, `timed_out`, or `action_required`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`. + */ + conclusion?: + | "success" + | "failure" + | "neutral" + | "cancelled" + | "skipped" + | "timed_out" + | "action_required"; + /** + * 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`. + */ + completed_at?: string; + /** + * 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://docs.github.com/rest/reference/checks#output-object-1) description. + */ + output?: { + /** + * **Required**. + */ + title?: string; + /** + * Can contain Markdown. + */ + summary: string; + /** + * Can contain Markdown. + */ + text?: string; + /** + * 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://docs.github.com/rest/reference/checks#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://docs.github.com/rest/reference/checks#annotations-object-1) description for details. + */ + annotations?: { + /** + * The path of the file to add an annotation to. For example, `assets/css/main.css`. + */ + path: string; + /** + * The start line of the annotation. + */ + start_line: number; + /** + * The end line of the annotation. + */ + end_line: number; + /** + * 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. + */ + start_column?: number; + /** + * 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. + */ + end_column?: number; + /** + * The level of the annotation. Can be one of `notice`, `warning`, or `failure`. + */ + annotation_level: "notice" | "warning" | "failure"; + /** + * A short description of the feedback for these lines of code. The maximum size is 64 KB. + */ + message: string; + /** + * The title that represents the annotation. The maximum size is 255 characters. + */ + title?: string; + /** + * Details about this annotation. The maximum size is 64 KB. + */ + raw_details?: string; + }[]; + /** + * Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. + */ + images?: { + /** + * The alternative text for the image. + */ + alt: string; + /** + * The full URL of the image. + */ + image_url: string; + /** + * A short image description. + */ + caption?: string; + }[]; + }; + /** + * 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://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." + */ + actions?: { + /** + * The text to be displayed on a button in the web UI. The maximum size is 20 characters. + */ + label: string; + /** + * A short explanation of what this action would do. The maximum size is 40 characters. + */ + description: string; + /** + * A reference for the action on the integrator's system. The maximum size is 20 characters. + */ + identifier: string; + }[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["check-run"]; + }; + }; + }; + /** + * Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. + */ + "checks/list-annotations": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + check_run_id: components["parameters"]["check_run_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["check-annotation"][]; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + */ + "checks/create-suite": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The sha of the head commit. + */ + head_sha: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["check-suite"]; + }; + }; + }; + /** + * Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. + */ + "checks/set-suites-preferences": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details. + */ + auto_trigger_checks?: { + /** + * The `id` of the GitHub App. + */ + app_id: number; + /** + * Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. + */ + setting: boolean; + }[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["check-suite-preference"]; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. + */ + "checks/get-suite": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + check_suite_id: components["parameters"]["check_suite_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["check-suite"]; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + "checks/list-for-suite": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + check_suite_id: components["parameters"]["check_suite_id"]; + }; + query: { + check_name?: components["parameters"]["check_name"]; + status?: components["parameters"]["status"]; + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + check_runs: components["schemas"]["check-run"][]; + }; + }; + }; + }; + /** + * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * + * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. + */ + "checks/rerequest-suite": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + check_suite_id: components["parameters"]["check_suite_id"]; + }; + }; + responses: { + /** + * response + */ + "201": unknown; + }; + }; + /** + * Lists all open code scanning alerts for the default branch (usually `main` or `master`). You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + */ + "code-scanning/list-alerts-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state. + */ + state?: components["schemas"]["code-scanning-alert-state"]; + /** + * Set a full Git reference to list alerts for a specific branch. The `ref` must be formatted as `refs/heads/`. + */ + ref?: components["schemas"]["code-scanning-alert-ref"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["code-scanning-alert-code-scanning-alert-items"][]; + }; + /** + * Response if github advanced security is not enabled for this repository + */ + "403": unknown; + /** + * Response if the ref does not match an existing ref + */ + "404": unknown; + "503": unknown; + }; + }; + /** + * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * The security `alert_number` is found at the end of the security alert's URL. For example, the security alert ID for `https://github.com/Octo-org/octo-repo/security/code-scanning/88` is `88`. + */ + "code-scanning/get-alert": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: number; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["code-scanning-alert-code-scanning-alert"]; + }; + /** + * Response if github advanced security is not enabled for this repository + */ + "403": unknown; + "404": unknown; + "503": unknown; + }; + }; + /** + * Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + */ + "code-scanning/update-alert": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert_number"]; + }; + }; + requestBody: { + "application/json": { + state: components["schemas"]["code-scanning-alert-set-state"]; + dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["code-scanning-alert-code-scanning-alert"]; + }; + /** + * Response if the repository is archived, or if github advanced security is not enabled for this repository + */ + "403": unknown; + /** + * Response when code scanning is not available and you should try again at a later time + */ + "503": unknown; + }; + }; + /** + * List the details of recent code scanning analyses for a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + */ + "code-scanning/list-recent-analyses": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * Set a full Git reference to list alerts for a specific branch. The `ref` must be formatted as `refs/heads/`. + */ + ref?: components["schemas"]["code-scanning-analysis-ref"]; + /** + * Set a single code scanning tool name to filter alerts by tool. + */ + tool_name?: components["schemas"]["code-scanning-analysis-tool-name"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["code-scanning-analysis-code-scanning-analysis"][]; + }; + /** + * Response if github advanced security is not enabled for this repository + */ + "403": unknown; + }; + }; + /** + * Upload a SARIF file containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + */ + "code-scanning/upload-sarif": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; + ref: components["schemas"]["code-scanning-analysis-ref"]; + sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; + /** + * The base directory used in the analysis, as it appears in the SARIF file. + * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. + */ + checkout_uri?: string; + /** + * The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + tool_name: components["schemas"]["code-scanning-analysis-tool-name"]; + }; + }; + responses: { + /** + * response + */ + "202": unknown; + /** + * Response if the `sarif` field is invalid + */ + "400": unknown; + /** + * Response if the repository is archived, or if github advanced security is not enabled for this repository + */ + "403": unknown; + /** + * Response if `commit_sha` or `ref` cannot be found + */ + "404": unknown; + /** + * Response if the `sarif` field is too large + */ + "413": unknown; + }; + }; + /** + * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + * + * Team members will include the members of child teams. + */ + "repos/list-collaborators": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * Filter collaborators returned by their affiliation. Can be one of: + * \* `outside`: All outside collaborators of an organization-owned repository. + * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["collaborator"][]; + }; + "404": unknown; + }; + }; + /** + * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + * + * Team members will include the members of child teams. + */ + "repos/check-collaborator": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Response if user is a collaborator + */ + "204": never; + /** + * Response if user is not a collaborator + */ + "404": unknown; + }; + }; + /** + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * For more information the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). + * + * **Rate limits** + * + * To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. + */ + "repos/add-collaborator": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + username: components["parameters"]["username"]; + }; + }; + requestBody: { + "application/json": { + /** + * The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: + * \* `pull` - can pull, but not push to or administer this repository. + * \* `push` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push and administer this repository. + * \* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. + * \* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. + */ + permission?: "pull" | "push" | "admin" | "maintain" | "triage"; + permissions?: string; + }; + }; + responses: { + /** + * Response when a new invitation is created + */ + "201": { + "application/json": components["schemas"]["repository-invitation"]; + }; + /** + * Response when person is already a collaborator + */ + "204": never; + "403": unknown; + "422": unknown; + }; + }; + "repos/remove-collaborator": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. + */ + "repos/get-collaborator-permission-level": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Response if user has admin permissions + */ + "200": { + "application/json": components["schemas"]["repository-collaborator-permission"]; + }; + "404": unknown; + }; + }; + /** + * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * + * Comments are ordered by ascending ID. + */ + "repos/list-commit-comments-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit-comment"][]; + }; + }; + }; + "repos/get-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit-comment"]; + }; + "404": unknown; + }; + }; + "repos/update-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The contents of the comment + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit-comment"]; + }; + "404": unknown; + }; + }; + "repos/delete-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + /** + * List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + */ + "reactions/list-for-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + query: { + /** + * Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + "404": unknown; + "415": unknown; + }; + }; + /** + * Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment. + */ + "reactions/create-for-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + }; + }; + responses: { + /** + * Reaction exists + */ + "200": { + "application/json": components["schemas"]["reaction"]; + }; + /** + * Reaction created + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + "415": unknown; + "422": unknown; + }; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * + * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + */ + "reactions/delete-for-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "repos/list-commits": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). + */ + sha?: string; + /** + * Only commits containing this file path will be returned. + */ + path?: string; + /** + * GitHub login or email address by which to filter by commit author. + */ + author?: string; + since?: components["parameters"]["since"]; + /** + * 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`. + */ + until?: string; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit"][]; + }; + "400": unknown; + "404": unknown; + "409": unknown; + "500": unknown; + }; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + */ + "repos/list-branches-for-head-commit": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + commit_sha: components["parameters"]["commit_sha"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["branch-short"][]; + }; + "415": unknown; + "422": unknown; + }; + }; + /** + * Use the `:commit_sha` to specify the commit that will have its comments listed. + */ + "repos/list-comments-for-commit": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + commit_sha: components["parameters"]["commit_sha"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit-comment"][]; + }; + }; + }; + /** + * Create a comment for a commit using its `:commit_sha`. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "repos/create-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + commit_sha: components["parameters"]["commit_sha"]; + }; + }; + requestBody: { + "application/json": { + /** + * The contents of the comment. + */ + body: string; + /** + * Relative path of the file to comment on. + */ + path?: string; + /** + * Line index in the diff to comment on. + */ + position?: number; + /** + * **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. + */ + line?: number; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["commit-comment"]; + }; + "403": unknown; + "422": unknown; + }; + }; + /** + * Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. + */ + "repos/list-pull-requests-associated-with-commit": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + commit_sha: components["parameters"]["commit_sha"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-simple"][]; + }; + "415": unknown; + }; + }; + /** + * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. + * + * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * + * You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. + * + * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "repos/get-commit": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * ref+ parameter + */ + ref: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit"]; + }; + "404": unknown; + "422": unknown; + "500": unknown; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + "checks/list-for-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * ref+ parameter + */ + ref: string; + }; + query: { + check_name?: components["parameters"]["check_name"]; + status?: components["parameters"]["status"]; + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + check_runs: components["schemas"]["check-run"][]; + }; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. + */ + "checks/list-suites-for-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * ref+ parameter + */ + ref: string; + }; + query: { + /** + * Filters check suites by GitHub App `id`. + */ + app_id?: number; + check_name?: components["parameters"]["check_name"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + check_suites: components["schemas"]["check-suite"][]; + }; + }; + }; + }; + /** + * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. + * + * The most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts. + * + * Additionally, a combined `state` is returned. The `state` is one of: + * + * * **failure** if any of the contexts report as `error` or `failure` + * * **pending** if there are no statuses or a context is `pending` + * * **success** if the latest status for all contexts is `success` + */ + "repos/get-combined-status-for-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * ref+ parameter + */ + ref: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["combined-commit-status"]; + }; + "404": unknown; + }; + }; + /** + * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. + * + * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + */ + "repos/list-commit-statuses-for-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * ref+ parameter + */ + ref: string; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["status"][]; + }; + "301": never; + }; + }; + /** + * Returns the contents of the repository's code of conduct file, if one is detected. + * + * A code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching. + */ + "codes-of-conduct/get-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["code-of-conduct"]; + }; + }; + }; + /** + * This endpoint will return all community profile metrics, including an + * overall health score, repository description, the presence of documentation, detected + * code of conduct, detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE, + * README, and CONTRIBUTING files. + * + * The `health_percentage` score is defined as a percentage of how many of + * these four documents are present: README, CONTRIBUTING, LICENSE, and + * CODE_OF_CONDUCT. For example, if all four documents are present, then + * the `health_percentage` is `100`. If only one is present, then the + * `health_percentage` is `25`. + * + * `content_reports_enabled` is only returned for organization-owned repositories. + */ + "repos/get-community-profile-metrics": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["community-profile"]; + }; + }; + }; + /** + * Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. + * + * The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * + * The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. + * + * **Working with large comparisons** + * + * The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) to enumerate all commits in the range. + * + * For comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long + * to generate. You can typically resolve this error by using a smaller commit range. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "repos/compare-commits": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + base: string; + head: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit-comparison"]; + }; + "404": unknown; + "500": unknown; + }; + }; + /** + * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit + * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. + * + * Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for + * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media + * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent + * object format. + * + * **Note**: + * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). + * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees + * API](https://docs.github.com/rest/reference/git#get-a-tree). + * * This API supports files up to 1 megabyte in size. + * + * #### If the content is a directory + * The response will be an array of objects, one object for each item in the directory. + * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value + * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). + * In the next major version of the API, the type will be returned as "submodule". + * + * #### If the content is a symlink + * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the + * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object + * describing the symlink itself. + * + * #### If the content is a submodule + * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific + * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out + * the submodule at that specific commit. + * + * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the + * github.com URLs (`html_url` and `_links["html"]`) will have null values. + */ + "repos/get-content": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * path+ parameter + */ + path: string; + }; + query: { + /** + * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) + */ + ref?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/vnd.github.v3.object": components["schemas"]["content-tree"]; + "application/json": + | components["schemas"]["content-directory"] + | components["schemas"]["content-file"] + | components["schemas"]["content-symlink"] + | components["schemas"]["content-submodule"]; + }; + "302": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * Creates a new file or replaces an existing file in a repository. + */ + "repos/create-or-update-file-contents": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * path+ parameter + */ + path: string; + }; + }; + requestBody: { + "application/json": { + /** + * The commit message. + */ + message: string; + /** + * The new file content, using Base64 encoding. + */ + content: string; + /** + * **Required if you are updating a file**. The blob SHA of the file being replaced. + */ + sha?: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * The person that committed the file. Default: the authenticated user. + */ + committer?: { + /** + * The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. + */ + name: string; + /** + * The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. + */ + email: string; + date?: string; + }; + /** + * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. + */ + author?: { + /** + * The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. + */ + name: string; + /** + * The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. + */ + email: string; + date?: string; + }; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["file-commit"]; + }; + /** + * response + */ + "201": { + "application/json": components["schemas"]["file-commit"]; + }; + "404": unknown; + "409": unknown; + "422": unknown; + }; + }; + /** + * Deletes a file in a repository. + * + * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. + * + * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. + * + * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + */ + "repos/delete-file": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * path+ parameter + */ + path: string; + }; + }; + requestBody: { + "application/json": { + /** + * The commit message. + */ + message: string; + /** + * The blob SHA of the file being replaced. + */ + sha: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * object containing information about the committer. + */ + committer?: { + /** + * The name of the author (or committer) of the commit + */ + name?: string; + /** + * The email of the author (or committer) of the commit + */ + email?: string; + }; + /** + * object containing information about the author. + */ + author?: { + /** + * The name of the author (or committer) of the commit + */ + name?: string; + /** + * The email of the author (or committer) of the commit + */ + email?: string; + }; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["file-commit"]; + }; + "404": unknown; + "409": unknown; + "422": unknown; + "503": unknown; + }; + }; + /** + * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. + * + * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. + */ + "repos/list-contributors": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * Set to `1` or `true` to include anonymous contributors in results. + */ + anon?: string; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * Response if repository contains content + */ + "200": { + "application/json": components["schemas"]["contributor"][]; + }; + /** + * Response if repository is empty + */ + "204": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * Simple filtering of deployments is available via query parameters: + */ + "repos/list-deployments": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * The SHA recorded at creation time. + */ + sha?: string; + /** + * The name of the ref. This can be a branch, tag, or SHA. + */ + ref?: string; + /** + * The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). + */ + task?: string; + /** + * The name of the environment that was deployed to (e.g., `staging` or `production`). + */ + environment?: string; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["deployment"][]; + }; + }; + }; + /** + * Deployments offer a few configurable parameters with certain defaults. + * + * The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them + * before we merge a pull request. + * + * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have + * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter + * makes it easier to track which environments have requested deployments. The default environment is `production`. + * + * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If + * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, + * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will + * return a failure response. + * + * By default, [commit statuses](https://docs.github.com/rest/reference/repos#statuses) for every submitted context must be in a `success` + * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to + * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do + * not require any contexts or create any commit statuses, the deployment will always succeed. + * + * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text + * field that will be passed on when a deployment event is dispatched. + * + * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might + * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an + * application with debugging enabled. + * + * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. + * + * #### Merged branch response + * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating + * a deployment. This auto-merge happens when: + * * Auto-merge option is enabled in the repository + * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example + * * There are no merge conflicts + * + * If there are no new commits in the base branch, a new request to create a deployment should give a successful + * response. + * + * #### Merge conflict response + * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + * + * #### Failed commit status checks + * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` + * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + */ + "repos/create-deployment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The ref to deploy. This can be a branch, tag, or SHA. + */ + ref: string; + /** + * Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). + */ + task?: string; + /** + * Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. + */ + auto_merge?: boolean; + /** + * The [status](https://docs.github.com/rest/reference/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. + */ + required_contexts?: string[]; + /** + * JSON payload with extra information about the deployment. + */ + payload?: string; + /** + * Name for the target deployment environment (e.g., `production`, `staging`, `qa`). + */ + environment?: string; + /** + * Short description of the deployment. + */ + description?: string | null; + /** + * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. + */ + transient_environment?: boolean; + /** + * Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. + */ + production_environment?: boolean; + created_at?: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["deployment"]; + }; + /** + * Merged branch response + */ + "202": { + "application/json": { message?: string }; + }; + /** + * response + */ + "409": { + "application/json": { message?: string; documentation_url?: string }; + }; + "422": unknown; + }; + }; + "repos/get-deployment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + deployment_id: components["parameters"]["deployment_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["deployment"]; + }; + "404": unknown; + }; + }; + /** + * To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment. + * + * To set a deployment as inactive, you must: + * + * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. + * * Mark the active deployment as inactive by adding any non-successful deployment status. + * + * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." + */ + "repos/delete-deployment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + deployment_id: components["parameters"]["deployment_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + "422": unknown; + }; + }; + /** + * Users with pull access can view deployment statuses for a deployment: + */ + "repos/list-deployment-statuses": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + deployment_id: components["parameters"]["deployment_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["deployment-status"][]; + }; + "404": unknown; + }; + }; + /** + * Users with `push` access can create deployment statuses for a given deployment. + * + * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. + */ + "repos/create-deployment-status": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + deployment_id: components["parameters"]["deployment_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * 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://docs.github.com/rest/overview/api-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://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. + */ + state: + | "error" + | "failure" + | "inactive" + | "in_progress" + | "queued" + | "pending" + | "success"; + /** + * 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`. + */ + target_url?: string; + /** + * 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: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. + */ + log_url?: string; + /** + * A short description of the status. The maximum description length is 140 characters. + */ + description?: string; + /** + * 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://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. + */ + environment?: "production" | "staging" | "qa"; + /** + * Sets the URL for accessing your environment. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. + */ + environment_url?: string; + /** + * 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` + * **Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. + */ + auto_inactive?: boolean; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["deployment-status"]; + }; + "422": unknown; + }; + }; + /** + * Users with pull access can view a deployment status for a deployment: + */ + "repos/get-deployment-status": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + deployment_id: components["parameters"]["deployment_id"]; + status_id: number; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["deployment-status"]; + }; + "404": unknown; + "415": unknown; + }; + }; + /** + * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." + * + * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. + * + * To give you write access to the repository, you must use a personal access token with the `repo` scope. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. + * + * This input example shows how you can use the `client_payload` as a test to debug your workflow. + */ + "repos/create-dispatch-event": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * A custom webhook event name. + */ + event_type: string; + /** + * JSON payload with extra information about the webhook event that your action or worklow may use. + */ + client_payload?: { [key: string]: any }; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "422": unknown; + }; + }; + "activity/list-repo-events": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + "repos/list-forks": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * The sort order. Can be either `newest`, `oldest`, or `stargazers`. + */ + sort?: "newest" | "oldest" | "stargazers"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + "400": unknown; + }; + }; + /** + * Create a fork for the authenticated user. + * + * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com). + */ + "repos/create-fork": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * Optional parameter to specify the organization name if forking into an organization. + */ + organization?: string; + }; + }; + responses: { + /** + * response + */ + "202": { + "application/json": components["schemas"]["repository"]; + }; + "400": unknown; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + "git/create-blob": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The new blob's content. + */ + content: string; + /** + * The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + */ + encoding?: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["short-blob"]; + }; + "403": unknown; + "404": unknown; + "409": unknown; + "422": unknown; + }; + }; + /** + * The `content` in the response will always be Base64 encoded. + * + * _Note_: This API supports blobs up to 100 megabytes in size. + */ + "git/get-blob": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + file_sha: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["blob"]; + }; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "git/create-commit": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The commit message + */ + message: string; + /** + * The SHA of the tree object this commit points to + */ + tree: string; + /** + * 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. + */ + parents?: string[]; + /** + * 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. + */ + author?: { + /** + * The name of the author (or committer) of the commit + */ + name?: string; + /** + * The email of the author (or committer) of the commit + */ + email?: string; + /** + * 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`. + */ + date?: string; + }; + /** + * 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. + */ + committer?: { + /** + * The name of the author (or committer) of the commit + */ + name?: string; + /** + * The email of the author (or committer) of the commit + */ + email?: string; + /** + * 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`. + */ + date?: string; + }; + /** + * 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. + */ + signature?: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["git-commit"]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "git/get-commit": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + commit_sha: components["parameters"]["commit_sha"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["git-commit"]; + }; + "404": unknown; + }; + }; + /** + * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. + * + * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. + * + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * + * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + */ + "git/list-matching-refs": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * ref+ parameter + */ + ref: string; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["git-ref"][]; + }; + }; + }; + /** + * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. + * + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + */ + "git/get-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * ref+ parameter + */ + ref: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["git-ref"]; + }; + "404": unknown; + }; + }; + /** + * Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. + */ + "git/create-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * 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. + */ + ref: string; + /** + * The SHA1 value for this reference. + */ + sha: string; + key?: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["git-ref"]; + }; + "422": unknown; + }; + }; + "git/update-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * ref+ parameter + */ + ref: string; + }; + }; + requestBody: { + "application/json": { + /** + * The SHA1 value to set this reference to + */ + sha: string; + /** + * 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. + */ + force?: boolean; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["git-ref"]; + }; + "422": unknown; + }; + }; + "git/delete-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * ref+ parameter + */ + ref: string; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "422": unknown; + }; + }; + /** + * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "git/create-tag": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The tag's name. This is typically a version (e.g., "v0.0.1"). + */ + tag: string; + /** + * The tag message. + */ + message: string; + /** + * The SHA of the git object this is tagging. + */ + object: string; + /** + * The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. + */ + type: "commit" | "tree" | "blob"; + /** + * An object with information about the individual creating the tag. + */ + tagger?: { + /** + * The name of the author of the tag + */ + name?: string; + /** + * The email of the author of the tag + */ + email?: string; + /** + * 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`. + */ + date?: string; + }; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["git-tag"]; + }; + "422": unknown; + }; + }; + /** + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "git/get-tag": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + tag_sha: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["git-tag"]; + }; + "404": unknown; + }; + }; + /** + * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. + * + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." + */ + "git/create-tree": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. + */ + tree: { + /** + * The file referenced in the tree. + */ + path?: string; + /** + * 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. + */ + mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + /** + * Either `blob`, `tree`, or `commit`. + */ + type?: "blob" | "tree" | "commit"; + /** + * The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. + * + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. + */ + sha?: string | null; + /** + * 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`. + * + * **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?: string; + }[]; + /** + * The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. + */ + base_tree?: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["git-tree"]; + }; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * Returns a single tree using the SHA1 value for that tree. + * + * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. + */ + "git/get-tree": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + tree_sha: string; + }; + query: { + /** + * Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. + */ + recursive?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["git-tree"]; + }; + "404": unknown; + "422": unknown; + }; + }; + "repos/list-webhooks": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["hook"][]; + }; + "404": unknown; + }; + }; + /** + * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can + * share the same `config` as long as those webhooks do not have any `events` that overlap. + */ + "repos/create-webhook": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. + */ + name?: string; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). + */ + config: { + url: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + token?: string; + digest?: string; + }; + /** + * Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["hook"]; + }; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." + */ + "repos/get-webhook": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["hook"]; + }; + "404": unknown; + }; + }; + /** + * Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." + */ + "repos/update-webhook": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). + */ + config?: { + url: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + address?: string; + room?: string; + }; + /** + * Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. + */ + events?: string[]; + /** + * Determines a list of events to be added to the list of events that the Hook triggers for. + */ + add_events?: string[]; + /** + * Determines a list of events to be removed from the list of events that the Hook triggers for. + */ + remove_events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["hook"]; + }; + "404": unknown; + "422": unknown; + }; + }; + "repos/delete-webhook": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + /** + * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." + * + * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + */ + "repos/get-webhook-config-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** + * Default response + */ + "200": { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + /** + * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." + * + * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + */ + "repos/update-webhook-config-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + requestBody: { + "application/json": { + url?: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + }; + responses: { + /** + * Default response + */ + "200": { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + /** + * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + */ + "repos/ping-webhook": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + /** + * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. + * + * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + */ + "repos/test-push-webhook": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + /** + * View the progress of an import. + * + * **Import status** + * + * This section includes details about the possible values of the `status` field of the Import Progress response. + * + * An import that does not have errors will progress through these steps: + * + * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. + * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). + * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. + * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". + * * `complete` - the import is complete, and the repository is ready on GitHub. + * + * If there are problems, you will see one of these in the `status` field: + * + * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information. + * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL. + * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * + * **The project_choices field** + * + * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. + * + * **Git LFS related fields** + * + * This section includes details about Git LFS related fields that may be present in the Import Progress response. + * + * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. + * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. + * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. + * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. + */ + "migrations/get-import-status": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["import"]; + }; + "404": unknown; + }; + }; + /** + * Start a source import to a GitHub repository using GitHub Importer. + */ + "migrations/start-import": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The URL of the originating repository. + */ + vcs_url: string; + /** + * 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. + */ + vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + /** + * If authentication is required, the username to provide to `vcs_url`. + */ + vcs_username?: string; + /** + * If authentication is required, the password to provide to `vcs_url`. + */ + vcs_password?: string; + /** + * For a tfvc import, the name of the project that is being imported. + */ + tfvc_project?: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["import"]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API + * request. If no parameters are provided, the import will be restarted. + */ + "migrations/update-import": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The username to provide to the originating repository. + */ + vcs_username?: string; + /** + * The password to provide to the originating repository. + */ + vcs_password?: string; + vcs?: string; + tfvc_project?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["import"]; + }; + }; + }; + /** + * Stop an import for a repository. + */ + "migrations/cancel-import": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. + * + * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. + */ + "migrations/get-commit-authors": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + since?: components["parameters"]["since-user"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["porter-author"][]; + }; + "404": unknown; + }; + }; + /** + * Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. + */ + "migrations/map-commit-author": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + author_id: number; + }; + }; + requestBody: { + "application/json": { + /** + * The new Git author email. + */ + email?: string; + /** + * The new Git author name. + */ + name?: string; + remote_id?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["porter-author"]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * List files larger than 100MB found during the import + */ + "migrations/get-large-files": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["porter-large-file"][]; + }; + }; + }; + /** + * You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/). + */ + "migrations/set-lfs-preference": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * 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). + */ + use_lfs: "opt_in" | "opt_out"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["import"]; + }; + "422": unknown; + }; + }; + /** + * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/get-repo-installation": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["installation"]; + }; + "301": never; + "404": unknown; + }; + }; + /** + * Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. + */ + "interactions/get-restrictions-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["interaction-limit-response"]; + }; + }; + }; + /** + * Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. + */ + "interactions/set-restrictions-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": components["schemas"]["interaction-limit"]; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["interaction-limit-response"]; + }; + /** + * Conflict + */ + "409": unknown; + }; + }; + /** + * Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. + */ + "interactions/remove-restrictions-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + /** + * Conflict + */ + "409": unknown; + }; + }; + /** + * When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. + */ + "repos/list-invitations": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository-invitation"][]; + }; + }; + }; + "repos/update-invitation": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + invitation_id: components["parameters"]["invitation_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. + */ + permissions?: "read" | "write" | "maintain" | "triage" | "admin"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository-invitation"]; + }; + }; + }; + "repos/delete-invitation": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + invitation_id: components["parameters"]["invitation_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * List issues in a repository. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + "issues/list-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * 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. + */ + milestone?: string; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. + */ + assignee?: string; + /** + * The user that created the issue. + */ + creator?: string; + /** + * A user that's mentioned in the issue. + */ + mentioned?: string; + labels?: components["parameters"]["labels"]; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + direction?: components["parameters"]["direction"]; + since?: components["parameters"]["since"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-simple"][]; + }; + "301": never; + "404": unknown; + "422": unknown; + }; + }; + /** + * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + "issues/create": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The title of the issue. + */ + title: string; + /** + * The contents of the issue. + */ + body?: string; + /** + * 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.**_ + */ + assignee?: string | null; + /** + * 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._ + */ + milestone?: number | null; + /** + * Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ + */ + labels?: ( + | string + | { id?: number; name?: string; description?: string; color?: string } + )[]; + /** + * 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._ + */ + assignees?: string[]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["issue"]; + }; + "403": unknown; + "404": unknown; + "410": unknown; + "422": unknown; + "503": unknown; + }; + }; + /** + * By default, Issue Comments are ordered by ascending ID. + */ + "issues/list-comments-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + sort?: components["parameters"]["sort"]; + /** + * Either `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + since?: components["parameters"]["since"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-comment"][]; + }; + "404": unknown; + "422": unknown; + }; + }; + "issues/get-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-comment"]; + }; + "404": unknown; + }; + }; + "issues/update-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The contents of the comment. + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-comment"]; + }; + "422": unknown; + }; + }; + "issues/delete-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + */ + "reactions/list-for-issue-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + query: { + /** + * Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + "404": unknown; + "415": unknown; + }; + }; + /** + * Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment. + */ + "reactions/create-for-issue-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + }; + }; + responses: { + /** + * Reaction exists + */ + "200": { + "application/json": components["schemas"]["reaction"]; + }; + /** + * Reaction created + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + "415": unknown; + "422": unknown; + }; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * + * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + */ + "reactions/delete-for-issue-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + "issues/list-events-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-event"][]; + }; + "422": unknown; + }; + }; + "issues/get-event": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + event_id: number; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-event"]; + }; + "403": unknown; + "404": unknown; + "410": unknown; + }; + }; + /** + * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was + * [transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If + * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe + * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + "issues/get": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue"]; + }; + "301": never; + "304": never; + "404": unknown; + "410": unknown; + }; + }; + /** + * Issue owners and users with push access can edit an issue. + */ + "issues/update": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The title of the issue. + */ + title?: string; + /** + * The contents of the issue. + */ + body?: string; + /** + * Login for the user that this issue should be assigned to. **This field is deprecated.** + */ + assignee?: string; + /** + * State of the issue. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ + */ + milestone?: number | null; + /** + * Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ + */ + labels?: ( + | string + | { id?: number; name?: string; description?: string; color?: string } + )[]; + /** + * Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + */ + assignees?: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue"]; + }; + "301": never; + "403": unknown; + "404": unknown; + "410": unknown; + "422": unknown; + "503": unknown; + }; + }; + /** + * Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. + */ + "issues/add-assignees": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + }; + requestBody: { + "application/json": { + /** + * Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ + */ + assignees?: string[]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["issue-simple"]; + }; + }; + }; + /** + * Removes one or more assignees from an issue. + */ + "issues/remove-assignees": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + }; + requestBody: { + "application/json": { + /** + * Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ + */ + assignees?: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-simple"]; + }; + }; + }; + /** + * Issue Comments are ordered by ascending ID. + */ + "issues/list-comments": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + query: { + since?: components["parameters"]["since"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-comment"][]; + }; + "404": unknown; + "410": unknown; + }; + }; + /** + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + "issues/create-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The contents of the comment. + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["issue-comment"]; + }; + "403": unknown; + "404": unknown; + "410": unknown; + "422": unknown; + }; + }; + "issues/list-events": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-event-for-issue"][]; + }; + "410": unknown; + }; + }; + "issues/list-labels-on-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"][]; + }; + "410": unknown; + }; + }; + "issues/add-labels": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. + */ + labels: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"][]; + }; + "410": unknown; + "422": unknown; + }; + }; + /** + * Removes any previous labels and sets the new labels for an issue. + */ + "issues/set-labels": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. + */ + labels?: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"][]; + }; + "410": unknown; + "422": unknown; + }; + }; + "issues/remove-all-labels": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "410": unknown; + }; + }; + /** + * Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. + */ + "issues/remove-label": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + name: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"][]; + }; + "404": unknown; + "410": unknown; + }; + }; + /** + * Users with push access can lock an issue or pull request's conversation. + * + * 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://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + "issues/lock": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: + * \* `off-topic` + * \* `too heated` + * \* `resolved` + * \* `spam` + */ + lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "403": unknown; + "404": unknown; + "410": unknown; + "422": unknown; + }; + }; + /** + * Users with push access can unlock an issue's conversation. + */ + "issues/unlock": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * List the reactions to an [issue](https://docs.github.com/rest/reference/issues). + */ + "reactions/list-for-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + query: { + /** + * Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + "404": unknown; + "410": unknown; + "415": unknown; + }; + }; + /** + * Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue. + */ + "reactions/create-for-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + "415": unknown; + "422": unknown; + }; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * + * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + */ + "reactions/delete-for-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + "issues/list-events-for-timeline": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue_number"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-event-for-issue"][]; + }; + "404": unknown; + "410": unknown; + "415": unknown; + }; + }; + "repos/list-deploy-keys": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["deploy-key"][]; + }; + }; + }; + /** + * You can create a read-only deploy key. + */ + "repos/create-deploy-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * A name for the key. + */ + title?: string; + /** + * The contents of the key. + */ + key: string; + /** + * If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + * + * Deploy 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/)." + */ + read_only?: boolean; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["deploy-key"]; + }; + "422": unknown; + }; + }; + "repos/get-deploy-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + key_id: components["parameters"]["key_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["deploy-key"]; + }; + "404": unknown; + }; + }; + /** + * Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. + */ + "repos/delete-deploy-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + key_id: components["parameters"]["key_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + "issues/list-labels-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"][]; + }; + "404": unknown; + }; + }; + "issues/create-label": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * 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/). + */ + name: string; + /** + * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + */ + color?: string; + /** + * A short description of the label. + */ + description?: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["label"]; + }; + "404": unknown; + "422": unknown; + }; + }; + "issues/get-label": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"]; + }; + "404": unknown; + }; + }; + "issues/update-label": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: string; + }; + }; + requestBody: { + "application/json": { + /** + * The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). + */ + new_name?: string; + /** + * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + */ + color?: string; + /** + * A short description of the label. + */ + description?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"]; + }; + }; + }; + "issues/delete-label": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: string; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. + */ + "repos/list-languages": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["language"]; + }; + }; + }; + /** + * This method returns the contents of the repository's license file, if one is detected. + * + * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. + */ + "licenses/get-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["license-content"]; + }; + }; + }; + "repos/merge": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the base branch that the head will be merged into. + */ + base: string; + /** + * The head to merge. This can be a branch name or a commit SHA1. + */ + head: string; + /** + * Commit message to use for the merge commit. If omitted, a default message will be used. + */ + commit_message?: string; + }; + }; + responses: { + /** + * Successful Response (The resulting merge commit) + */ + "201": { + "application/json": components["schemas"]["commit"]; + }; + "403": unknown; + /** + * response + */ + "404": { + "application/json": { message?: string; documentation_url?: string }; + }; + /** + * Merge conflict response + */ + "409": { + "application/json": { message?: string; documentation_url?: string }; + }; + "422": unknown; + }; + }; + "issues/list-milestones": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * The state of the milestone. Either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * What to sort results by. Either `due_on` or `completeness`. + */ + sort?: "due_on" | "completeness"; + /** + * The direction of the sort. Either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["milestone"][]; + }; + "404": unknown; + }; + }; + "issues/create-milestone": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The title of the milestone. + */ + title: string; + /** + * The state of the milestone. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * A description of the milestone. + */ + description?: string; + /** + * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + due_on?: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["milestone"]; + }; + "404": unknown; + "422": unknown; + }; + }; + "issues/get-milestone": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + milestone_number: components["parameters"]["milestone_number"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["milestone"]; + }; + "404": unknown; + }; + }; + "issues/update-milestone": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + milestone_number: components["parameters"]["milestone_number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The title of the milestone. + */ + title?: string; + /** + * The state of the milestone. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * A description of the milestone. + */ + description?: string; + /** + * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + due_on?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["milestone"]; + }; + }; + }; + "issues/delete-milestone": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + milestone_number: components["parameters"]["milestone_number"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + "issues/list-labels-for-milestone": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + milestone_number: components["parameters"]["milestone_number"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"][]; + }; + }; + }; + /** + * List all notifications for the current user. + */ + "activity/list-repo-notifications-for-authenticated-user": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + all?: components["parameters"]["all"]; + participating?: components["parameters"]["participating"]; + since?: components["parameters"]["since"]; + before?: components["parameters"]["before"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["thread"][]; + }; + }; + }; + /** + * Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + */ + "activity/mark-repo-notifications-as-read": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; + }; + }; + responses: { + /** + * response + */ + "202": unknown; + }; + }; + "repos/get-pages": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["page"]; + }; + "404": unknown; + }; + }; + /** + * Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." + */ + "repos/create-pages-site": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The source branch and directory used to publish your Pages site. + */ + source: { + /** + * The repository branch used to publish your site's source files. + */ + branch: string; + /** + * The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + */ + path?: "/" | "/docs"; + }; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["page"]; + }; + "409": unknown; + "415": unknown; + "422": unknown; + }; + }; + /** + * Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). + */ + "repos/update-information-about-pages-site": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * 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/)." + */ + cname?: string | null; + source: Partial<"gh-pages" | "master" | "master /docs"> & + Partial<{ + /** + * The repository branch used to publish your site's source files. + */ + branch: string; + /** + * The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. + */ + path: "/" | "/docs"; + }>; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "400": unknown; + "422": unknown; + }; + }; + "repos/delete-pages-site": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + "415": unknown; + "422": unknown; + }; + }; + "repos/list-pages-builds": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["page-build"][]; + }; + }; + }; + /** + * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. + * + * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + */ + "repos/request-pages-build": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["page-build-status"]; + }; + }; + }; + "repos/get-latest-pages-build": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["page-build"]; + }; + }; + }; + "repos/get-pages-build": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + build_id: number; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["page-build"]; + }; + }; + }; + /** + * Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + "projects/list-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project"][]; + }; + "401": unknown; + "403": unknown; + "404": unknown; + "410": unknown; + "422": unknown; + }; + }; + /** + * Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + "projects/create-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["project"]; + }; + "401": unknown; + "403": unknown; + "404": unknown; + "410": unknown; + "422": unknown; + }; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + "pulls/list": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * Either `open`, `closed`, or `all` to filter by state. + */ + state?: "open" | "closed" | "all"; + /** + * 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`. + */ + head?: string; + /** + * Filter pulls by base branch name. Example: `gh-pages`. + */ + base?: string; + /** + * 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). + */ + sort?: "created" | "updated" | "popularity" | "long-running"; + /** + * The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. + */ + direction?: "asc" | "desc"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-simple"][]; + }; + "304": never; + "422": unknown; + }; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + * + * You can create a new pull request. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "pulls/create": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The title of the new pull request. + */ + title?: string; + /** + * The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. + */ + head: string; + /** + * The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. + */ + base: string; + /** + * The contents of the pull request. + */ + body?: string; + /** + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + */ + maintainer_can_modify?: boolean; + /** + * Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. + */ + draft?: boolean; + issue?: number; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["pull-request"]; + }; + "403": unknown; + "422": unknown; + }; + }; + /** + * Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. + */ + "pulls/list-review-comments-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + sort?: components["parameters"]["sort"]; + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + since?: components["parameters"]["since"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review-comment"][]; + }; + }; + }; + /** + * Provides details for a review comment. + */ + "pulls/get-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review-comment"]; + }; + "404": unknown; + }; + }; + /** + * Enables you to edit a review comment. + */ + "pulls/update-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The text of the reply to the review comment. + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review-comment"]; + }; + }; + }; + /** + * Deletes a review comment. + */ + "pulls/delete-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + }; + }; + /** + * List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + */ + "reactions/list-for-pull-request-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + query: { + /** + * Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + "404": unknown; + "415": unknown; + }; + }; + /** + * Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment. + */ + "reactions/create-for-pull-request-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + }; + }; + responses: { + /** + * Reaction exists + */ + "200": { + "application/json": components["schemas"]["reaction"]; + }; + /** + * Reaction created + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + "415": unknown; + "422": unknown; + }; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * + * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + */ + "reactions/delete-for-pull-request-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + comment_id: components["parameters"]["comment_id"]; + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists details of a pull request by providing its number. + * + * When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * + * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. + * + * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: + * + * * If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * + * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + */ + "pulls/get": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + responses: { + /** + * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + */ + "200": { + "application/json": components["schemas"]["pull-request"]; + }; + "304": never; + "404": unknown; + "500": unknown; + }; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + */ + "pulls/update": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The title of the pull request. + */ + title?: string; + /** + * The contents of the pull request. + */ + body?: string; + /** + * State of this Pull Request. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. + */ + base?: string; + /** + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + */ + maintainer_can_modify?: boolean; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request"]; + }; + "403": unknown; + "422": unknown; + }; + }; + /** + * Lists all review comments for a pull request. By default, review comments are in ascending order by ID. + */ + "pulls/list-review-comments": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + query: { + sort?: components["parameters"]["sort"]; + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + since?: components["parameters"]["since"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review-comment"][]; + }; + }; + }; + /** + * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. + * + * You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices). + * + * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "pulls/create-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The text of the review comment. + */ + body: string; + /** + * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. + */ + commit_id?: string; + /** + * The relative path to the file that necessitates a comment. + */ + path: string; + /** + * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + */ + position?: number; + /** + * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + */ + side?: "LEFT" | "RIGHT"; + /** + * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. + */ + line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. + */ + start_line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + */ + start_side?: "LEFT" | "RIGHT" | "side"; + in_reply_to?: number; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["pull-request-review-comment"]; + }; + "403": unknown; + "422": unknown; + }; + }; + /** + * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "pulls/create-reply-for-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + comment_id: components["parameters"]["comment_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The text of the review comment. + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["pull-request-review-comment"]; + }; + "404": unknown; + }; + }; + /** + * Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. + */ + "pulls/list-commits": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit"][]; + }; + }; + }; + /** + * **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. + */ + "pulls/list-files": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["diff-entry"][]; + }; + "422": unknown; + "500": unknown; + }; + }; + "pulls/check-if-merged": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + responses: { + /** + * Response if pull request has been merged + */ + "204": never; + /** + * Response if pull request has not been merged + */ + "404": unknown; + }; + }; + /** + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + "pulls/merge": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * Title for the automatic commit message. + */ + commit_title?: string; + /** + * Extra detail to append to automatic commit message. + */ + commit_message?: string; + /** + * SHA that pull request head must match to allow merge. + */ + sha?: string; + /** + * Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. + */ + merge_method?: "merge" | "squash" | "rebase"; + }; + }; + responses: { + /** + * Response if merge was successful + */ + "200": { + "application/json": components["schemas"]["pull-request-merge-result"]; + }; + "403": unknown; + "404": unknown; + /** + * Response if merge cannot be performed + */ + "405": { + "application/json": { message?: string; documentation_url?: string }; + }; + /** + * Response if sha was provided and pull request head did not match + */ + "409": { + "application/json": { message?: string; documentation_url?: string }; + }; + "422": unknown; + }; + }; + "pulls/list-requested-reviewers": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review-request"]; + }; + }; + }; + /** + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + "pulls/request-reviewers": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * An array of user `login`s that will be requested. + */ + reviewers?: string[]; + /** + * An array of team `slug`s that will be requested. + */ + team_reviewers?: string[]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["pull-request-simple"]; + }; + "403": unknown; + /** + * Response if user is not a collaborator + */ + "422": unknown; + }; + }; + "pulls/remove-requested-reviewers": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * An array of user `login`s that will be removed. + */ + reviewers?: string[]; + /** + * An array of team `slug`s that will be removed. + */ + team_reviewers?: string[]; + }; + }; + responses: { + /** + * response + */ + "200": unknown; + "422": unknown; + }; + }; + /** + * The list of reviews returns in chronological order. + */ + "pulls/list-reviews": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * The list of reviews returns in chronological order. + */ + "200": { + "application/json": components["schemas"]["pull-request-review"][]; + }; + }; + }; + /** + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * Pull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response. + * + * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint. + * + * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + */ + "pulls/create-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. + */ + commit_id?: string; + /** + * **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. + */ + body?: string; + /** + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready. + */ + event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + /** + * Use the following table to specify the location, destination, and contents of the draft review comment. + */ + comments?: { + /** + * The relative path to the file that necessitates a review comment. + */ + path: string; + /** + * 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. + */ + position?: number; + /** + * Text of the review comment. + */ + body: string; + line?: number; + side?: string; + start_line?: number; + start_side?: string; + }[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review"]; + }; + "403": unknown; + "422": unknown; + }; + }; + "pulls/get-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + review_id: components["parameters"]["review_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review"]; + }; + "404": unknown; + }; + }; + /** + * Update the review summary comment with new text. + */ + "pulls/update-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + review_id: components["parameters"]["review_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The body text of the pull request review. + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review"]; + }; + "422": unknown; + }; + }; + "pulls/delete-pending-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + review_id: components["parameters"]["review_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review"]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * List comments for a specific pull request review. + */ + "pulls/list-comments-for-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + review_id: components["parameters"]["review_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["review-comment"][]; + }; + "404": unknown; + }; + }; + /** + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + */ + "pulls/dismiss-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + review_id: components["parameters"]["review_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The message for the pull request review dismissal + */ + message: string; + event?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review"]; + }; + "404": unknown; + "422": unknown; + }; + }; + "pulls/submit-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + review_id: components["parameters"]["review_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The body text of the pull request review + */ + body?: string; + /** + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. + */ + event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review"]; + }; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + */ + "pulls/update-branch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * 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](https://docs.github.com/rest/reference/repos#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. + */ + expected_head_sha?: string; + }; + }; + responses: { + /** + * response + */ + "202": { + "application/json": { message?: string; url?: string }; + }; + "403": unknown; + "415": unknown; + "422": unknown; + }; + }; + /** + * Gets the preferred README for a repository. + * + * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + */ + "repos/get-readme": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) + */ + ref?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["content-file"]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). + * + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + */ + "repos/list-releases": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["release"][]; + }; + "404": unknown; + }; + }; + /** + * Users with push access to the repository can create a release. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "repos/create-release": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the tag. + */ + tag_name: string; + /** + * 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`). + */ + target_commitish?: string; + /** + * The name of the release. + */ + name?: string; + /** + * Text describing the contents of the tag. + */ + body?: string; + /** + * `true` to create a draft (unpublished) release, `false` to create a published one. + */ + draft?: boolean; + /** + * `true` to identify the release as a prerelease. `false` to identify the release as a full release. + */ + prerelease?: boolean; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["release"]; + }; + "422": unknown; + }; + }; + /** + * To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + */ + "repos/get-release-asset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + asset_id: components["parameters"]["asset_id"]; + }; + }; + responses: { + /** + * To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + */ + "200": { + "application/json": components["schemas"]["release-asset"]; + }; + "302": never; + "404": unknown; + "415": unknown; + }; + }; + /** + * Users with push access to the repository can edit a release asset. + */ + "repos/update-release-asset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + asset_id: components["parameters"]["asset_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The file name of the asset. + */ + name?: string; + /** + * An alternate short description of the asset. Used in place of the filename. + */ + label?: string; + state?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["release-asset"]; + }; + }; + }; + "repos/delete-release-asset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + asset_id: components["parameters"]["asset_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * View the latest published full release for the repository. + * + * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + */ + "repos/get-latest-release": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["release"]; + }; + }; + }; + /** + * Get a published release with the specified tag. + */ + "repos/get-release-by-tag": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * tag+ parameter + */ + tag: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["release"]; + }; + "404": unknown; + }; + }; + /** + * **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). + */ + "repos/get-release": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + release_id: components["parameters"]["release_id"]; + }; + }; + responses: { + /** + * **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). + */ + "200": { + "application/json": components["schemas"]["release"]; + }; + "404": unknown; + }; + }; + /** + * Users with push access to the repository can edit a release. + */ + "repos/update-release": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + release_id: components["parameters"]["release_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the tag. + */ + tag_name?: string; + /** + * 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`). + */ + target_commitish?: string; + /** + * The name of the release. + */ + name?: string; + /** + * Text describing the contents of the tag. + */ + body?: string; + /** + * `true` makes the release a draft, and `false` publishes the release. + */ + draft?: boolean; + /** + * `true` to identify the release as a prerelease, `false` to identify the release as a full release. + */ + prerelease?: boolean; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["release"]; + }; + }; + }; + /** + * Users with push access to the repository can delete a release. + */ + "repos/delete-release": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + release_id: components["parameters"]["release_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + "repos/list-release-assets": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + release_id: components["parameters"]["release_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["release-asset"][]; + }; + }; + }; + /** + * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#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://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. + * + * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. + * + * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: + * + * `application/zip` + * + * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, + * you'll still need to pass your authentication to be able to upload an asset. + * + * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. + * + * **Notes:** + * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)" + * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact). + * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. + */ + "repos/upload-release-asset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + release_id: components["parameters"]["release_id"]; + }; + query: { + name?: string; + label?: string; + }; + }; + requestBody: { + "*/*": string; + }; + responses: { + /** + * Response for successful upload + */ + "201": { + "application/json": components["schemas"]["release-asset"]; + }; + }; + }; + /** + * Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + */ + "secret-scanning/list-alerts-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * Set to `open` or `resolved` to only list secret scanning alerts in a specific state. + */ + state?: "open" | "resolved"; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** + * Response + */ + "200": { + "application/json": components["schemas"]["secret-scanning-alert"][]; + }; + /** + * Repository is public or secret scanning is disabled for the repository + */ + "404": unknown; + "503": unknown; + }; + }; + /** + * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + */ + "secret-scanning/get-alert": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert_number"]; + }; + }; + responses: { + /** + * Default response + */ + "200": { + "application/json": components["schemas"]["secret-scanning-alert"]; + }; + /** + * Repository is public, or secret scanning is disabled for the repository, or the resource is not found + */ + "404": unknown; + "503": unknown; + }; + }; + /** + * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + */ + "secret-scanning/update-alert": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert_number"]; + }; + }; + requestBody: { + "application/json": { + state: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + }; + }; + responses: { + /** + * Default response + */ + "200": { + "application/json": components["schemas"]["secret-scanning-alert"]; + }; + /** + * Repository is public, or secret scanning is disabled for the repository, or the resource is not found + */ + "404": unknown; + /** + * State does not match the resolution + */ + "422": unknown; + "503": unknown; + }; + }; + /** + * Lists the people that have starred the repository. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + "activity/list-stargazers-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + "application/vnd.github.v3.star+json": components["schemas"]["stargazer"][]; + }; + "422": unknown; + }; + }; + /** + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + */ + "repos/get-code-frequency-stats": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + */ + "200": { + "application/json": components["schemas"]["code-frequency-stat"][]; + }; + }; + }; + /** + * Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. + */ + "repos/get-commit-activity-stats": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit-activity"][]; + }; + }; + }; + /** + * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: + * + * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits + */ + "repos/get-contributors-stats": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits + */ + "200": { + "application/json": components["schemas"]["contributor-activity"][]; + }; + }; + }; + /** + * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. + * + * The array order is oldest week (index 0) to most recent week. + */ + "repos/get-participation-stats": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * The array order is oldest week (index 0) to most recent week. + */ + "200": { + "application/json": components["schemas"]["participation-stats"]; + }; + "404": unknown; + }; + }; + /** + * Each array contains the day number, hour number, and number of commits: + * + * * `0-6`: Sunday - Saturday + * * `0-23`: Hour of day + * * Number of commits + * + * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + */ + "repos/get-punch-card-stats": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + */ + "200": { + "application/json": components["schemas"]["code-frequency-stat"][]; + }; + }; + }; + /** + * Users with push access in a repository can create commit statuses for a given SHA. + * + * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + */ + "repos/create-commit-status": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + sha: string; + }; + }; + requestBody: { + "application/json": { + /** + * The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. + */ + state: "error" | "failure" | "pending" | "success"; + /** + * 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. + * For 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: + * `http://ci.example.com/user/repo/build/sha` + */ + target_url?: string; + /** + * A short description of the status. + */ + description?: string; + /** + * A string label to differentiate this status from the status of other systems. + */ + context?: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["status"]; + }; + }; + }; + /** + * Lists the people watching the specified repository. + */ + "activity/list-watchers-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + "activity/get-repo-subscription": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Response if you subscribe to the repository + */ + "200": { + "application/json": components["schemas"]["repository-subscription"]; + }; + "403": unknown; + /** + * Response if you don't subscribe to the repository + */ + "404": unknown; + }; + }; + /** + * If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. + */ + "activity/set-repo-subscription": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * Determines if notifications should be received from this repository. + */ + subscribed?: boolean; + /** + * Determines if all notifications should be blocked from this repository. + */ + ignored?: boolean; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository-subscription"]; + }; + }; + }; + /** + * This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). + */ + "activity/delete-repo-subscription": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + "repos/list-tags": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["tag"][]; + }; + }; + }; + /** + * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually + * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + * the `Location` header to make a second `GET` request. + * **Note**: For private repositories, these links are temporary and expire after five minutes. + */ + "repos/download-tarball-archive": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + ref: string; + }; + }; + responses: { + /** + * response + */ + "302": never; + }; + }; + "repos/list-teams": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + }; + }; + "repos/get-all-topics": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["topic"]; + }; + "404": unknown; + "415": unknown; + }; + }; + "repos/replace-all-topics": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * 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. + */ + names: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["topic"]; + }; + "404": unknown; + "415": unknown; + "422": unknown; + }; + }; + /** + * Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. + */ + "repos/get-clones": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per?: components["parameters"]["per"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["clone-traffic"]; + }; + "403": unknown; + }; + }; + /** + * Get the top 10 popular contents over the last 14 days. + */ + "repos/get-top-paths": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["content-traffic"][]; + }; + "403": unknown; + }; + }; + /** + * Get the top 10 referrers over the last 14 days. + */ + "repos/get-top-referrers": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["referrer-traffic"][]; + }; + "403": unknown; + }; + }; + /** + * Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. + */ + "repos/get-views": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + per?: components["parameters"]["per"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["view-traffic"]; + }; + "403": unknown; + }; + }; + /** + * A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/). + */ + "repos/transfer": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * **Required:** The username or organization name the repository will be transferred to. + */ + new_owner?: string; + /** + * ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. + */ + team_ids?: number[]; + }; + }; + responses: { + /** + * response + */ + "202": { + "application/json": components["schemas"]["repository"]; + }; + }; + }; + /** + * Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + */ + "repos/check-vulnerability-alerts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Response if repository is enabled with vulnerability alerts + */ + "204": never; + /** + * Response if repository is not enabled with vulnerability alerts + */ + "404": unknown; + }; + }; + /** + * Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + */ + "repos/enable-vulnerability-alerts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + */ + "repos/disable-vulnerability-alerts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually + * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + * the `Location` header to make a second `GET` request. + * **Note**: For private repositories, these links are temporary and expire after five minutes. + */ + "repos/download-zipball-archive": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + ref: string; + }; + }; + responses: { + /** + * response + */ + "302": never; + }; + }; + /** + * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository + * * `repo` scope to create a private repository + */ + "repos/create-using-template": { + parameters: { + path: { + template_owner: string; + template_repo: string; + }; + }; + requestBody: { + "application/json": { + /** + * 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. + */ + owner?: string; + /** + * The name of the new repository. + */ + name: string; + /** + * A short description of the new repository. + */ + description?: string; + /** + * Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. + */ + include_all_branches?: boolean; + /** + * Either `true` to create a new private repository or `false` to create a new public one. + */ + private?: boolean; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["repository"]; + }; + }; + }; + /** + * Lists all public repositories in the order that they were created. + * + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. + */ + "repos/list-public": { + parameters: { + query: { + since?: components["parameters"]["since-repo"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + "304": never; + "422": unknown; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + */ + "enterprise-admin/list-provisioned-groups-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + query: { + startIndex?: components["parameters"]["start_index"]; + count?: components["parameters"]["count"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["scim-group-list-enterprise"]; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. + */ + "enterprise-admin/provision-and-invite-enterprise-group": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + "application/json": { + /** + * The SCIM schema URIs. + */ + schemas: string[]; + /** + * The name of the SCIM group. This must match the GitHub organization that the group maps to. + */ + displayName: string; + members?: { + /** + * The SCIM user ID for a user. + */ + value: string; + }[]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["scim-enterprise-group"]; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + */ + "enterprise-admin/get-provisioning-information-for-enterprise-group": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + scim_group_id: components["parameters"]["scim_group_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["scim-enterprise-group"]; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + */ + "enterprise-admin/set-information-for-provisioned-enterprise-group": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + scim_group_id: components["parameters"]["scim_group_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The SCIM schema URIs. + */ + schemas: string[]; + /** + * The name of the SCIM group. This must match the GitHub organization that the group maps to. + */ + displayName: string; + members?: { + /** + * The SCIM user ID for a user. + */ + value: string; + }[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["scim-enterprise-group"]; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + */ + "enterprise-admin/update-attribute-for-enterprise-group": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + scim_group_id: components["parameters"]["scim_group_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The SCIM schema URIs. + */ + schemas: string[]; + /** + * Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). + */ + Operations: { [key: string]: any }[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["scim-enterprise-group"]; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + */ + "enterprise-admin/delete-scim-group-from-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + scim_group_id: components["parameters"]["scim_group_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Retrieves a paginated list of all provisioned enterprise members, including pending invitations. + * + * When a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member: + * - When a user with a SCIM-provisioned external identity is removed from an enterprise, the account's metadata is preserved to allow the user to re-join the organization in the future. + * - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). + * - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. + * + * The returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO: + * + * 1. The user is granted access by the IdP and is not a member of the GitHub enterprise. + * + * 1. The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account. + * + * 1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub account: + * - If the user signs in, their GitHub account is linked to this entry. + * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. + */ + "enterprise-admin/list-provisioned-identities-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + query: { + startIndex?: components["parameters"]["start_index"]; + count?: components["parameters"]["count"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["scim-user-list-enterprise"]; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Provision enterprise membership for a user, and send organization invitation emails to the email address. + * + * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. + */ + "enterprise-admin/provision-and-invite-enterprise-user": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + "application/json": { + /** + * The SCIM schema URIs. + */ + schemas: string[]; + /** + * The username for the user. + */ + userName: string; + name: { + /** + * The first name of the user. + */ + givenName: string; + /** + * The last name of the user. + */ + familyName: string; + }; + /** + * List of user emails. + */ + emails: { + /** + * The email address. + */ + value: string; + /** + * The type of email address. + */ + type: string; + /** + * Whether this email address is the primary address. + */ + primary: boolean; + }[]; + /** + * List of SCIM group IDs the user is a member of. + */ + groups?: { value?: string }[]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["scim-enterprise-user"]; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + */ + "enterprise-admin/get-provisioning-information-for-enterprise-user": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["scim-enterprise-user"]; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-an-enterprise-scim-user) endpoint instead. + * + * You must at least provide the required values for the user: `userName`, `name`, and `emails`. + * + * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. + */ + "enterprise-admin/set-information-for-provisioned-enterprise-user": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The SCIM schema URIs. + */ + schemas: string[]; + /** + * The username for the user. + */ + userName: string; + name: { + /** + * The first name of the user. + */ + givenName: string; + /** + * The last name of the user. + */ + familyName: string; + }; + /** + * List of user emails. + */ + emails: { + /** + * The email address. + */ + value: string; + /** + * The type of email address. + */ + type: string; + /** + * Whether this email address is the primary address. + */ + primary: boolean; + }[]; + /** + * List of SCIM group IDs the user is a member of. + */ + groups?: { value?: string }[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["scim-enterprise-user"]; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + * + * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * **Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated `:scim_user_id`. + * + * ``` + * { + * "Operations":[{ + * "op":"replace", + * "value":{ + * "active":false + * } + * }] + * } + * ``` + */ + "enterprise-admin/update-attribute-for-enterprise-user": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The SCIM schema URIs. + */ + schemas: string[]; + /** + * Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). + */ + Operations: { [key: string]: any }[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["scim-enterprise-user"]; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + */ + "enterprise-admin/delete-user-from-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. + * + * When a user with a SAML-provisioned external identity leaves (or is removed from) an organization, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member: + * - When a user with a SCIM-provisioned external identity is removed from an organization, the account's metadata is preserved to allow the user to re-join the organization in the future. + * - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). + * - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. + * + * The returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO: + * + * 1. The user is granted access by the IdP and is not a member of the GitHub organization. + * + * 1. The user attempts to access the GitHub organization and initiates the SAML SSO process, and is not currently signed in to their GitHub account. + * + * 1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub account: + * - If the user signs in, their GitHub account is linked to this entry. + * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. + */ + "scim/list-provisioned-identities": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** + * Used for pagination: the index of the first result to return. + */ + startIndex?: number; + /** + * Used for pagination: the number of results to return. + */ + count?: number; + /** + * 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\"`. + * + * To filter results for for the identity with the email `octocat@github.com`, you would use this query: + * + * `?filter=emails%20eq%20\"octocat@github.com\"`. + */ + filter?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/scim+json": components["schemas"]["scim-user-list"]; + }; + "304": never; + "400": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Provision organization membership for a user, and send an activation email to the email address. + */ + "scim/provision-and-invite-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": { + /** + * Configured by the admin. Could be an email, login, or username + */ + userName: string; + /** + * The name of the user, suitable for display to end-users + */ + displayName?: string; + name: { givenName: string; familyName: string; formatted?: string }; + /** + * user emails + */ + emails: { value: string; primary?: boolean; type?: string }[]; + schemas?: string[]; + externalId?: string; + groups?: string[]; + active?: boolean; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/scim+json": components["schemas"]["scim-user"]; + }; + "304": never; + "400": unknown; + "403": unknown; + "404": unknown; + "409": unknown; + "500": unknown; + }; + }; + "scim/get-provisioning-information-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/scim+json": components["schemas"]["scim-user"]; + }; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. + * + * You must at least provide the required values for the user: `userName`, `name`, and `emails`. + * + * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. + */ + "scim/set-information-for-provisioned-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + requestBody: { + "application/json": { + schemas?: string[]; + /** + * The name of the user, suitable for display to end-users + */ + displayName?: string; + externalId?: string; + groups?: string[]; + active?: boolean; + /** + * Configured by the admin. Could be an email, login, or username + */ + userName: string; + name: { givenName: string; familyName: string; formatted?: string }; + /** + * user emails + */ + emails: { type?: string; value: string; primary?: boolean }[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/scim+json": components["schemas"]["scim-user"]; + }; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + * + * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * **Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`. + * + * ``` + * { + * "Operations":[{ + * "op":"replace", + * "value":{ + * "active":false + * } + * }] + * } + * ``` + */ + "scim/update-attribute-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + requestBody: { + "application/json": { + schemas?: string[]; + /** + * Set of operations to be performed + */ + Operations: { + op: "add" | "remove" | "replace"; + path?: string; + value?: + | { + active?: boolean | null; + userName?: string | null; + externalId?: string | null; + givenName?: string | null; + familyName?: string | null; + } + | { value?: string; primary?: boolean }[] + | string; + }[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/scim+json": components["schemas"]["scim-user"]; + }; + "304": never; + "400": unknown; + "403": unknown; + "404": unknown; + /** + * Too many requests + */ + "429": { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + "scim/delete-user-from-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: + * + * `q=addClass+in:file+language:js+repo:jquery/jquery` + * + * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. + * + * #### Considerations for code search + * + * Due to the complexity of searching code, there are a few restrictions on how searches are performed: + * + * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. + * * Only files smaller than 384 KB are searchable. + * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing + * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. + */ + "search/code": { + parameters: { + query: { + /** + * 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://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://help.github.com/articles/searching-code/)" for a detailed list of qualifiers. + */ + q: string; + /** + * 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://docs.github.com/rest/reference/search#ranking-search-results) + */ + sort?: "indexed"; + order?: components["parameters"]["order"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["code-search-result-item"][]; + }; + }; + "304": never; + "403": unknown; + "422": unknown; + "503": unknown; + }; + }; + /** + * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match + * metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: + * + * `q=repo:octocat/Spoon-Knife+css` + */ + "search/commits": { + parameters: { + query: { + /** + * 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://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://help.github.com/articles/searching-commits/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) + */ + sort?: "author-date" | "committer-date"; + order?: components["parameters"]["order"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["commit-search-result-item"][]; + }; + }; + "304": never; + "415": unknown; + }; + }; + /** + * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted + * search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. + * + * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + * + * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. + * + * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + */ + "search/issues-and-pull-requests": { + parameters: { + query: { + /** + * 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://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) + */ + sort?: + | "comments" + | "reactions" + | "reactions-+1" + | "reactions--1" + | "reactions-smile" + | "reactions-thinking_face" + | "reactions-heart" + | "reactions-tada" + | "interactions" + | "created" + | "updated"; + order?: components["parameters"]["order"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["issue-search-result-item"][]; + }; + }; + "304": never; + "403": unknown; + "422": unknown; + "503": unknown; + }; + }; + /** + * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: + * + * `q=bug+defect+enhancement&repository_id=64778136` + * + * The labels that best match the query appear first in the search results. + */ + "search/labels": { + parameters: { + query: { + /** + * The id of the repository. + */ + repository_id: number; + /** + * 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://docs.github.com/rest/reference/search#constructing-a-search-query). + */ + q: string; + /** + * Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) + */ + sort?: "created" | "updated"; + order?: components["parameters"]["order"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["label-search-result-item"][]; + }; + }; + "304": never; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: + * + * `q=tetris+language:assembly&sort=stars&order=desc` + * + * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + * + * When you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this: + * + * `q=topic:ruby+topic:rails` + */ + "search/repos": { + parameters: { + query: { + /** + * 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://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. + */ + q: string; + /** + * 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://docs.github.com/rest/reference/search#ranking-search-results) + */ + sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + order?: components["parameters"]["order"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["repo-search-result-item"][]; + }; + }; + "304": never; + "422": unknown; + "503": unknown; + }; + }; + /** + * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://help.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + * + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: + * + * `q=ruby+is:featured` + * + * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + */ + "search/topics": { + parameters: { + query: { + /** + * 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://docs.github.com/rest/reference/search#constructing-a-search-query). + */ + q: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["topic-search-result-item"][]; + }; + }; + "304": never; + "415": unknown; + }; + }; + /** + * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you're looking for a list of popular users, you might try this query: + * + * `q=tom+repos:%3E42+followers:%3E1000` + * + * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + */ + "search/users": { + parameters: { + query: { + /** + * 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://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://help.github.com/articles/searching-users/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) + */ + sort?: "followers" | "repositories" | "joined"; + order?: components["parameters"]["order"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["user-search-result-item"][]; + }; + }; + "304": never; + "422": unknown; + "503": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. + */ + "teams/get-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-full"]; + }; + "404": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. + * + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * + * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + */ + "teams/update-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number | null; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-full"]; + }; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. + * + * To delete a team, the authenticated user must be an organization owner or team maintainer. + * + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + */ + "teams/delete-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + "422": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. + * + * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/list-discussions-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + query: { + direction?: components["parameters"]["direction"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-discussion"][]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. + * + * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "teams/create-discussion-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The discussion post's title. + */ + title: string; + /** + * The discussion post's body text. + */ + body: string; + /** + * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + */ + private?: boolean; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. + * + * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/get-discussion-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. + * + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/update-discussion-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The discussion post's title. + */ + title?: string; + /** + * The discussion post's body text. + */ + body?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. + * + * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/delete-discussion-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. + * + * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/list-discussion-comments-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + query: { + direction?: components["parameters"]["direction"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-discussion-comment"][]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. + * + * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "teams/create-discussion-comment-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The discussion comment's body text. + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. + * + * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/get-discussion-comment-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. + * + * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/update-discussion-comment-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The discussion comment's body text. + */ + body: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. + * + * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/delete-discussion-comment-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * + * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "reactions/list-for-team-discussion-comment-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + query: { + /** + * Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. + */ + "reactions/create-for-team-discussion-comment-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. + * + * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "reactions/list-for-team-discussion-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + query: { + /** + * Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. + * + * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. + */ + "reactions/create-for-team-discussion-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + requestBody: { + "application/json": { + /** + * The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. + * + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + */ + "teams/list-pending-invitations-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-invitation"][]; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. + * + * Team members will include the members of child teams. + */ + "teams/list-members-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + query: { + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "404": unknown; + }; + }; + /** + * The "Get team member" endpoint (described below) is deprecated. + * + * We recommend using the [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * + * To list members in a team, the team must be visible to the authenticated user. + */ + "teams/get-member-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Response if user is a member + */ + "204": never; + /** + * Response if user is not a member + */ + "404": unknown; + }; + }; + /** + * The "Add team member" endpoint (described below) is deprecated. + * + * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + "teams/add-member-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "403": unknown; + /** + * Response if team synchronization is set up + */ + "404": unknown; + /** + * response + */ + "422": { + "application/json": { + message?: string; + errors?: { code?: string; field?: string; resource?: string }[]; + documentation_url?: string; + }; + }; + }; + }; + /** + * The "Remove team member" endpoint (described below) is deprecated. + * + * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + */ + "teams/remove-member-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + /** + * Response if team synchronization is setup + */ + "404": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. + * + * Team members will include the members of child teams. + * + * To get a user's membership with a team, the team must be visible to the authenticated user. + * + * **Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). + */ + "teams/get-membership-for-user-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-membership"]; + }; + "404": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. + * + * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + */ + "teams/add-or-update-membership-for-user-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + username: components["parameters"]["username"]; + }; + }; + requestBody: { + "application/json": { + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-membership"]; + }; + /** + * Response if team synchronization is set up + */ + "403": unknown; + "404": unknown; + /** + * Response if you attempt to add an organization to a team + */ + "422": { + "application/json": { + message?: string; + errors?: { code?: string; field?: string; resource?: string }[]; + documentation_url?: string; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + */ + "teams/remove-membership-for-user-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + /** + * Response if team synchronization is set up + */ + "403": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. + * + * Lists the organization projects for a team. + */ + "teams/list-projects-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-project"][]; + }; + "404": unknown; + "415": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. + * + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + */ + "teams/check-permissions-for-project-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-project"]; + }; + /** + * Response if project is not managed by this team + */ + "404": unknown; + "415": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. + * + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + */ + "teams/add-or-update-project-permissions-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + project_id: components["parameters"]["project-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + permission?: "read" | "write" | "admin"; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + /** + * Response if the project is not owned by the organization + */ + "403": { + "application/json": { message?: string; documentation_url?: string }; + }; + "404": unknown; + "415": unknown; + "422": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. + * + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + */ + "teams/remove-project-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "404": unknown; + "415": unknown; + "422": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. + */ + "teams/list-repos-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + "404": unknown; + }; + }; + /** + * **Note**: Repositories inherited through a parent team will also be checked. + * + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint. + * + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + "teams/check-permissions-for-repo-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Alternative response with extra repository information + */ + "200": { + "application/vnd.github.v3.repository+json": components["schemas"]["team-repository"]; + }; + /** + * Response if repository is managed by this team + */ + "204": never; + /** + * Response if repository is not managed by this team + */ + "404": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. + * + * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. + * + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + "teams/add-or-update-repo-permissions-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + "application/json": { + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + */ + permission?: "pull" | "push" | "admin"; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "403": unknown; + "422": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. + * + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + */ + "teams/remove-repo-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * List IdP groups connected to a team on GitHub. + */ + "teams/list-idp-groups-for-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["group-mapping"]; + }; + "403": unknown; + "404": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. + */ + "teams/create-or-update-idp-group-connections-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + }; + requestBody: { + "application/json": { + /** + * 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. + */ + groups: { + /** + * ID of the IdP group. + */ + group_id: string; + /** + * Name of the IdP group. + */ + group_name: string; + /** + * Description of the IdP group. + */ + group_description: string; + id?: string; + name?: string; + description?: string; + }[]; + synced_at?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["group-mapping"]; + }; + "403": unknown; + "422": unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. + */ + "teams/list-child-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * Response if child teams exist + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. + * + * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + */ + "users/get-authenticated": { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": + | components["schemas"]["private-user"] + | components["schemas"]["public-user"]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. + */ + "users/update-authenticated": { + parameters: {}; + requestBody: { + "application/json": { + /** + * The new name of the user. + */ + name?: string; + /** + * The publicly visible email address of the user. + */ + email?: string; + /** + * The new blog URL of the user. + */ + blog?: string; + /** + * The new Twitter username of the user. + */ + twitter_username?: string | null; + /** + * The new company of the user. + */ + company?: string; + /** + * The new location of the user. + */ + location?: string; + /** + * The new hiring availability of the user. + */ + hireable?: boolean; + /** + * The new short biography of the user. + */ + bio?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["private-user"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * List the users you've blocked on your personal account. + */ + "users/list-blocked-by-authenticated": { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "415": unknown; + }; + }; + "users/check-blocked": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * If the user is blocked: + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + /** + * If the user is not blocked: + */ + "404": { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + "users/block": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + "users/unblock": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Sets the visibility for your primary email addresses. + */ + "users/set-primary-email-visibility-for-authenticated": { + parameters: {}; + requestBody: { + "application/json": { + /** + * An email address associated with the GitHub user account to manage. + */ + email: string; + /** + * Denotes whether an email is publically visible. + */ + visibility: "public" | "private"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["email"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + */ + "users/list-emails-for-authenticated": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["email"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * This endpoint is accessible with the `user` scope. + */ + "users/add-email-for-authenticated": { + parameters: {}; + requestBody: { + "application/json": + | { + /** + * 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. + */ + emails: string[]; + } + | string[] + | string; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["email"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * This endpoint is accessible with the `user` scope. + */ + "users/delete-email-for-authenticated": { + parameters: {}; + requestBody: { + "application/json": + | { + /** + * Email addresses associated with the GitHub user account. + */ + emails: string[]; + } + | string[] + | string; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * Lists the people following the authenticated user. + */ + "users/list-followers-for-authenticated-user": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * Lists the people who the authenticated user follows. + */ + "users/list-followed-by-authenticated": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + "users/check-person-is-followed-by-authenticated": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Response if the person is followed by the authenticated user + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + /** + * Response if the person is not followed by the authenticated user + */ + "404": { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + /** + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + */ + "users/follow": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + */ + "users/unfollow": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "users/list-gpg-keys-for-authenticated": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gpg-key"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "users/create-gpg-key-for-authenticated": { + parameters: {}; + requestBody: { + "application/json": { + /** + * A GPG key in ASCII-armored format. + */ + armored_public_key: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["gpg-key"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "users/get-gpg-key-for-authenticated": { + parameters: { + path: { + gpg_key_id: components["parameters"]["gpg_key_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gpg-key"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "users/delete-gpg-key-for-authenticated": { + parameters: { + path: { + gpg_key_id: components["parameters"]["gpg_key_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. + * + * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * + * You can find the permissions for the installation under the `permissions` key. + */ + "apps/list-installations-for-authenticated-user": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * You can find the permissions for the installation under the `permissions` key. + */ + "200": { + "application/json": { + total_count: number; + installations: components["schemas"]["installation"][]; + }; + }; + "304": never; + "401": unknown; + "403": unknown; + "415": unknown; + }; + }; + /** + * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * + * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. + * + * The access the user has to each repository is included in the hash under the `permissions` key. + */ + "apps/list-installation-repos-for-authenticated-user": { + parameters: { + path: { + installation_id: components["parameters"]["installation_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * The access the user has to each repository is included in the hash under the `permissions` key. + */ + "200": { + "application/json": { + total_count: number; + repository_selection?: string; + repositories: components["schemas"]["repository"][]; + }; + }; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + */ + "apps/add-repo-to-installation": { + parameters: { + path: { + installation_id: components["parameters"]["installation_id"]; + repository_id: components["parameters"]["repository_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * Remove a single repository from an installation. The authenticated user must have admin access to the repository. + * + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + */ + "apps/remove-repo-from-installation": { + parameters: { + path: { + installation_id: components["parameters"]["installation_id"]; + repository_id: components["parameters"]["repository_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * Shows which type of GitHub user can interact with your public repositories and when the restriction expires. If there are no restrictions, you will see an empty response. + */ + "interactions/get-restrictions-for-your-public-repos": { + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["interaction-limit-response"]; + }; + }; + }; + /** + * Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. + */ + "interactions/set-restrictions-for-your-public-repos": { + requestBody: { + "application/json": components["schemas"]["interaction-limit"]; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["interaction-limit-response"]; + }; + "422": unknown; + }; + }; + /** + * Removes any interaction restrictions from your public repositories. + */ + "interactions/remove-restrictions-for-your-public-repos": { + responses: { + /** + * Empty response + */ + "204": never; + }; + }; + /** + * List issues across owned and member repositories assigned to the authenticated user. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + "issues/list-for-authenticated-user": { + parameters: { + query: { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + labels?: components["parameters"]["labels"]; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + direction?: components["parameters"]["direction"]; + since?: components["parameters"]["since"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue"][]; + }; + "304": never; + "404": unknown; + }; + }; + /** + * Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "users/list-public-ssh-keys-for-authenticated": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["key"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "users/create-public-ssh-key-for-authenticated": { + parameters: {}; + requestBody: { + "application/json": { + /** + * A descriptive name for the new key. + */ + title?: string; + /** + * The public SSH key to add to your GitHub account. + */ + key: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["key"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "users/get-public-ssh-key-for-authenticated": { + parameters: { + path: { + key_id: components["parameters"]["key_id"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["key"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "users/delete-public-ssh-key-for-authenticated": { + parameters: { + path: { + key_id: components["parameters"]["key_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). + */ + "apps/list-subscriptions-for-authenticated-user": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["user-marketplace-purchase"][]; + }; + "304": never; + "401": unknown; + "404": unknown; + }; + }; + /** + * Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). + */ + "apps/list-subscriptions-for-authenticated-user-stubbed": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["user-marketplace-purchase"][]; + }; + "304": never; + "401": unknown; + }; + }; + "orgs/list-memberships-for-authenticated-user": { + parameters: { + query: { + /** + * 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. + */ + state?: "active" | "pending"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-membership"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "422": unknown; + }; + }; + "orgs/get-membership-for-authenticated-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-membership"]; + }; + "403": unknown; + "404": unknown; + }; + }; + "orgs/update-membership-for-authenticated-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + "application/json": { + /** + * The state that the membership should be in. Only `"active"` will be accepted. + */ + state: "active"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-membership"]; + }; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * Lists all migrations a user has started. + */ + "migrations/list-for-authenticated-user": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["migration"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * Initiates the generation of a user migration archive. + */ + "migrations/start-for-authenticated-user": { + parameters: {}; + requestBody: { + "application/json": { + /** + * Lock the repositories being migrated at the start of the migration + */ + lock_repositories?: boolean; + /** + * Do not include attachments in the migration + */ + exclude_attachments?: boolean; + /** + * Exclude attributes from the API response to improve performance + */ + exclude?: "repositories"[]; + repositories: string[]; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["migration"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "422": unknown; + }; + }; + /** + * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: + * + * * `pending` - the migration hasn't started yet. + * * `exporting` - the migration is in progress. + * * `exported` - the migration finished successfully. + * * `failed` - the migration failed. + * + * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). + */ + "migrations/get-status-for-authenticated-user": { + parameters: { + path: { + migration_id: components["parameters"]["migration_id"]; + }; + query: { + exclude?: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["migration"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: + * + * * attachments + * * bases + * * commit\_comments + * * issue\_comments + * * issue\_events + * * issues + * * milestones + * * organizations + * * projects + * * protected\_branches + * * pull\_request\_reviews + * * pull\_requests + * * releases + * * repositories + * * review\_comments + * * schema + * * users + * + * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. + */ + "migrations/get-archive-for-authenticated-user": { + parameters: { + path: { + migration_id: components["parameters"]["migration_id"]; + }; + }; + responses: { + /** + * response + */ + "302": never; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. + */ + "migrations/delete-archive-for-authenticated-user": { + parameters: { + path: { + migration_id: components["parameters"]["migration_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. + */ + "migrations/unlock-repo-for-authenticated-user": { + parameters: { + path: { + migration_id: components["parameters"]["migration_id"]; + repo_name: components["parameters"]["repo_name"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Lists all the repositories for this user migration. + */ + "migrations/list-repos-for-user": { + parameters: { + path: { + migration_id: components["parameters"]["migration_id"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + "404": unknown; + }; + }; + /** + * List organizations for the authenticated user. + * + * **OAuth scope requirements** + * + * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + */ + "orgs/list-for-authenticated-user": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-simple"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + "projects/create-for-authenticated-user": { + parameters: {}; + requestBody: { + "application/json": { + /** + * Name of the project + */ + name: string; + /** + * Body of the project + */ + body?: string | null; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["project"]; + }; + "304": never; + "401": unknown; + "403": unknown; + "415": unknown; + "422": unknown; + }; + }; + /** + * Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + */ + "users/list-public-emails-for-authenticated": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["email"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + */ + "repos/list-for-authenticated-user": { + parameters: { + query: { + /** + * Can be one of `all`, `public`, or `private`. + */ + visibility?: "all" | "public" | "private"; + /** + * Comma-separated list of values. Can include: + * \* `owner`: Repositories that are owned by the authenticated user. + * \* `collaborator`: Repositories that the user has been added to as a collaborator. + * \* `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. + */ + affiliation?: string; + /** + * Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` + * + * Will 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**. + */ + type?: "all" | "owner" | "public" | "private" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` + */ + direction?: "asc" | "desc"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + since?: components["parameters"]["since"]; + before?: components["parameters"]["before"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "422": unknown; + }; + }; + /** + * Creates a new repository for the authenticated user. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository + * * `repo` scope to create a private repository + */ + "repos/create-for-authenticated-user": { + parameters: {}; + requestBody: { + "application/json": { + /** + * The name of the repository. + */ + name: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Whether the repository is private or public. + */ + private?: boolean; + /** + * Whether issues are enabled. + */ + has_issues?: boolean; + /** + * Whether projects are enabled. + */ + has_projects?: boolean; + /** + * Whether the wiki is enabled. + */ + has_wiki?: boolean; + /** + * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + */ + team_id?: number; + /** + * Whether the repository is initialized with a minimal README. + */ + auto_init?: boolean; + /** + * The desired language or platform to apply to the .gitignore. + */ + gitignore_template?: string; + /** + * The license keyword of the open source license for this repository. + */ + license_template?: string; + /** + * Whether to allow squash merges for pull requests. + */ + allow_squash_merge?: boolean; + /** + * Whether to allow merge commits for pull requests. + */ + allow_merge_commit?: boolean; + /** + * Whether to allow rebase merges for pull requests. + */ + allow_rebase_merge?: boolean; + /** + * Whether to delete head branches when pull requests are merged + */ + delete_branch_on_merge?: boolean; + /** + * Whether downloads are enabled. + */ + has_downloads?: boolean; + /** + * Whether this repository acts as a template that can be used to generate new repositories. + */ + is_template?: boolean; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["repository"]; + }; + "304": never; + "400": unknown; + "401": unknown; + "403": unknown; + "404": unknown; + "422": unknown; + }; + }; + /** + * When authenticating as a user, this endpoint will list all currently open repository invitations for that user. + */ + "repos/list-invitations-for-authenticated-user": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository-invitation"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + "repos/accept-invitation": { + parameters: { + path: { + invitation_id: components["parameters"]["invitation_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "403": unknown; + "404": unknown; + "409": unknown; + }; + }; + "repos/decline-invitation": { + parameters: { + path: { + invitation_id: components["parameters"]["invitation_id"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "403": unknown; + "404": unknown; + "409": unknown; + }; + }; + /** + * Lists repositories the authenticated user has starred. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + "activity/list-repos-starred-by-authenticated-user": { + parameters: { + query: { + sort?: components["parameters"]["sort"]; + direction?: components["parameters"]["direction"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository"][]; + "application/vnd.github.v3.star+json": components["schemas"]["starred-repository"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + "activity/check-repo-is-starred-by-authenticated-user": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Response if this repository is starred by you + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + /** + * Response if this repository is not starred by you + */ + "404": { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + /** + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + "activity/star-repo-for-authenticated-user": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + "activity/unstar-repo-for-authenticated-user": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * Empty response + */ + "204": never; + "304": never; + "401": unknown; + "403": unknown; + "404": unknown; + }; + }; + /** + * Lists repositories the authenticated user is watching. + */ + "activity/list-watched-repos-for-authenticated-user": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + "304": never; + "401": unknown; + "403": unknown; + }; + }; + /** + * List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). + */ + "teams/list-for-authenticated-user": { + parameters: { + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-full"][]; + }; + "304": never; + "403": unknown; + "404": unknown; + }; + }; + /** + * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. + * + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. + */ + "users/list": { + parameters: { + query: { + since?: components["parameters"]["since-user"]; + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "304": never; + }; + }; + /** + * Provides publicly available information about someone with a GitHub account. + * + * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". + */ + "users/get-by-username": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": + | components["schemas"]["private-user"] + | components["schemas"]["public-user"]; + }; + "404": unknown; + }; + }; + /** + * If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + */ + "activity/list-events-for-authenticated-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + /** + * This is the user's organization dashboard. You must be authenticated as the user to view this. + */ + "activity/list-org-events-for-authenticated-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + org: components["parameters"]["org"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + "activity/list-public-events-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + /** + * Lists the people following the specified user. + */ + "users/list-followers-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + /** + * Lists the people who the specified user follows. + */ + "users/list-following-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + "users/check-following-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + target_user: string; + }; + }; + responses: { + /** + * Response if the user follows the target user + */ + "204": never; + /** + * Response if the user does not follow the target user + */ + "404": unknown; + }; + }; + /** + * Lists public gists for the specified user: + */ + "gists/list-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + since?: components["parameters"]["since"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["base-gist"][]; + }; + "422": unknown; + }; + }; + /** + * Lists the GPG keys for a user. This information is accessible by anyone. + */ + "users/list-gpg-keys-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gpg-key"][]; + }; + }; + }; + /** + * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + * + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: + * + * ```shell + * curl -u username:token + * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 + * ``` + */ + "users/get-context-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** + * 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`. + */ + subject_type?: "organization" | "repository" | "issue" | "pull_request"; + /** + * Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. + */ + subject_id?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["hovercard"]; + }; + "404": unknown; + "422": unknown; + }; + }; + /** + * Enables an authenticated GitHub App to find the user’s installation information. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/get-user-installation": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["installation"]; + }; + }; + }; + /** + * Lists the _verified_ public SSH keys for a user. This is accessible by anyone. + */ + "users/list-public-keys-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["key-simple"][]; + }; + }; + }; + /** + * List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. + * + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. + */ + "orgs/list-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + "projects/list-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project"][]; + }; + "415": unknown; + "422": unknown; + }; + }; + /** + * These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + */ + "activity/list-received-events-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + "activity/list-received-public-events-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + /** + * Lists public repositories for the specified user. + */ + "repos/list-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** + * Can be one of `all`, `owner`, `member`. + */ + type?: "all" | "owner" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` + */ + direction?: "asc" | "desc"; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * Access tokens must have the `user` scope. + */ + "billing/get-github-actions-billing-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-billing-usage"]; + }; + }; + }; + /** + * Gets the free and paid storage used for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `user` scope. + */ + "billing/get-github-packages-billing-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["packages-billing-usage"]; + }; + }; + }; + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `user` scope. + */ + "billing/get-shared-storage-billing-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["combined-billing-usage"]; + }; + }; + }; + /** + * Lists repositories a user has starred. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + "activity/list-repos-starred-by-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + sort?: components["parameters"]["sort"]; + direction?: components["parameters"]["direction"]; + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository"][]; + "application/vnd.github.v3.star+json": components["schemas"]["starred-repository"][]; + }; + }; + }; + /** + * Lists repositories a user is watching. + */ + "activity/list-repos-watched-by-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + per_page?: components["parameters"]["per_page"]; + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + /** + * Get a random sentence from the Zen of GitHub + */ + "meta/get-zen": { + responses: { + /** + * response + */ + "200": { + "text/plain": string; + }; + }; + }; +} + +export interface components { + parameters: { + /** + * Results per page (max 100) + */ + per_page: number; + /** + * Page number of the results to fetch. + */ + page: number; + /** + * 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`. + */ + since: string; + /** + * installation_id parameter + */ + installation_id: number; + /** + * grant_id parameter + */ + grant_id: number; + /** + * The client ID of your GitHub app. + */ + "client-id": string; + "access-token": string; + app_slug: string; + /** + * authorization_id parameter + */ + authorization_id: number; + /** + * The slug version of the enterprise name. You can also substitute this value with the enterprise id. + */ + enterprise: string; + /** + * Unique identifier of an organization. + */ + org_id: number; + /** + * Unique identifier of the self-hosted runner group. + */ + runner_group_id: number; + /** + * Unique identifier of the self-hosted runner. + */ + runner_id: number; + /** + * A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). + */ + "audit-log-phrase": string; + /** + * The event types to include: + * + * - `web` - returns web (non-Git) events + * - `git` - returns Git events + * - `all` - returns both web and Git events + * + * The default is `web`. + */ + "audit-log-include": "web" | "git" | "all"; + /** + * A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. + */ + "audit-log-after": string; + /** + * A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. + */ + "audit-log-before": string; + /** + * gist_id parameter + */ + gist_id: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels: string; + /** + * One of `asc` (ascending) or `desc` (descending). + */ + direction: "asc" | "desc"; + /** + * account_id parameter + */ + account_id: number; + /** + * plan_id parameter + */ + plan_id: number; + /** + * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). + */ + sort: "created" | "updated"; + owner: string; + repo: string; + /** + * If `true`, show notifications marked as read. + */ + all: boolean; + /** + * If `true`, only shows notifications in which the user is directly participating or mentioned. + */ + participating: boolean; + /** + * 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`. + */ + before: string; + /** + * thread_id parameter + */ + thread_id: number; + /** + * An organization ID. Only return organizations with an ID greater than this ID. + */ + "since-org": number; + org: string; + repository_id: number; + /** + * secret_name parameter + */ + secret_name: string; + username: string; + "hook-id": number; + /** + * invitation_id parameter + */ + invitation_id: number; + /** + * migration_id parameter + */ + migration_id: number; + /** + * repo_name parameter + */ + repo_name: string; + /** + * team_slug parameter + */ + team_slug: string; + "discussion-number": number; + "comment-number": number; + "reaction-id": number; + "project-id": number; + /** + * card_id parameter + */ + card_id: number; + /** + * column_id parameter + */ + column_id: number; + /** + * artifact_id parameter + */ + artifact_id: number; + /** + * job_id parameter + */ + job_id: number; + /** + * Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. + */ + actor: string; + /** + * Returns workflow runs associated with a branch. Use the name of the branch of the `push`. + */ + "workflow-run-branch": string; + /** + * Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." + */ + event: string; + /** + * Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." + */ + "workflow-run-status": "completed" | "status" | "conclusion"; + "run-id": number; + /** + * The ID of the workflow. You can also pass the workflow file name as a string. + */ + "workflow-id": number | string; + /** + * branch+ parameter + */ + branch: string; + /** + * check_run_id parameter + */ + check_run_id: number; + /** + * check_suite_id parameter + */ + check_suite_id: number; + /** + * Returns check runs with the specified `name`. + */ + check_name: string; + /** + * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. + */ + status: "queued" | "in_progress" | "completed"; + /** + * The security alert number, found at the end of the security alert's URL. + */ + alert_number: components["schemas"]["alert-number"]; + /** + * commit_sha+ parameter + */ + commit_sha: string; + /** + * deployment_id parameter + */ + deployment_id: number; + /** + * A user ID. Only return users with an ID greater than this ID. + */ + "since-user": number; + /** + * issue_number parameter + */ + issue_number: number; + /** + * key_id parameter + */ + key_id: number; + /** + * milestone_number parameter + */ + milestone_number: number; + "pull-number": number; + /** + * review_id parameter + */ + review_id: number; + /** + * asset_id parameter + */ + asset_id: number; + /** + * release_id parameter + */ + release_id: number; + /** + * Must be one of: `day`, `week`. + */ + per: "day" | "week"; + /** + * A repository ID. Only return repositories with an ID greater than this ID. + */ + "since-repo": number; + /** + * Used for pagination: the index of the first result to return. + */ + start_index: number; + /** + * Used for pagination: the number of results to return. + */ + count: number; + /** + * Identifier generated by the GitHub SCIM endpoint. + */ + scim_group_id: string; + /** + * scim_user_id parameter + */ + scim_user_id: string; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order: "desc" | "asc"; + "team-id": number; + /** + * gpg_key_id parameter + */ + gpg_key_id: number; + }; + schemas: { + /** + * Simple User + */ + "simple-user": { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string | null; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + starred_at?: string; + } | null; + /** + * GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + integration: { + /** + * Unique identifier of the GitHub app + */ + id: number; + /** + * The slug name of the GitHub app + */ + slug?: string; + node_id: string; + owner: components["schemas"]["simple-user"] | null; + /** + * The name of the GitHub app + */ + name: string; + description: string | null; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + /** + * The set of permissions for the GitHub app + */ + permissions: { + issues?: string; + checks?: string; + metadata?: string; + contents?: string; + deployments?: string; + } & { [key: string]: string }; + /** + * The list of events for the GitHub app + */ + events: string[]; + /** + * The number of installations associated with the GitHub app + */ + installations_count?: number; + client_id?: string; + client_secret?: string; + webhook_secret?: string; + pem?: string; + } & { [key: string]: any }; + /** + * Basic Error + */ + "basic-error": { message?: string; documentation_url?: string }; + /** + * Validation Error Simple + */ + "validation-error-simple": { + message: string; + documentation_url: string; + errors?: string[]; + }; + /** + * The URL to which the payloads will be delivered. + */ + "webhook-config-url": string; + /** + * The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. + */ + "webhook-config-content-type": string; + /** + * If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). + */ + "webhook-config-secret": string; + /** + * 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.** + */ + "webhook-config-insecure-ssl": string; + /** + * Configuration object of the webhook + */ + "webhook-config": { + url?: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + /** + * An enterprise account + */ + enterprise: { + /** + * A short description of the enterprise. + */ + description?: string | null; + html_url: string; + /** + * The enterprise's website URL. + */ + website_url?: string | null; + /** + * Unique identifier of the enterprise + */ + id: number; + node_id: string; + /** + * The name of the enterprise. + */ + name: string; + /** + * The slug url identifier for the enterprise. + */ + slug: string; + created_at: string | null; + updated_at: string | null; + avatar_url: string; + }; + /** + * Installation + */ + installation: { + /** + * The ID of the installation. + */ + id: number; + account: + | (Partial & + Partial) + | null; + /** + * Describe whether all repositories have been selected or there's a selection involved + */ + repository_selection: "all" | "selected"; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + /** + * The ID of the user or organization this token is being scoped to. + */ + target_id: number; + target_type: string; + permissions: { + deployments?: string; + checks?: string; + metadata?: string; + contents?: string; + pull_requests?: string; + statuses?: string; + issues?: string; + organization_administration?: string; + }; + events: string[]; + created_at: string; + updated_at: string; + single_file_name: string | null; + has_multiple_single_files?: boolean; + single_file_paths?: string[]; + app_slug: string; + suspended_by?: components["schemas"]["simple-user"] | null; + suspended_at?: string | null; + contact_email?: string | null; + }; + /** + * The permissions granted to the user-to-server access token. + */ + "app-permissions": { + /** + * The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`. + */ + actions?: "read" | "write"; + /** + * The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`. + */ + administration?: "read" | "write"; + /** + * The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`. + */ + checks?: "read" | "write"; + /** + * The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`. + */ + content_references?: "read" | "write"; + /** + * The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`. + */ + contents?: "read" | "write"; + /** + * The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`. + */ + deployments?: "read" | "write"; + /** + * The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`. + */ + environments?: "read" | "write"; + /** + * The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`. + */ + issues?: "read" | "write"; + /** + * The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`. + */ + metadata?: "read" | "write"; + /** + * The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`. + */ + packages?: "read" | "write"; + /** + * The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`. + */ + pages?: "read" | "write"; + /** + * The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`. + */ + pull_requests?: "read" | "write"; + /** + * The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`. + */ + repository_hooks?: "read" | "write"; + /** + * The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. + */ + repository_projects?: "read" | "write" | "admin"; + /** + * The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`. + */ + secret_scanning_alerts?: "read" | "write"; + /** + * The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`. + */ + secrets?: "read" | "write"; + /** + * The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`. + */ + security_events?: "read" | "write"; + /** + * The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`. + */ + single_file?: "read" | "write"; + /** + * The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`. + */ + statuses?: "read" | "write"; + /** + * The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`. + */ + vulnerability_alerts?: "read"; + /** + * The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`. + */ + workflows?: "write"; + /** + * The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`. + */ + members?: "read" | "write"; + /** + * The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`. + */ + organization_administration?: "read" | "write"; + /** + * The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`. + */ + organization_hooks?: "read" | "write"; + /** + * The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`. + */ + organization_plan?: "read"; + /** + * The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. + */ + organization_projects?: "read" | "write" | "admin"; + /** + * The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`. + */ + organization_secrets?: "read" | "write"; + /** + * The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`. + */ + organization_self_hosted_runners?: "read" | "write"; + /** + * The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`. + */ + organization_user_blocking?: "read" | "write"; + /** + * The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`. + */ + team_discussions?: "read" | "write"; + }; + /** + * License Simple + */ + "license-simple": { + key: string; + name: string; + url: string | null; + spdx_id: string | null; + node_id: string; + html_url?: string; + }; + /** + * A git repository + */ + repository: { + /** + * Unique identifier of the repository + */ + id: number; + node_id: string; + /** + * The name of the repository. + */ + name: string; + full_name: string; + license: components["schemas"]["license-simple"] | null; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: components["schemas"]["simple-user"] | null; + /** + * Whether the repository is private or public. + */ + private: boolean; + html_url: string; + description: string | null; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string | null; + hooks_url: string; + svn_url: string; + homepage: string | null; + language: string | null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + /** + * The default branch of the repository. + */ + default_branch: string; + open_issues_count: number; + /** + * Whether this repository acts as a template that can be used to generate new repositories. + */ + is_template?: boolean; + topics?: string[]; + /** + * Whether issues are enabled. + */ + has_issues: boolean; + /** + * Whether projects are enabled. + */ + has_projects: boolean; + /** + * Whether the wiki is enabled. + */ + has_wiki: boolean; + has_pages: boolean; + /** + * Whether downloads are enabled. + */ + has_downloads: boolean; + /** + * Whether the repository is archived. + */ + archived: boolean; + /** + * Returns whether or not this repository disabled. + */ + disabled: boolean; + /** + * The repository visibility: public, private, or internal. + */ + visibility?: string; + pushed_at: string | null; + created_at: string | null; + updated_at: string | null; + /** + * Whether to allow rebase merges for pull requests. + */ + allow_rebase_merge?: boolean; + template_repository?: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + }; + private?: boolean; + html_url?: string; + description?: string; + fork?: boolean; + url?: string; + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + downloads_url?: string; + events_url?: string; + forks_url?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + notifications_url?: string; + pulls_url?: string; + releases_url?: string; + ssh_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + clone_url?: string; + mirror_url?: string; + hooks_url?: string; + svn_url?: string; + homepage?: string; + language?: string; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string; + created_at?: string; + updated_at?: string; + permissions?: { admin?: boolean; push?: boolean; pull?: boolean }; + allow_rebase_merge?: boolean; + temp_clone_token?: string; + allow_squash_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; + } | null; + temp_clone_token?: string; + /** + * Whether to allow squash merges for pull requests. + */ + allow_squash_merge?: boolean; + /** + * Whether to delete head branches when pull requests are merged + */ + delete_branch_on_merge?: boolean; + /** + * Whether to allow merge commits for pull requests. + */ + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; + starred_at?: string; + }; + /** + * Authentication token for a GitHub App installed on a user or org. + */ + "installation-token": { + token: string; + expires_at: string; + permissions?: { + issues?: string; + contents?: string; + metadata?: string; + single_file?: string; + }; + repository_selection?: "all" | "selected"; + repositories?: components["schemas"]["repository"][]; + single_file?: string; + has_multiple_single_files?: boolean; + single_file_paths?: string[]; + }; + /** + * Validation Error + */ + "validation-error": { + message: string; + documentation_url: string; + errors?: { + resource?: string; + field?: string; + message?: string; + code: string; + index?: number; + value?: string | number | string[]; + }[]; + }; + /** + * The authorization associated with an OAuth Access. + */ + "application-grant": { + id: number; + url: string; + app: { client_id: string; name: string; url: string }; + created_at: string; + updated_at: string; + scopes: string[]; + user?: components["schemas"]["simple-user"] | null; + }; + "scoped-installation": { + permissions: components["schemas"]["app-permissions"]; + /** + * Describe whether all repositories have been selected or there's a selection involved + */ + repository_selection: "all" | "selected"; + single_file_name: string | null; + has_multiple_single_files?: boolean; + single_file_paths?: string[]; + repositories_url: string; + account: components["schemas"]["simple-user"]; + }; + /** + * The authorization for an OAuth app, GitHub App, or a Personal Access Token. + */ + authorization: { + id: number; + url: string; + /** + * A list of scopes that this authorization is in. + */ + scopes: string[] | null; + token: string; + token_last_eight: string | null; + hashed_token: string | null; + app: { client_id: string; name: string; url: string }; + note: string | null; + note_url: string | null; + updated_at: string; + created_at: string; + fingerprint: string | null; + user?: components["schemas"]["simple-user"] | null; + installation?: components["schemas"]["scoped-installation"] | null; + }; + /** + * Code Of Conduct + */ + "code-of-conduct": { + key: string; + name: string; + url: string; + body?: string; + html_url: string | null; + }; + /** + * Content Reference attachments allow you to provide context around URLs posted in comments + */ + "content-reference-attachment": { + /** + * The ID of the attachment + */ + id: number; + /** + * The title of the attachment + */ + title: string; + /** + * The body of the attachment + */ + body: string; + /** + * The node_id of the content attachment + */ + node_id?: string; + }; + /** + * The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. + */ + "enabled-organizations": "all" | "none" | "selected"; + /** + * The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`. + */ + "allowed-actions": "all" | "local_only" | "selected"; + /** + * The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`. + */ + "selected-actions-url": string; + "actions-enterprise-permissions": { + enabled_organizations: components["schemas"]["enabled-organizations"]; + /** + * The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. + */ + selected_organizations_url?: string; + allowed_actions: components["schemas"]["allowed-actions"]; + selected_actions_url?: components["schemas"]["selected-actions-url"]; + }; + /** + * Organization Simple + */ + "organization-simple": { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string | null; + }; + "selected-actions": { + /** + * Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. + */ + github_owned_allowed: boolean; + /** + * Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators. + */ + verified_allowed: boolean; + /** + * Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." + */ + patterns_allowed: string[]; + }; + "runner-groups-enterprise": { + id: number; + name: string; + visibility: string; + default: boolean; + selected_organizations_url?: string; + runners_url: string; + allows_public_repositories: boolean; + }; + /** + * A self hosted runner + */ + runner: { + /** + * The id of the runner. + */ + id: number; + /** + * The name of the runner. + */ + name: string; + /** + * The Operating System of the runner. + */ + os: string; + /** + * The status of the runner. + */ + status: string; + busy: boolean; + labels: { + /** + * Unique identifier of the label. + */ + id?: number; + /** + * Name of the label. + */ + name?: string; + /** + * The type of label. Read-only labels are applied automatically when the runner is configured. + */ + type?: "read-only" | "custom"; + }[]; + }; + /** + * Runner Application + */ + "runner-application": { + os: string; + architecture: string; + download_url: string; + filename: string; + }; + /** + * Authentication Token + */ + "authentication-token": { + /** + * The token used for authentication + */ + token: string; + /** + * The time this token expires + */ + expires_at: string; + permissions?: { [key: string]: any }; + /** + * The repositories this token has access to + */ + repositories?: components["schemas"]["repository"][]; + single_file?: string | null; + /** + * Describe whether all repositories have been selected or there's a selection involved + */ + repository_selection?: "all" | "selected"; + }; + "audit-log-event": { + /** + * The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + */ + "@timestamp"?: number; + /** + * The name of the action that was performed, for example `user.login` or `repo.create`. + */ + action?: string; + active?: boolean; + active_was?: boolean; + /** + * The actor who performed the action. + */ + actor?: string; + /** + * The username of the account being blocked. + */ + blocked_user?: string; + business?: string; + config?: any[]; + config_was?: any[]; + content_type?: string; + /** + * The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + */ + created_at?: number; + deploy_key_fingerprint?: string; + emoji?: string; + events?: any[]; + events_were?: any[]; + explanation?: string; + fingerprint?: string; + hook_id?: number; + limited_availability?: boolean; + message?: string; + name?: string; + old_user?: string; + openssh_public_key?: string; + org?: string; + previous_visibility?: string; + read_only?: boolean; + /** + * The name of the repository. + */ + repo?: string; + /** + * The name of the repository. + */ + repository?: string; + repository_public?: boolean; + target_login?: string; + team?: string; + /** + * The type of protocol (for example, HTTP or SSH) used to transfer Git data. + */ + transport_protocol?: number; + /** + * A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data. + */ + transport_protocol_name?: string; + /** + * The user that was affected by the action performed (if available). + */ + user?: string; + /** + * The repository visibility, for example `public` or `private`. + */ + visibility?: string; + }; + "actions-billing-usage": { + /** + * The sum of the free and paid GitHub Actions minutes used. + */ + total_minutes_used: number; + /** + * The total paid GitHub Actions minutes used. + */ + total_paid_minutes_used: number; + /** + * The amount of free GitHub Actions minutes available. + */ + included_minutes: number; + minutes_used_breakdown: { + /** + * Total minutes used on Ubuntu runner machines. + */ + UBUNTU?: number; + /** + * Total minutes used on macOS runner machines. + */ + MACOS?: number; + /** + * Total minutes used on Windows runner machines. + */ + WINDOWS?: number; + }; + }; + "packages-billing-usage": { + /** + * Sum of the free and paid storage space (GB) for GitHuub Packages. + */ + total_gigabytes_bandwidth_used: number; + /** + * Total paid storage space (GB) for GitHuub Packages. + */ + total_paid_gigabytes_bandwidth_used: number; + /** + * Free storage space (GB) for GitHub Packages. + */ + included_gigabytes_bandwidth: number; + }; + "combined-billing-usage": { + /** + * Numbers of days left in billing cycle. + */ + days_left_in_billing_cycle: number; + /** + * Estimated storage space (GB) used in billing cycle. + */ + estimated_paid_storage_for_month: number; + /** + * Estimated sum of free and paid storage space (GB) used in billing cycle. + */ + estimated_storage_for_month: number; + }; + /** + * Actor + */ + actor: { + id: number; + login: string; + display_login?: string; + gravatar_id: string | null; + url: string; + avatar_url: string; + }; + /** + * Color-coded labels help you categorize and filter your issues (just like labels in Gmail). + */ + label: { + id: number; + node_id: string; + /** + * URL for the label + */ + url: string; + /** + * The name of the label. + */ + name: string; + description: string | null; + /** + * 6-character hex code, without the leading #, identifying the color + */ + color: string; + default: boolean; + }; + /** + * A collection of related issues and pull requests. + */ + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + /** + * The number of the milestone. + */ + number: number; + /** + * The state of the milestone. + */ + state: "open" | "closed"; + /** + * The title of the milestone. + */ + title: string; + description: string | null; + creator: components["schemas"]["simple-user"] | null; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string | null; + due_on: string | null; + }; + /** + * Issue Simple + */ + "issue-simple": { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body?: string; + user: components["schemas"]["simple-user"] | null; + labels: components["schemas"]["label"][]; + assignee: components["schemas"]["simple-user"] | null; + assignees?: components["schemas"]["simple-user"][] | null; + milestone: components["schemas"]["milestone"] | null; + locked: boolean; + active_lock_reason?: string | null; + comments: number; + pull_request?: { + merged_at?: string | null; + diff_url: string | null; + html_url: string | null; + patch_url: string | null; + url: string | null; + }; + closed_at: string | null; + created_at: string; + updated_at: string; + author_association: string; + body_html?: string; + body_text?: string; + timeline_url?: string; + repository?: components["schemas"]["repository"]; + performed_via_github_app?: components["schemas"]["integration"] | null; + }; + "reaction-rollup": { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + eyes: number; + rocket: number; + }; + /** + * Comments provide a way for people to collaborate on an issue. + */ + "issue-comment": { + /** + * Unique identifier of the issue comment + */ + id: number; + node_id: string; + /** + * URL for the issue comment + */ + url: string; + /** + * Contents of the issue comment + */ + body?: string; + body_text?: string; + body_html?: string; + html_url: string; + user: components["schemas"]["simple-user"] | null; + created_at: string; + updated_at: string; + issue_url: string; + author_association: + | "collaborator" + | "contributor" + | "first_timer" + | "first_time_contributor" + | "mannequin" + | "member" + | "none" + | "owner"; + performed_via_github_app?: components["schemas"]["integration"] | null; + reactions?: components["schemas"]["reaction-rollup"]; + }; + /** + * Event + */ + event: { + id: string; + type: string | null; + actor: components["schemas"]["actor"]; + repo: { id: number; name: string; url: string }; + org?: components["schemas"]["actor"]; + payload: { + action: string; + issue?: components["schemas"]["issue-simple"]; + comment?: components["schemas"]["issue-comment"]; + pages?: { + page_name?: string; + title?: string; + summary?: string | null; + action?: string; + sha?: string; + html_url?: string; + }[]; + }; + public: boolean; + created_at: string | null; + }; + /** + * Hypermedia Link with Type + */ + "link-with-type": { href: string; type: string }; + /** + * Feed + */ + feed: { + timeline_url: string; + user_url: string; + current_user_public_url?: string; + current_user_url?: string; + current_user_actor_url?: string; + current_user_organization_url?: string; + current_user_organization_urls?: string[]; + security_advisories_url?: string; + _links: { + timeline: components["schemas"]["link-with-type"]; + user: components["schemas"]["link-with-type"]; + security_advisories?: components["schemas"]["link-with-type"]; + current_user?: components["schemas"]["link-with-type"]; + current_user_public?: components["schemas"]["link-with-type"]; + current_user_actor?: components["schemas"]["link-with-type"]; + current_user_organization?: components["schemas"]["link-with-type"]; + current_user_organizations?: components["schemas"]["link-with-type"][]; + }; + }; + /** + * Base Gist + */ + "base-gist": { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [key: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string | null; + comments: number; + user: components["schemas"]["simple-user"] | null; + comments_url: string; + owner?: components["schemas"]["simple-user"] | null; + truncated?: boolean; + forks?: { [key: string]: any }[]; + history?: { [key: string]: any }[]; + }; + /** + * Gist Simple + */ + "gist-simple": { + url?: string; + forks_url?: string; + commits_url?: string; + id?: string; + node_id?: string; + git_pull_url?: string; + git_push_url?: string; + html_url?: string; + files?: { + [key: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + }; + }; + public?: boolean; + created_at?: string; + updated_at?: string; + description?: string | null; + comments?: number; + user?: string | null; + comments_url?: string; + owner?: components["schemas"]["simple-user"]; + truncated?: boolean; + }; + /** + * Gist Full + */ + "gist-full": components["schemas"]["gist-simple"] & { + forks?: { + user?: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + }; + url?: string; + id?: string; + created_at?: string; + updated_at?: string; + }[]; + history?: { + url?: string; + version?: string; + user?: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + } | null; + change_status?: { + deletions?: number; + additions?: number; + total?: number; + }; + committed_at?: string; + }[]; + fork_of?: components["schemas"]["gist-simple"] | null; + url?: string; + forks_url?: string; + commits_url?: string; + id?: string; + node_id?: string; + git_pull_url?: string; + git_push_url?: string; + html_url?: string; + created_at?: string; + updated_at?: string; + description?: string | null; + comments?: number; + comments_url?: string; + }; + /** + * A comment made to a gist. + */ + "gist-comment": { + id: number; + node_id: string; + url: string; + /** + * The comment text. + */ + body: string; + user: components["schemas"]["simple-user"] | null; + created_at: string; + updated_at: string; + author_association: string; + }; + /** + * Gist Commit + */ + "gist-commit": { + url: string; + version: string; + user: components["schemas"]["simple-user"] | null; + change_status: { total?: number; additions?: number; deletions?: number }; + committed_at: string; + }; + /** + * Gitignore Template + */ + "gitignore-template": { name: string; source: string }; + /** + * Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. + */ + issue: { + id: number; + node_id: string; + /** + * URL for the issue + */ + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + /** + * Number uniquely identifying the issue within its repository + */ + number: number; + /** + * State of the issue; either 'open' or 'closed' + */ + state: string; + /** + * Title of the issue + */ + title: string; + /** + * Contents of the issue + */ + body?: string; + user: components["schemas"]["simple-user"] | null; + /** + * Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository + */ + labels: ( + | string + | { + id?: number; + node_id?: string; + url?: string; + name?: string; + description?: string | null; + color?: string | null; + default?: boolean; + } + )[]; + assignee: components["schemas"]["simple-user"] | null; + assignees?: components["schemas"]["simple-user"][] | null; + milestone: components["schemas"]["milestone"] | null; + locked: boolean; + active_lock_reason?: string | null; + comments: number; + pull_request?: { + merged_at?: string | null; + diff_url: string | null; + html_url: string | null; + patch_url: string | null; + url: string | null; + }; + closed_at: string | null; + created_at: string; + updated_at: string; + closed_by?: components["schemas"]["simple-user"] | null; + body_html?: string; + body_text?: string; + timeline_url?: string; + repository?: components["schemas"]["repository"]; + performed_via_github_app?: components["schemas"]["integration"] | null; + author_association: string; + reactions?: components["schemas"]["reaction-rollup"]; + }; + /** + * License + */ + license: { + key: string; + name: string; + spdx_id: string | null; + url: string | null; + node_id: string; + html_url: string; + description: string; + implementation: string; + permissions: string[]; + conditions: string[]; + limitations: string[]; + body: string; + featured: boolean; + }; + /** + * Marketplace Listing Plan + */ + "marketplace-listing-plan": { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string | null; + state: string; + bullets: string[]; + }; + /** + * Marketplace Purchase + */ + "marketplace-purchase": { + url: string; + type: string; + id: number; + login: string; + organization_billing_email?: string; + marketplace_pending_change?: { + is_installed?: boolean; + effective_date?: string; + unit_count?: number | null; + id?: number; + plan?: components["schemas"]["marketplace-listing-plan"]; + } | null; + marketplace_purchase: { + billing_cycle?: string; + next_billing_date?: string | null; + is_installed?: boolean; + unit_count?: number | null; + on_free_trial?: boolean; + free_trial_ends_on?: string | null; + updated_at?: string; + plan?: components["schemas"]["marketplace-listing-plan"]; + }; + }; + /** + * Api Overview + */ + "api-overview": { + verifiable_password_authentication: boolean; + ssh_key_fingerprints?: { SHA256_RSA?: string; SHA256_DSA?: string }; + hooks?: string[]; + web?: string[]; + api?: string[]; + git?: string[]; + pages?: string[]; + importer?: string[]; + actions?: string[]; + }; + /** + * Minimal Repository + */ + "minimal-repository": { + id: number; + node_id: string; + name: string; + full_name: string; + owner: components["schemas"]["simple-user"] | null; + private: boolean; + html_url: string; + description: string | null; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url?: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url?: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url?: string; + mirror_url?: string | null; + hooks_url: string; + svn_url?: string; + homepage?: string | null; + language?: string | null; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string | null; + created_at?: string | null; + updated_at?: string | null; + permissions?: { admin?: boolean; push?: boolean; pull?: boolean }; + template_repository?: components["schemas"]["repository"] | null; + temp_clone_token?: string; + delete_branch_on_merge?: boolean; + subscribers_count?: number; + network_count?: number; + license?: { + key?: string; + name?: string; + spdx_id?: string; + url?: string; + node_id?: string; + } | null; + forks?: number; + open_issues?: number; + watchers?: number; + }; + /** + * Thread + */ + thread: { + id: string; + repository: components["schemas"]["minimal-repository"]; + subject: { + title: string; + url: string; + latest_comment_url: string; + type: string; + }; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string | null; + url: string; + subscription_url: string; + }; + /** + * Thread Subscription + */ + "thread-subscription": { + subscribed: boolean; + ignored: boolean; + reason: string | null; + created_at: string | null; + url: string; + thread_url?: string; + repository_url?: string; + }; + /** + * Organization Full + */ + "organization-full": { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string | null; + name?: string; + company?: string; + blog?: string; + location?: string; + email?: string; + twitter_username?: string | null; + is_verified?: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + total_private_repos?: number; + owned_private_repos?: number; + private_gists?: number | null; + disk_usage?: number | null; + collaborators?: number | null; + billing_email?: string | null; + plan?: { + name: string; + space: number; + private_repos: number; + filled_seats?: number; + seats?: number; + }; + default_repository_permission?: string | null; + members_can_create_repositories?: boolean | null; + two_factor_requirement_enabled?: boolean | null; + members_allowed_repository_creation_type?: string; + members_can_create_public_repositories?: boolean; + members_can_create_private_repositories?: boolean; + members_can_create_internal_repositories?: boolean; + members_can_create_pages?: boolean; + updated_at: string; + }; + /** + * The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. + */ + "enabled-repositories": "all" | "none" | "selected"; + "actions-organization-permissions": { + enabled_repositories: components["schemas"]["enabled-repositories"]; + /** + * The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. + */ + selected_repositories_url?: string; + allowed_actions: components["schemas"]["allowed-actions"]; + selected_actions_url?: components["schemas"]["selected-actions-url"]; + }; + "runner-groups-org": { + id: number; + name: string; + visibility: string; + default: boolean; + /** + * Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` + */ + selected_repositories_url?: string; + runners_url: string; + inherited: boolean; + inherited_allows_public_repositories?: boolean; + allows_public_repositories: boolean; + }; + /** + * Secrets for GitHub Actions for an organization. + */ + "organization-actions-secret": { + /** + * The name of the secret. + */ + name: string; + created_at: string; + updated_at: string; + /** + * Visibility of a secret + */ + visibility: "all" | "private" | "selected"; + selected_repositories_url?: string; + }; + /** + * The public key used for setting Actions Secrets. + */ + "actions-public-key": { + /** + * The identifier for the key. + */ + key_id: string; + /** + * The Base64 encoded public key. + */ + key: string; + id?: number; + url?: string; + title?: string; + created_at?: string; + }; + /** + * Credential Authorization + */ + "credential-authorization": { + /** + * User login that owns the underlying credential. + */ + login: string; + /** + * Unique identifier for the credential. + */ + credential_id: number; + /** + * Human-readable description of the credential type. + */ + credential_type: string; + /** + * Last eight characters of the credential. Only included in responses with credential_type of personal access token. + */ + token_last_eight?: string; + /** + * Date when the credential was authorized for use. + */ + credential_authorized_at: string; + /** + * List of oauth scopes the token has been granted. + */ + scopes?: string[]; + /** + * Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key. + */ + fingerprint?: string; + /** + * Date when the credential was last accessed. May be null if it was never accessed + */ + credential_accessed_at?: string | null; + authorized_credential_id?: number | null; + /** + * The title given to the ssh key. This will only be present when the credential is an ssh key. + */ + authorized_credential_title?: string; + /** + * The note given to the token. This will only be present when the credential is a token. + */ + authorized_credential_note?: string; + }; + /** + * Org Hook + */ + "org-hook": { + id: number; + url: string; + ping_url: string; + name: string; + events: string[]; + active: boolean; + config: { + url?: string; + insecure_ssl?: string; + content_type?: string; + secret?: string; + }; + updated_at: string; + created_at: string; + type: string; + }; + /** + * The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`. + */ + "interaction-group": + | "existing_users" + | "contributors_only" + | "collaborators_only"; + /** + * Interaction limit settings. + */ + "interaction-limit-response": { + limit: components["schemas"]["interaction-group"]; + origin: string; + expires_at: string; + }; + /** + * The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`. + */ + "interaction-expiry": + | "one_day" + | "three_days" + | "one_week" + | "one_month" + | "six_months"; + /** + * Limit interactions to a specific type of user for a specified duration + */ + "interaction-limit": { + limit: components["schemas"]["interaction-group"]; + expiry?: components["schemas"]["interaction-expiry"]; + }; + /** + * Organization Invitation + */ + "organization-invitation": { + id: number; + login: string | null; + email: string | null; + role: string; + created_at: string; + inviter: components["schemas"]["simple-user"]; + team_count: number; + invitation_team_url: string; + node_id: string; + invitation_teams_url?: string; + }; + /** + * Groups of organization members that gives permissions on specified repositories. + */ + "team-simple": { + /** + * Unique identifier of the team + */ + id: number; + node_id: string; + /** + * URL for the team + */ + url: string; + members_url: string; + /** + * Name of the team + */ + name: string; + /** + * Description of the team + */ + description: string | null; + /** + * Permission that the team will have for its repositories + */ + permission: string; + /** + * The level of privacy this team should have + */ + privacy?: string; + html_url: string; + repositories_url: string; + slug: string; + /** + * Distinguished Name (DN) that team maps to within LDAP environment + */ + ldap_dn?: string; + } | null; + /** + * Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + permission: string; + url: string; + html_url: string; + members_url: string; + repositories_url: string; + parent?: components["schemas"]["team-simple"] | null; + }; + /** + * Org Membership + */ + "org-membership": { + url: string; + state: string; + role: string; + organization_url: string; + organization: components["schemas"]["organization-simple"]; + user: components["schemas"]["simple-user"] | null; + permissions?: { can_create_repository: boolean }; + }; + /** + * A migration. + */ + migration: { + id: number; + owner: components["schemas"]["simple-user"] | null; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: components["schemas"]["repository"][]; + url: string; + created_at: string; + updated_at: string; + node_id: string; + archive_url?: string; + exclude?: { [key: string]: any }[]; + }; + /** + * Projects are a way to organize columns and cards of work. + */ + project: { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + /** + * Name of the project + */ + name: string; + /** + * Body of the project + */ + body: string | null; + number: number; + /** + * State of the project; either 'open' or 'closed' + */ + state: string; + creator: components["schemas"]["simple-user"] | null; + created_at: string; + updated_at: string; + /** + * The baseline permission that all organization members have on this project. Only present if owner is an organization. + */ + organization_permission?: "read" | "write" | "admin" | "none"; + /** + * Whether or not this project can be seen by everyone. Only present if owner is an organization. + */ + private?: boolean; + }; + /** + * External Groups to be mapped to a team for membership + */ + "group-mapping": { + /** + * Array of groups to be mapped to this team + */ + groups?: { + /** + * The ID of the group + */ + group_id: string; + /** + * The name of the group + */ + group_name: string; + /** + * a description of the group + */ + group_description: string; + }[]; + /** + * The ID of the group + */ + group_id?: string; + /** + * The name of the group + */ + group_name?: string; + /** + * a description of the group + */ + group_description?: string; + /** + * synchronization status for this group mapping + */ + status?: string; + /** + * the time of the last sync for this group-mapping + */ + synced_at?: string; + }; + /** + * Groups of organization members that gives permissions on specified repositories. + */ + "team-full": { + /** + * Unique identifier of the team + */ + id: number; + node_id: string; + /** + * URL for the team + */ + url: string; + html_url: string; + /** + * Name of the team + */ + name: string; + slug: string; + description: string | null; + /** + * The level of privacy this team should have + */ + privacy?: "closed" | "secret"; + /** + * Permission that the team will have for its repositories + */ + permission: string; + members_url: string; + repositories_url: string; + parent?: components["schemas"]["team-simple"] | null; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: components["schemas"]["organization-full"]; + /** + * Distinguished Name (DN) that team maps to within LDAP environment + */ + ldap_dn?: string; + }; + /** + * A team discussion is a persistent record of a free-form conversation within a team. + */ + "team-discussion": { + author: components["schemas"]["simple-user"] | null; + /** + * The main text of the discussion. + */ + body: string; + body_html: string; + /** + * The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. + */ + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string | null; + html_url: string; + node_id: string; + /** + * The unique sequence number of a team discussion. + */ + number: number; + /** + * Whether or not this discussion should be pinned for easy retrieval. + */ + pinned: boolean; + /** + * Whether or not this discussion should be restricted to team members and organization administrators. + */ + private: boolean; + team_url: string; + /** + * The title of the discussion. + */ + title: string; + updated_at: string; + url: string; + reactions?: components["schemas"]["reaction-rollup"]; + }; + /** + * A reply to a discussion within a team. + */ + "team-discussion-comment": { + author: components["schemas"]["simple-user"] | null; + /** + * The main text of the comment. + */ + body: string; + body_html: string; + /** + * The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. + */ + body_version: string; + created_at: string; + last_edited_at: string | null; + discussion_url: string; + html_url: string; + node_id: string; + /** + * The unique sequence number of a team discussion comment. + */ + number: number; + updated_at: string; + url: string; + reactions?: components["schemas"]["reaction-rollup"]; + }; + /** + * Reactions to conversations provide a way to help people express their feelings more simply and effectively. + */ + reaction: { + id: number; + node_id: string; + user: components["schemas"]["simple-user"] | null; + /** + * The reaction to use + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + created_at: string; + }; + /** + * Team Membership + */ + "team-membership": { + url: string; + /** + * The role of the user in the team. + */ + role: "member" | "maintainer"; + state: string; + }; + /** + * A team's access to a project. + */ + "team-project": { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string | null; + number: number; + state: string; + creator: components["schemas"]["simple-user"]; + created_at: string; + updated_at: string; + /** + * The organization permission for this project. Only present when owner is an organization. + */ + organization_permission?: string; + /** + * Whether the project is private or not. Only present when owner is an organization. + */ + private?: boolean; + permissions: { read: boolean; write: boolean; admin: boolean }; + }; + /** + * A team's access to a repository. + */ + "team-repository": { + /** + * Unique identifier of the repository + */ + id: number; + node_id: string; + /** + * The name of the repository. + */ + name: string; + full_name: string; + license: components["schemas"]["license-simple"] | null; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: components["schemas"]["simple-user"] | null; + /** + * Whether the repository is private or public. + */ + private: boolean; + html_url: string; + description: string | null; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string | null; + hooks_url: string; + svn_url: string; + homepage: string | null; + language: string | null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + /** + * The default branch of the repository. + */ + default_branch: string; + open_issues_count: number; + /** + * Whether this repository acts as a template that can be used to generate new repositories. + */ + is_template?: boolean; + topics?: string[]; + /** + * Whether issues are enabled. + */ + has_issues: boolean; + /** + * Whether projects are enabled. + */ + has_projects: boolean; + /** + * Whether the wiki is enabled. + */ + has_wiki: boolean; + has_pages: boolean; + /** + * Whether downloads are enabled. + */ + has_downloads: boolean; + /** + * Whether the repository is archived. + */ + archived: boolean; + /** + * Returns whether or not this repository disabled. + */ + disabled: boolean; + /** + * The repository visibility: public, private, or internal. + */ + visibility?: string; + pushed_at: string | null; + created_at: string | null; + updated_at: string | null; + /** + * Whether to allow rebase merges for pull requests. + */ + allow_rebase_merge?: boolean; + template_repository?: components["schemas"]["repository"] | null; + temp_clone_token?: string; + /** + * Whether to allow squash merges for pull requests. + */ + allow_squash_merge?: boolean; + /** + * Whether to delete head branches when pull requests are merged + */ + delete_branch_on_merge?: boolean; + /** + * Whether to allow merge commits for pull requests. + */ + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; + }; + /** + * Project cards represent a scope of work. + */ + "project-card": { + url: string; + /** + * The project card's ID + */ + id: number; + node_id: string; + note: string | null; + creator: components["schemas"]["simple-user"] | null; + created_at: string; + updated_at: string; + /** + * Whether or not the card is archived + */ + archived?: boolean; + column_url: string; + content_url?: string; + project_url: string; + }; + /** + * Project columns contain cards of work. + */ + "project-column": { + url: string; + project_url: string; + cards_url: string; + /** + * The unique identifier of the project column + */ + id: number; + node_id: string; + /** + * Name of the project column + */ + name: string; + created_at: string; + updated_at: string; + }; + /** + * Repository Collaborator Permission + */ + "repository-collaborator-permission": { + permission: string; + user: components["schemas"]["simple-user"] | null; + }; + "rate-limit": { limit: number; remaining: number; reset: number }; + /** + * Rate Limit Overview + */ + "rate-limit-overview": { + resources: { + core: components["schemas"]["rate-limit"]; + graphql?: components["schemas"]["rate-limit"]; + search: components["schemas"]["rate-limit"]; + source_import?: components["schemas"]["rate-limit"]; + integration_manifest?: components["schemas"]["rate-limit"]; + code_scanning_upload?: components["schemas"]["rate-limit"]; + }; + rate: components["schemas"]["rate-limit"]; + }; + /** + * Full Repository + */ + "full-repository": { + id: number; + node_id: string; + name: string; + full_name: string; + owner: components["schemas"]["simple-user"] | null; + private: boolean; + html_url: string; + description: string | null; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string | null; + hooks_url: string; + svn_url: string; + homepage: string | null; + language: string | null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template?: boolean; + topics?: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + /** + * Returns whether or not this repository disabled. + */ + disabled: boolean; + /** + * The repository visibility: public, private, or internal. + */ + visibility?: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions?: { admin: boolean; pull: boolean; push: boolean }; + allow_rebase_merge?: boolean; + template_repository?: components["schemas"]["repository"] | null; + temp_clone_token?: string | null; + allow_squash_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_merge_commit?: boolean; + subscribers_count: number; + network_count: number; + license: components["schemas"]["license-simple"] | null; + organization?: components["schemas"]["simple-user"] | null; + parent?: components["schemas"]["repository"]; + source?: components["schemas"]["repository"]; + forks: number; + master_branch?: string; + open_issues: number; + watchers: number; + /** + * Whether anonymous git access is allowed. + */ + anonymous_access_enabled?: boolean; + }; + /** + * An artifact + */ + artifact: { + id: number; + node_id: string; + /** + * The name of the artifact. + */ + name: string; + /** + * The size in bytes of the artifact. + */ + size_in_bytes: number; + url: string; + archive_download_url: string; + /** + * Whether or not the artifact has expired. + */ + expired: boolean; + created_at: string | null; + expires_at: string; + updated_at: string | null; + }; + /** + * Information of a job execution in a workflow run + */ + job: { + /** + * The id of the job. + */ + id: number; + /** + * The id of the associated workflow run. + */ + run_id: number; + run_url: string; + node_id: string; + /** + * The SHA of the commit that is being run. + */ + head_sha: string; + url: string; + html_url: string | null; + /** + * The phase of the lifecycle that the job is currently in. + */ + status: "queued" | "in_progress" | "completed"; + /** + * The outcome of the job. + */ + conclusion: string | null; + /** + * The time that the job started, in ISO 8601 format. + */ + started_at: string; + /** + * The time that the job finished, in ISO 8601 format. + */ + completed_at: string | null; + /** + * The name of the job. + */ + name: string; + /** + * Steps in this job. + */ + steps?: { + /** + * The phase of the lifecycle that the job is currently in. + */ + status: "queued" | "in_progress" | "completed"; + /** + * The outcome of the job. + */ + conclusion: string | null; + /** + * The name of the job. + */ + name: string; + number: number; + /** + * The time that the step started, in ISO 8601 format. + */ + started_at?: string | null; + /** + * The time that the job finished, in ISO 8601 format. + */ + completed_at?: string | null; + }[]; + check_run_url: string; + }; + /** + * Whether GitHub Actions is enabled on the repository. + */ + "actions-enabled": boolean; + "actions-repository-permissions": { + enabled: components["schemas"]["actions-enabled"]; + allowed_actions: components["schemas"]["allowed-actions"]; + selected_actions_url?: components["schemas"]["selected-actions-url"]; + }; + "pull-request-minimal": { + id: number; + number: number; + url: string; + head: { + ref: string; + sha: string; + repo: { id: number; url: string; name: string }; + }; + base: { + ref: string; + sha: string; + repo: { id: number; url: string; name: string }; + }; + }; + /** + * Simple Commit + */ + "simple-commit": { + id: string; + tree_id: string; + message: string; + timestamp: string; + author: { name: string; email: string } | null; + committer: { name: string; email: string } | null; + }; + /** + * An invocation of a workflow + */ + "workflow-run": { + /** + * The ID of the workflow run. + */ + id: number; + /** + * The name of the workflow run. + */ + name?: string; + node_id: string; + head_branch: string | null; + /** + * The SHA of the head commit that points to the version of the worflow being run. + */ + head_sha: string; + /** + * The auto incrementing run number for the workflow run. + */ + run_number: number; + event: string; + status: string | null; + conclusion: string | null; + /** + * The ID of the parent workflow. + */ + workflow_id: number; + /** + * The URL to the workflow run. + */ + url: string; + html_url: string; + pull_requests: components["schemas"]["pull-request-minimal"][] | null; + created_at: string; + updated_at: string; + /** + * The URL to the jobs for the workflow run. + */ + jobs_url: string; + /** + * The URL to download the logs for the workflow run. + */ + logs_url: string; + /** + * The URL to the associated check suite. + */ + check_suite_url: string; + /** + * The URL to the artifacts for the workflow run. + */ + artifacts_url: string; + /** + * The URL to cancel the workflow run. + */ + cancel_url: string; + /** + * The URL to rerun the workflow run. + */ + rerun_url: string; + /** + * The URL to the workflow. + */ + workflow_url: string; + head_commit: components["schemas"]["simple-commit"]; + repository: components["schemas"]["minimal-repository"]; + head_repository: components["schemas"]["minimal-repository"]; + head_repository_id?: number; + }; + /** + * Workflow Run Usage + */ + "workflow-run-usage": { + billable: { + UBUNTU?: { total_ms: number; jobs: number }; + MACOS?: { total_ms: number; jobs: number }; + WINDOWS?: { total_ms: number; jobs: number }; + }; + run_duration_ms: number; + }; + /** + * Set secrets for GitHub Actions. + */ + "actions-secret": { + /** + * The name of the secret. + */ + name: string; + created_at: string; + updated_at: string; + }; + /** + * A GitHub Actions workflow + */ + workflow: { + id: number; + node_id: string; + name: string; + path: string; + state: "active" | "deleted"; + created_at: string; + updated_at: string; + url: string; + html_url: string; + badge_url: string; + deleted_at?: string; + }; + /** + * Workflow Usage + */ + "workflow-usage": { + billable: { + UBUNTU?: { total_ms?: number }; + MACOS?: { total_ms?: number }; + WINDOWS?: { total_ms?: number }; + }; + }; + /** + * Protected Branch Admin Enforced + */ + "protected-branch-admin-enforced": { url: string; enabled: boolean }; + /** + * Protected Branch Pull Request Review + */ + "protected-branch-pull-request-review": { + url?: string; + dismissal_restrictions?: { + /** + * The list of users with review dismissal access. + */ + users?: components["schemas"]["simple-user"][]; + /** + * The list of teams with review dismissal access. + */ + teams?: components["schemas"]["team"][]; + url?: string; + users_url?: string; + teams_url?: string; + }; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count?: number; + }; + /** + * Branch Restriction Policy + */ + "branch-restriction-policy": { + url: string; + users_url: string; + teams_url: string; + apps_url: string; + users: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + }[]; + teams: { + id?: number; + node_id?: string; + url?: string; + html_url?: string; + name?: string; + slug?: string; + description?: string | null; + privacy?: string; + permission?: string; + members_url?: string; + repositories_url?: string; + parent?: string | null; + }[]; + apps: { + id?: number; + slug?: string; + node_id?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + url?: string; + repos_url?: string; + events_url?: string; + hooks_url?: string; + issues_url?: string; + members_url?: string; + public_members_url?: string; + avatar_url?: string; + description?: string; + gravatar_id?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + received_events_url?: string; + type?: string; + }; + name?: string; + description?: string; + external_url?: string; + html_url?: string; + created_at?: string; + updated_at?: string; + permissions?: { + metadata?: string; + contents?: string; + issues?: string; + single_file?: string; + }; + events?: string[]; + }[]; + }; + /** + * Branch Protection + */ + "branch-protection": { + url?: string; + required_status_checks: { + url?: string; + enforcement_level: string; + contexts: string[]; + contexts_url?: string; + }; + enforce_admins?: components["schemas"]["protected-branch-admin-enforced"]; + required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"]; + restrictions?: components["schemas"]["branch-restriction-policy"]; + required_linear_history?: { enabled?: boolean }; + allow_force_pushes?: { enabled?: boolean }; + allow_deletions?: { enabled?: boolean }; + enabled: boolean; + name?: string; + protection_url?: string; + }; + /** + * Short Branch + */ + "short-branch": { + name: string; + commit: { sha: string; url: string }; + protected: boolean; + protection?: components["schemas"]["branch-protection"]; + protection_url?: string; + }; + /** + * Metaproperties for Git author/committer information. + */ + "git-user": { name?: string; email?: string; date?: string }; + verification: { + verified: boolean; + reason: string; + payload: string | null; + signature: string | null; + }; + /** + * Commit + */ + commit: { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: components["schemas"]["git-user"] | null; + committer: components["schemas"]["git-user"] | null; + message: string; + comment_count: number; + tree: { sha: string; url: string }; + verification?: components["schemas"]["verification"]; + }; + author: components["schemas"]["simple-user"] | null; + committer: components["schemas"]["simple-user"] | null; + parents: { sha: string; url: string; html_url?: string }[]; + stats?: { additions?: number; deletions?: number; total?: number }; + files?: { + filename?: string; + additions?: number; + deletions?: number; + changes?: number; + status?: string; + raw_url?: string; + blob_url?: string; + patch?: string; + sha?: string; + contents_url?: string; + previous_filename?: string; + }[]; + }; + /** + * Branch With Protection + */ + "branch-with-protection": { + name: string; + commit: components["schemas"]["commit"]; + _links: { html: string; self: string }; + protected: boolean; + protection: components["schemas"]["branch-protection"]; + protection_url: string; + pattern?: string; + required_approving_review_count?: number; + }; + /** + * Status Check Policy + */ + "status-check-policy": { + url: string; + strict: boolean; + contexts: string[]; + contexts_url: string; + }; + /** + * Branch protections protect branches + */ + "protected-branch": { + url: string; + required_status_checks?: components["schemas"]["status-check-policy"]; + required_pull_request_reviews?: { + url: string; + dismiss_stale_reviews?: boolean; + require_code_owner_reviews?: boolean; + required_approving_review_count?: number; + dismissal_restrictions?: { + url: string; + users_url: string; + teams_url: string; + users: components["schemas"]["simple-user"][]; + teams: components["schemas"]["team"][]; + }; + }; + required_signatures?: { url: string; enabled: boolean }; + enforce_admins?: { url: string; enabled: boolean }; + required_linear_history?: { enabled: boolean }; + allow_force_pushes?: { enabled: boolean }; + allow_deletions?: { enabled: boolean }; + restrictions?: components["schemas"]["branch-restriction-policy"]; + }; + /** + * A check performed on the code of a given code change + */ + "check-run": { + /** + * The id of the check. + */ + id: number; + /** + * The SHA of the commit that is being checked. + */ + head_sha: string; + node_id: string; + external_id: string | null; + url: string; + html_url: string | null; + details_url: string | null; + /** + * The phase of the lifecycle that the check is currently in. + */ + status: "queued" | "in_progress" | "completed"; + conclusion: + | ( + | "success" + | "failure" + | "neutral" + | "cancelled" + | "skipped" + | "timed_out" + | "action_required" + ) + | null; + started_at: string | null; + completed_at: string | null; + output: { + title: string | null; + summary: string | null; + text: string | null; + annotations_count: number; + annotations_url: string; + }; + /** + * The name of the check. + */ + name: string; + check_suite: { id: number } | null; + app: components["schemas"]["integration"] | null; + pull_requests: components["schemas"]["pull-request-minimal"][]; + }; + /** + * Check Annotation + */ + "check-annotation": { + path: string; + start_line: number; + end_line: number; + start_column: number | null; + end_column: number | null; + annotation_level: string | null; + title: string | null; + message: string | null; + raw_details: string | null; + blob_href: string; + }; + /** + * A suite of checks performed on the code of a given code change + */ + "check-suite": { + id: number; + node_id: string; + head_branch: string | null; + /** + * The SHA of the head commit that is being checked. + */ + head_sha: string; + status: ("queued" | "in_progress" | "completed") | null; + conclusion: + | ( + | "success" + | "failure" + | "neutral" + | "cancelled" + | "skipped" + | "timed_out" + | "action_required" + ) + | null; + url: string | null; + before: string | null; + after: string | null; + pull_requests: components["schemas"]["pull-request-minimal"][] | null; + app: components["schemas"]["integration"] | null; + repository: components["schemas"]["minimal-repository"]; + created_at: string | null; + updated_at: string | null; + head_commit: components["schemas"]["simple-commit"]; + latest_check_runs_count: number; + check_runs_url: string; + }; + /** + * Check suite configuration preferences for a repository. + */ + "check-suite-preference": { + preferences: { + auto_trigger_checks?: { app_id: number; setting: boolean }[]; + }; + repository: components["schemas"]["repository"]; + }; + /** + * State of a code scanning alert. + */ + "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + /** + * The full Git reference, formatted as `refs/heads/`. + */ + "code-scanning-alert-ref": string; + /** + * The security alert number. + */ + "alert-number": number; + /** + * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-created-at": string; + /** + * The REST API URL of the alert resource. + */ + "alert-url": string; + /** + * The GitHub URL of the alert resource. + */ + "alert-html-url": string; + /** + * The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "code-scanning-alert-dismissed-at": string | null; + /** + * **Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + */ + "code-scanning-alert-dismissed-reason": string | null; + "code-scanning-alert-rule": { + /** + * A unique identifier for the rule used to detect the alert. + */ + id?: string | null; + /** + * The severity of the alert. + */ + severity?: ("none" | "note" | "warning" | "error") | null; + /** + * A short description of the rule used to detect the alert. + */ + description?: string; + }; + /** + * The name of the tool used to generate the code scanning analysis alert. + */ + "code-scanning-analysis-tool-name": string; + "code-scanning-analysis-tool": { + name?: components["schemas"]["code-scanning-analysis-tool-name"]; + /** + * The version of the tool used to detect the alert. + */ + version?: string | null; + }; + "code-scanning-alert-code-scanning-alert-items": { + number: components["schemas"]["alert-number"]; + created_at: components["schemas"]["alert-created-at"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + state: components["schemas"]["code-scanning-alert-state"]; + dismissed_by: components["schemas"]["simple-user"]; + dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; + dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; + rule: components["schemas"]["code-scanning-alert-rule"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + }; + /** + * Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. + */ + "code-scanning-analysis-analysis-key": string; + /** + * Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. + */ + "code-scanning-alert-environment": string; + "code-scanning-alert-instances": + | { + ref?: components["schemas"]["code-scanning-alert-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + matrix_vars?: string | null; + state?: components["schemas"]["code-scanning-alert-state"]; + }[] + | null; + "code-scanning-alert-code-scanning-alert": { + number: components["schemas"]["alert-number"]; + created_at: components["schemas"]["alert-created-at"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + instances: components["schemas"]["code-scanning-alert-instances"]; + state: components["schemas"]["code-scanning-alert-state"]; + dismissed_by: components["schemas"]["simple-user"]; + dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; + dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; + rule: components["schemas"]["code-scanning-alert-rule"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + }; + /** + * Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`. + */ + "code-scanning-alert-set-state": "open" | "dismissed"; + /** + * The full Git reference of the code scanning analysis file, formatted as `refs/heads/`. + */ + "code-scanning-analysis-ref": string; + /** + * The commit SHA of the code scanning analysis file. + */ + "code-scanning-analysis-commit-sha": string; + /** + * The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "code-scanning-analysis-created-at": string; + /** + * Identifies the variable values associated with the environment in which this analysis was performed. + */ + "code-scanning-analysis-environment": string; + "code-scanning-analysis-code-scanning-analysis": { + commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; + ref: components["schemas"]["code-scanning-analysis-ref"]; + analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"]; + created_at: components["schemas"]["code-scanning-analysis-created-at"]; + tool_name: components["schemas"]["code-scanning-analysis-tool-name"]; + error: string; + environment: components["schemas"]["code-scanning-analysis-environment"]; + }; + /** + * A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. + */ + "code-scanning-analysis-sarif-file": string; + /** + * Collaborator + */ + collaborator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string | null; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + permissions?: { pull: boolean; push: boolean; admin: boolean }; + }; + /** + * Repository invitations let you manage who you collaborate with. + */ + "repository-invitation": { + /** + * Unique identifier of the repository invitation. + */ + id: number; + repository: components["schemas"]["minimal-repository"]; + invitee: components["schemas"]["simple-user"] | null; + inviter: components["schemas"]["simple-user"] | null; + /** + * The permission associated with the invitation. + */ + permissions: "read" | "write" | "admin"; + created_at: string; + /** + * Whether or not the invitation has expired + */ + expired?: boolean; + /** + * URL for the repository invitation + */ + url: string; + html_url: string; + node_id: string; + }; + /** + * Commit Comment + */ + "commit-comment": { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string | null; + position: number | null; + line: number | null; + commit_id: string; + user: components["schemas"]["simple-user"] | null; + created_at: string; + updated_at: string; + author_association: string; + reactions?: components["schemas"]["reaction-rollup"]; + }; + /** + * Scim Error + */ + "scim-error": { + message?: string | null; + documentation_url?: string | null; + detail?: string | null; + status?: number; + scimType?: string | null; + schemas?: string[]; + }; + /** + * Branch Short + */ + "branch-short": { + name: string; + commit: { sha: string; url: string }; + protected: boolean; + }; + /** + * Hypermedia Link + */ + link: { href: string }; + /** + * Pull Request Simple + */ + "pull-request-simple": { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: components["schemas"]["simple-user"] | null; + body: string | null; + labels: { + id?: number; + node_id?: string; + url?: string; + name?: string; + description?: string; + color?: string; + default?: boolean; + }[]; + milestone: components["schemas"]["milestone"] | null; + active_lock_reason?: string | null; + created_at: string; + updated_at: string; + closed_at: string | null; + merged_at: string | null; + merge_commit_sha: string | null; + assignee: components["schemas"]["simple-user"] | null; + assignees?: components["schemas"]["simple-user"][] | null; + requested_reviewers?: components["schemas"]["simple-user"][] | null; + requested_teams?: components["schemas"]["team-simple"][] | null; + head: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["simple-user"] | null; + }; + base: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["simple-user"] | null; + }; + _links: { + comments: components["schemas"]["link"]; + commits: components["schemas"]["link"]; + statuses: components["schemas"]["link"]; + html: components["schemas"]["link"]; + issue: components["schemas"]["link"]; + review_comments: components["schemas"]["link"]; + review_comment: components["schemas"]["link"]; + self: components["schemas"]["link"]; + }; + author_association: string; + /** + * Indicates whether or not the pull request is a draft. + */ + draft?: boolean; + }; + "simple-commit-status": { + description: string | null; + id: number; + node_id: string; + state: string; + context: string; + target_url: string; + required?: boolean | null; + avatar_url: string | null; + url: string; + created_at: string; + updated_at: string; + }; + /** + * Combined Commit Status + */ + "combined-commit-status": { + state: string; + statuses: components["schemas"]["simple-commit-status"][]; + sha: string; + total_count: number; + repository: components["schemas"]["minimal-repository"]; + commit_url: string; + url: string; + }; + /** + * The status of a commit. + */ + status: { + url: string; + avatar_url: string | null; + id: number; + node_id: string; + state: string; + description: string; + target_url: string; + context: string; + created_at: string; + updated_at: string; + creator: components["schemas"]["simple-user"]; + }; + /** + * Code of Conduct Simple + */ + "code-of-conduct-simple": { + url: string; + key: string; + name: string; + html_url: string | null; + }; + "community-health-file": { url: string; html_url: string }; + /** + * Community Profile + */ + "community-profile": { + health_percentage: number; + description: string | null; + documentation: string | null; + files: { + code_of_conduct: components["schemas"]["code-of-conduct-simple"] | null; + license: components["schemas"]["license-simple"] | null; + contributing: components["schemas"]["community-health-file"] | null; + readme: components["schemas"]["community-health-file"] | null; + issue_template: components["schemas"]["community-health-file"] | null; + pull_request_template: + | components["schemas"]["community-health-file"] + | null; + }; + updated_at: string | null; + content_reports_enabled?: boolean; + }; + /** + * Diff Entry + */ + "diff-entry": { + sha: string; + filename: string; + status: string; + additions: number; + deletions: number; + changes: number; + blob_url: string; + raw_url: string; + contents_url: string; + patch?: string; + previous_filename?: string; + }; + /** + * Commit Comparison + */ + "commit-comparison": { + url: string; + html_url: string; + permalink_url: string; + diff_url: string; + patch_url: string; + base_commit: components["schemas"]["commit"]; + merge_base_commit: components["schemas"]["commit"]; + status: "diverged" | "ahead" | "behind" | "identical"; + ahead_by: number; + behind_by: number; + total_commits: number; + commits: components["schemas"]["commit"][]; + files: components["schemas"]["diff-entry"][]; + }; + /** + * Content Tree + */ + "content-tree": { + type: string; + size: number; + name: string; + path: string; + sha: string; + url: string; + git_url: string | null; + html_url: string | null; + download_url: string | null; + entries?: { + type: string; + size: number; + name: string; + path: string; + content?: string; + sha: string; + url: string; + git_url: string | null; + html_url: string | null; + download_url: string | null; + _links: { git: string | null; html: string | null; self: string }; + }[]; + _links: { git: string | null; html: string | null; self: string }; + }; + /** + * A list of directory items + */ + "content-directory": { + type: string; + size: number; + name: string; + path: string; + content?: string; + sha: string; + url: string; + git_url: string | null; + html_url: string | null; + download_url: string | null; + _links: { git: string | null; html: string | null; self: string }; + }[]; + /** + * Content File + */ + "content-file": { + type: string; + encoding: string; + size: number; + name: string; + path: string; + content: string; + sha: string; + url: string; + git_url: string | null; + html_url: string | null; + download_url: string | null; + _links: { git: string | null; html: string | null; self: string }; + target?: string; + submodule_git_url?: string; + }; + /** + * An object describing a symlink + */ + "content-symlink": { + type: string; + target: string; + size: number; + name: string; + path: string; + sha: string; + url: string; + git_url: string | null; + html_url: string | null; + download_url: string | null; + _links: { git: string | null; html: string | null; self: string }; + }; + /** + * An object describing a symlink + */ + "content-submodule": { + type: string; + submodule_git_url: string; + size: number; + name: string; + path: string; + sha: string; + url: string; + git_url: string | null; + html_url: string | null; + download_url: string | null; + _links: { git: string | null; html: string | null; self: string }; + }; + /** + * File Commit + */ + "file-commit": { + content: { + name?: string; + path?: string; + sha?: string; + size?: number; + url?: string; + html_url?: string; + git_url?: string; + download_url?: string; + type?: string; + _links?: { self?: string; git?: string; html?: string }; + } | null; + commit: { + sha?: string; + node_id?: string; + url?: string; + html_url?: string; + author?: { date?: string; name?: string; email?: string }; + committer?: { date?: string; name?: string; email?: string }; + message?: string; + tree?: { url?: string; sha?: string }; + parents?: { url?: string; html_url?: string; sha?: string }[]; + verification?: { + verified?: boolean; + reason?: string; + signature?: string | null; + payload?: string | null; + }; + }; + }; + /** + * Contributor + */ + contributor: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string | null; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type: string; + site_admin?: boolean; + contributions: number; + email?: string; + name?: string; + }; + /** + * A request for a specific ref(branch,sha,tag) to be deployed + */ + deployment: { + url: string; + /** + * Unique identifier of the deployment + */ + id: number; + node_id: string; + sha: string; + /** + * The ref to deploy. This can be a branch, tag, or sha. + */ + ref: string; + /** + * Parameter to specify a task to execute + */ + task: string; + payload: { [key: string]: any }; + original_environment?: string; + /** + * Name for the target deployment environment. + */ + environment: string; + description: string | null; + creator: components["schemas"]["simple-user"] | null; + created_at: string; + updated_at: string; + statuses_url: string; + repository_url: string; + /** + * Specifies if the given environment is will no longer exist at some point in the future. Default: false. + */ + transient_environment?: boolean; + /** + * Specifies if the given environment is one that end-users directly interact with. Default: false. + */ + production_environment?: boolean; + performed_via_github_app?: components["schemas"]["integration"] | null; + }; + /** + * The status of a deployment. + */ + "deployment-status": { + url: string; + id: number; + node_id: string; + /** + * The state of the status. + */ + state: + | "error" + | "failure" + | "inactive" + | "pending" + | "success" + | "queued" + | "in_progress"; + creator: components["schemas"]["simple-user"] | null; + /** + * A short description of the status. + */ + description: string; + /** + * The environment of the deployment that the status is for. + */ + environment?: string; + /** + * Deprecated: the URL to associate with this status. + */ + target_url: string; + created_at: string; + updated_at: string; + deployment_url: string; + repository_url: string; + /** + * The URL for accessing your environment. + */ + environment_url?: string; + /** + * The URL to associate with this status. + */ + log_url?: string; + performed_via_github_app?: components["schemas"]["integration"] | null; + }; + /** + * Short Blob + */ + "short-blob": { url: string; sha: string }; + /** + * Blob + */ + blob: { + content: string; + encoding: string; + url: string; + sha: string; + size: number | null; + node_id: string; + highlighted_content?: string; + }; + /** + * Low-level Git commit operations within a repository + */ + "git-commit": { + /** + * SHA for the commit + */ + sha: string; + node_id: string; + url: string; + /** + * Identifying information for the git-user + */ + author: { + /** + * Timestamp of the commit + */ + date: string; + /** + * Git email address of the user + */ + email: string; + /** + * Name of the git user + */ + name: string; + }; + /** + * Identifying information for the git-user + */ + committer: { + /** + * Timestamp of the commit + */ + date: string; + /** + * Git email address of the user + */ + email: string; + /** + * Name of the git user + */ + name: string; + }; + /** + * Message describing the purpose of the commit + */ + message: string; + tree: { + /** + * SHA for the commit + */ + sha: string; + url: string; + }; + parents: { + /** + * SHA for the commit + */ + sha: string; + url: string; + html_url: string; + }[]; + verification: { + verified: boolean; + reason: string; + signature: string | null; + payload: string | null; + }; + html_url: string; + }; + /** + * Git references within a repository + */ + "git-ref": { + ref: string; + node_id: string; + url: string; + object: { + type: string; + /** + * SHA for the reference + */ + sha: string; + url: string; + }; + }; + /** + * Metadata for a Git tag + */ + "git-tag": { + node_id: string; + /** + * Name of the tag + */ + tag: string; + sha: string; + /** + * URL for the tag + */ + url: string; + /** + * Message describing the purpose of the tag + */ + message: string; + tagger: { date: string; email: string; name: string }; + object: { sha: string; type: string; url: string }; + verification?: components["schemas"]["verification"]; + }; + /** + * The hierarchy between files in a Git repository. + */ + "git-tree": { + sha: string; + url: string; + truncated: boolean; + /** + * Objects specifying a tree structure + */ + tree: { + path?: string; + mode?: string; + type?: string; + sha?: string; + size?: number; + url?: string; + }[]; + }; + "hook-response": { + code: number | null; + status: string | null; + message: string | null; + }; + /** + * Webhooks for repositories. + */ + hook: { + type: string; + /** + * Unique identifier of the webhook. + */ + id: number; + /** + * The name of a valid service, use 'web' for a webhook. + */ + name: string; + /** + * Determines whether the hook is actually triggered on pushes. + */ + active: boolean; + /** + * Determines what events the hook is triggered for. Default: ['push']. + */ + events: string[]; + config: { + email?: string; + password?: string; + room?: string; + subdomain?: string; + url?: components["schemas"]["webhook-config-url"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + digest?: string; + secret?: components["schemas"]["webhook-config-secret"]; + token?: string; + }; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: components["schemas"]["hook-response"]; + }; + /** + * A repository import from an external source. + */ + import: { + vcs: string | null; + use_lfs?: string; + /** + * The URL of the originating repository. + */ + vcs_url: string; + svc_root?: string; + tfvc_project?: string; + status: + | "auth" + | "error" + | "none" + | "detecting" + | "choose" + | "auth_failed" + | "importing" + | "mapping" + | "waiting_to_push" + | "pushing" + | "complete" + | "setup" + | "unknown" + | "detection_found_multiple" + | "detection_found_nothing" + | "detection_needs_auth"; + status_text?: string | null; + failed_step?: string | null; + error_message?: string | null; + import_percent?: number | null; + commit_count?: number | null; + push_percent?: number | null; + has_large_files?: boolean; + large_files_size?: number; + large_files_count?: number; + project_choices?: { + vcs?: string; + tfvc_project?: string; + human_name?: string; + }[]; + message?: string; + authors_count?: number | null; + url: string; + html_url: string; + authors_url: string; + repository_url: string; + svn_root?: string; + }; + /** + * Porter Author + */ + "porter-author": { + id: number; + remote_id: string; + remote_name: string; + email: string; + name: string; + url: string; + import_url: string; + }; + /** + * Porter Large File + */ + "porter-large-file": { + ref_name: string; + path: string; + oid: string; + size: number; + }; + /** + * Issue Event Label + */ + "issue-event-label": { name: string | null; color: string | null }; + "issue-event-dismissed-review": { + state: string; + review_id: number; + dismissal_message: string | null; + dismissal_commit_id?: string | null; + }; + /** + * Issue Event Milestone + */ + "issue-event-milestone": { title: string }; + /** + * Issue Event Project Card + */ + "issue-event-project-card": { + url: string; + id: number; + project_url: string; + project_id: number; + column_name: string; + previous_column_name?: string; + }; + /** + * Issue Event Rename + */ + "issue-event-rename": { from: string; to: string }; + /** + * Issue Event + */ + "issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"] | null; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + issue?: components["schemas"]["issue-simple"]; + label?: components["schemas"]["issue-event-label"]; + assignee?: components["schemas"]["simple-user"] | null; + assigner?: components["schemas"]["simple-user"] | null; + review_requester?: components["schemas"]["simple-user"] | null; + requested_reviewer?: components["schemas"]["simple-user"] | null; + requested_team?: components["schemas"]["team"]; + dismissed_review?: components["schemas"]["issue-event-dismissed-review"]; + milestone?: components["schemas"]["issue-event-milestone"]; + project_card?: components["schemas"]["issue-event-project-card"]; + rename?: components["schemas"]["issue-event-rename"]; + author_association?: string; + lock_reason?: string | null; + }; + /** + * Issue Event for Issue + */ + "issue-event-for-issue": { + id?: number; + node_id?: string; + url?: string; + actor?: components["schemas"]["simple-user"]; + event?: string; + commit_id?: string | null; + commit_url?: string | null; + created_at?: string; + sha?: string; + html_url?: string; + message?: string; + issue_url?: string; + updated_at?: string; + author_association?: string; + body?: string; + lock_reason?: string; + submitted_at?: string; + state?: string; + pull_request_url?: string; + body_html?: string; + body_text?: string; + }; + /** + * An SSH key granting access to a single repository. + */ + "deploy-key": { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; + }; + /** + * Language + */ + language: { [key: string]: number }; + /** + * License Content + */ + "license-content": { + name: string; + path: string; + sha: string; + size: number; + url: string; + html_url: string | null; + git_url: string | null; + download_url: string | null; + type: string; + content: string; + encoding: string; + _links: { git: string | null; html: string | null; self: string }; + license: components["schemas"]["license-simple"] | null; + }; + "pages-source-hash": { branch: string; path: string }; + /** + * The configuration for GitHub Pages for a repository. + */ + page: { + /** + * The API address for accessing this Page resource. + */ + url: string; + /** + * The status of the most recent build of the Page. + */ + status: ("built" | "building" | "errored") | null; + /** + * The Pages site's custom domain + */ + cname: string | null; + /** + * Whether the Page has a custom 404 page. + */ + custom_404: boolean; + /** + * The web address the Page can be accessed from. + */ + html_url?: string; + source?: components["schemas"]["pages-source-hash"]; + }; + /** + * Page Build + */ + "page-build": { + url: string; + status: string; + error: { message: string | null }; + pusher: components["schemas"]["simple-user"] | null; + commit: string; + duration: number; + created_at: string; + updated_at: string; + }; + /** + * Page Build Status + */ + "page-build-status": { url: string; status: string }; + /** + * Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. + */ + "pull-request": { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + /** + * Number uniquely identifying the pull request within its repository. + */ + number: number; + /** + * State of this Pull Request. Either `open` or `closed`. + */ + state: "open" | "closed"; + locked: boolean; + /** + * The title of the pull request. + */ + title: string; + user: components["schemas"]["simple-user"] | null; + body: string | null; + labels: { + id?: number; + node_id?: string; + url?: string; + name?: string; + description?: string | null; + color?: string; + default?: boolean; + }[]; + milestone: components["schemas"]["milestone"] | null; + active_lock_reason?: string | null; + created_at: string; + updated_at: string; + closed_at: string | null; + merged_at: string | null; + merge_commit_sha: string | null; + assignee: components["schemas"]["simple-user"] | null; + assignees?: components["schemas"]["simple-user"][] | null; + requested_reviewers?: components["schemas"]["simple-user"][] | null; + requested_teams?: components["schemas"]["team-simple"][] | null; + head: { + label: string; + ref: string; + repo: { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + description: string | null; + downloads_url: string; + events_url: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + hooks_url: string; + html_url: string; + id: number; + node_id: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + name: string; + notifications_url: string; + owner: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string | null; + html_url: string; + id: number; + node_id: string; + login: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + private: boolean; + pulls_url: string; + releases_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + url: string; + clone_url: string; + default_branch: string; + forks: number; + forks_count: number; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + homepage: string | null; + language: string | null; + master_branch?: string; + archived: boolean; + disabled: boolean; + mirror_url: string | null; + open_issues: number; + open_issues_count: number; + permissions?: { admin: boolean; pull: boolean; push: boolean }; + temp_clone_token?: string; + allow_merge_commit?: boolean; + allow_squash_merge?: boolean; + allow_rebase_merge?: boolean; + license: { + key: string; + name: string; + url: string | null; + spdx_id: string | null; + node_id: string; + } | null; + pushed_at: string; + size: number; + ssh_url: string; + stargazers_count: number; + svn_url: string; + topics?: string[]; + watchers: number; + watchers_count: number; + created_at: string; + updated_at: string; + }; + sha: string; + user: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string | null; + html_url: string; + id: number; + node_id: string; + login: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + }; + base: { + label: string; + ref: string; + repo: { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + description: string | null; + downloads_url: string; + events_url: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + hooks_url: string; + html_url: string; + id: number; + node_id: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + name: string; + notifications_url: string; + owner: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string | null; + html_url: string; + id: number; + node_id: string; + login: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + private: boolean; + pulls_url: string; + releases_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + url: string; + clone_url: string; + default_branch: string; + forks: number; + forks_count: number; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + homepage: string | null; + language: string | null; + master_branch?: string; + archived: boolean; + disabled: boolean; + mirror_url: string | null; + open_issues: number; + open_issues_count: number; + permissions?: { admin: boolean; pull: boolean; push: boolean }; + temp_clone_token?: string; + allow_merge_commit?: boolean; + allow_squash_merge?: boolean; + allow_rebase_merge?: boolean; + license: components["schemas"]["license-simple"] | null; + pushed_at: string; + size: number; + ssh_url: string; + stargazers_count: number; + svn_url: string; + topics?: string[]; + watchers: number; + watchers_count: number; + created_at: string; + updated_at: string; + }; + sha: string; + user: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string | null; + html_url: string; + id: number; + node_id: string; + login: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; + }; + _links: { + comments: components["schemas"]["link"]; + commits: components["schemas"]["link"]; + statuses: components["schemas"]["link"]; + html: components["schemas"]["link"]; + issue: components["schemas"]["link"]; + review_comments: components["schemas"]["link"]; + review_comment: components["schemas"]["link"]; + self: components["schemas"]["link"]; + }; + author_association: string; + /** + * Indicates whether or not the pull request is a draft. + */ + draft?: boolean; + merged: boolean; + mergeable: boolean | null; + rebaseable?: boolean | null; + mergeable_state: string; + merged_by: components["schemas"]["simple-user"] | null; + comments: number; + review_comments: number; + /** + * Indicates whether maintainers can modify the pull request. + */ + maintainer_can_modify: boolean; + commits: number; + additions: number; + deletions: number; + changed_files: number; + }; + /** + * Pull Request Review Comments are comments on a portion of the Pull Request's diff. + */ + "pull-request-review-comment": { + /** + * URL for the pull request review comment + */ + url: string; + /** + * The ID of the pull request review to which the comment belongs. + */ + pull_request_review_id: number | null; + /** + * The ID of the pull request review comment. + */ + id: number; + /** + * The node ID of the pull request review comment. + */ + node_id: string; + /** + * The diff of the line that the comment refers to. + */ + diff_hunk: string; + /** + * The relative path of the file to which the comment applies. + */ + path: string; + /** + * The line index in the diff to which the comment applies. + */ + position: number; + /** + * The index of the original line in the diff to which the comment applies. + */ + original_position: number; + /** + * The SHA of the commit to which the comment applies. + */ + commit_id: string; + /** + * The SHA of the original commit to which the comment applies. + */ + original_commit_id: string; + /** + * The comment ID to reply to. + */ + in_reply_to_id?: number; + user: components["schemas"]["simple-user"]; + /** + * The text of the comment. + */ + body: string; + created_at: string; + updated_at: string; + /** + * HTML URL for the pull request review comment. + */ + html_url: string; + /** + * URL for the pull request that the review comment belongs to. + */ + pull_request_url: string; + /** + * How the author of the comment is associated with the pull request. + */ + author_association: string; + _links: { + self: { href: string }; + html: { href: string }; + pull_request: { href: string }; + }; + /** + * The first line of the range for a multi-line comment. + */ + start_line?: number | null; + /** + * The first line of the range for a multi-line comment. + */ + original_start_line?: number | null; + /** + * The side of the first line of the range for a multi-line comment. + */ + start_side?: ("LEFT" | "RIGHT") | null; + /** + * The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ + line?: number; + /** + * The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ + original_line?: number; + /** + * The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment + */ + side?: "LEFT" | "RIGHT"; + reactions?: components["schemas"]["reaction-rollup"]; + body_html?: string; + body_text?: string; + }; + /** + * Pull Request Merge Result + */ + "pull-request-merge-result": { + sha: string; + merged: boolean; + message: string; + }; + /** + * Pull Request Review Request + */ + "pull-request-review-request": { + users: components["schemas"]["simple-user"][]; + teams: components["schemas"]["team-simple"][]; + }; + /** + * Pull Request Reviews are reviews on pull requests. + */ + "pull-request-review": { + /** + * Unique identifier of the review + */ + id: number; + node_id: string; + user: components["schemas"]["simple-user"] | null; + /** + * The text of the review. + */ + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { html: { href: string }; pull_request: { href: string } }; + submitted_at?: string; + /** + * A commit SHA for the review. + */ + commit_id: string; + body_html?: string; + body_text?: string; + author_association: string; + }; + /** + * Legacy Review Comment + */ + "review-comment": { + url: string; + pull_request_review_id: number | null; + id: number; + node_id: string; + diff_hunk: string; + path: string; + position: number | null; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id?: number; + user: components["schemas"]["simple-user"] | null; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: components["schemas"]["link"]; + html: components["schemas"]["link"]; + pull_request: components["schemas"]["link"]; + }; + body_text?: string; + body_html?: string; + /** + * The side of the first line of the range for a multi-line comment. + */ + side?: "LEFT" | "RIGHT"; + /** + * The side of the first line of the range for a multi-line comment. + */ + start_side?: ("LEFT" | "RIGHT") | null; + /** + * The line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ + line?: number; + /** + * The original line of the blob to which the comment applies. The last line of the range for a multi-line comment + */ + original_line?: number; + /** + * The first line of the range for a multi-line comment. + */ + start_line?: number | null; + /** + * The original first line of the range for a multi-line comment. + */ + original_start_line?: number | null; + }; + /** + * Data related to a release. + */ + "release-asset": { + url: string; + browser_download_url: string; + id: number; + node_id: string; + /** + * The file name of the asset. + */ + name: string; + label: string | null; + /** + * State of the release asset. + */ + state: "uploaded" | "open"; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: components["schemas"]["simple-user"] | null; + }; + /** + * A release. + */ + release: { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string | null; + zipball_url: string | null; + id: number; + node_id: string; + /** + * The name of the tag. + */ + tag_name: string; + /** + * Specifies the commitish value that determines where the Git tag is created from. + */ + target_commitish: string; + name: string | null; + body?: string | null; + /** + * true to create a draft (unpublished) release, false to create a published one. + */ + draft: boolean; + /** + * Whether to identify the release as a prerelease or a full release. + */ + prerelease: boolean; + created_at: string; + published_at: string | null; + author: components["schemas"]["simple-user"]; + assets: components["schemas"]["release-asset"][]; + body_html?: string; + body_text?: string; + }; + /** + * Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. + */ + "secret-scanning-alert-state": "open" | "resolved"; + /** + * **Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`. + */ + "secret-scanning-alert-resolution": string | null; + "secret-scanning-alert": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + /** + * The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + resolved_at?: string | null; + resolved_by?: components["schemas"]["simple-user"]; + /** + * The type of secret that secret scanning detected. + */ + secret_type?: string; + /** + * The secret that was detected. + */ + secret?: string; + }; + /** + * Stargazer + */ + stargazer: { + starred_at: string; + user: components["schemas"]["simple-user"] | null; + }; + /** + * Code Frequency Stat + */ + "code-frequency-stat": number[]; + /** + * Commit Activity + */ + "commit-activity": { days: number[]; total: number; week: number }; + /** + * Contributor Activity + */ + "contributor-activity": { + author: components["schemas"]["simple-user"] | null; + total: number; + weeks: { w?: string; a?: number; d?: number; c?: number }[]; + }; + "participation-stats": { all: number[]; owner: number[] }; + /** + * Repository invitations let you manage who you collaborate with. + */ + "repository-subscription": { + /** + * Determines if notifications should be received from this repository. + */ + subscribed: boolean; + /** + * Determines if all notifications should be blocked from this repository. + */ + ignored: boolean; + reason: string | null; + created_at: string; + url: string; + repository_url: string; + }; + /** + * Tag + */ + tag: { + name: string; + commit: { sha: string; url: string }; + zipball_url: string; + tarball_url: string; + node_id: string; + }; + /** + * A topic aggregates entities that are related to a subject. + */ + topic: { names: string[] }; + traffic: { timestamp: string; uniques: number; count: number }; + /** + * Clone Traffic + */ + "clone-traffic": { + count: number; + uniques: number; + clones: components["schemas"]["traffic"][]; + }; + /** + * Content Traffic + */ + "content-traffic": { + path: string; + title: string; + count: number; + uniques: number; + }; + /** + * Referrer Traffic + */ + "referrer-traffic": { referrer: string; count: number; uniques: number }; + /** + * View Traffic + */ + "view-traffic": { + count: number; + uniques: number; + views: components["schemas"]["traffic"][]; + }; + "scim-group-list-enterprise": { + schemas: string[]; + totalResults: number; + itemsPerPage: number; + startIndex: number; + Resources: { + schemas: string[]; + id: string; + externalId?: string | null; + displayName?: string; + members?: { value?: string; $ref?: string; display?: string }[]; + meta?: { + resourceType?: string; + created?: string; + lastModified?: string; + location?: string; + }; + }[]; + }; + "scim-enterprise-group": { + schemas: string[]; + id: string; + externalId?: string | null; + displayName?: string; + members?: { value?: string; $ref?: string; display?: string }[]; + meta?: { + resourceType?: string; + created?: string; + lastModified?: string; + location?: string; + }; + }; + "scim-user-list-enterprise": { + schemas: string[]; + totalResults: number; + itemsPerPage: number; + startIndex: number; + Resources: { + schemas: string[]; + id: string; + externalId?: string; + userName?: string; + name?: { givenName?: string; familyName?: string }; + emails?: { value?: string; primary?: boolean; type?: string }[]; + groups?: { value?: string }[]; + active?: boolean; + meta?: { + resourceType?: string; + created?: string; + lastModified?: string; + location?: string; + }; + }[]; + }; + "scim-enterprise-user": { + schemas: string[]; + id: string; + externalId?: string; + userName?: string; + name?: { givenName?: string; familyName?: string }; + emails?: { value?: string; type?: string; primary?: boolean }[]; + groups?: { value?: string }[]; + active?: boolean; + meta?: { + resourceType?: string; + created?: string; + lastModified?: string; + location?: string; + }; + }; + /** + * SCIM /Users provisioning endpoints + */ + "scim-user": { + /** + * SCIM schema used. + */ + schemas: string[]; + /** + * Unique identifier of an external identity + */ + id: string; + /** + * The ID of the User. + */ + externalId: string | null; + /** + * Configured by the admin. Could be an email, login, or username + */ + userName: string | null; + /** + * The name of the user, suitable for display to end-users + */ + displayName?: string | null; + name: { + givenName: string | null; + familyName: string | null; + formatted?: string | null; + }; + /** + * user emails + */ + emails: { value: string; primary?: boolean }[]; + /** + * The active status of the User. + */ + active: boolean; + meta: { + resourceType?: string; + created?: string; + lastModified?: string; + location?: string; + }; + /** + * The ID of the organization. + */ + organization_id?: number; + /** + * Set of operations to be performed + */ + operations?: { + op: "add" | "remove" | "replace"; + path?: string; + value?: string | { [key: string]: any } | { [key: string]: any }[]; + }[]; + /** + * associated groups + */ + groups?: { value?: string; display?: string }[]; + }; + /** + * SCIM User List + */ + "scim-user-list": { + /** + * SCIM schema used. + */ + schemas: string[]; + totalResults: number; + itemsPerPage: number; + startIndex: number; + Resources: components["schemas"]["scim-user"][]; + }; + "search-result-text-matches": { + object_url?: string; + object_type?: string | null; + property?: string; + fragment?: string; + matches?: { text?: string; indices?: number[] }[]; + }[]; + /** + * Code Search Result Item + */ + "code-search-result-item": { + name: string; + path: string; + sha: string; + url: string; + git_url: string; + html_url: string; + repository: components["schemas"]["minimal-repository"]; + score: number; + file_size?: number; + language?: string | null; + last_modified_at?: string; + line_numbers?: string[]; + text_matches?: components["schemas"]["search-result-text-matches"]; + }; + /** + * Commit Search Result Item + */ + "commit-search-result-item": { + url: string; + sha: string; + html_url: string; + comments_url: string; + commit: { + author: { name: string; email: string; date: string }; + committer: components["schemas"]["git-user"] | null; + comment_count: number; + message: string; + tree: { sha: string; url: string }; + url: string; + verification?: components["schemas"]["verification"]; + }; + author: components["schemas"]["simple-user"] | null; + committer: components["schemas"]["git-user"] | null; + parents: { url?: string; html_url?: string; sha?: string }[]; + repository: components["schemas"]["minimal-repository"]; + score: number; + node_id: string; + text_matches?: components["schemas"]["search-result-text-matches"]; + }; + /** + * Issue Search Result Item + */ + "issue-search-result-item": { + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + id: number; + node_id: string; + number: number; + title: string; + locked: boolean; + active_lock_reason?: string | null; + assignees?: components["schemas"]["simple-user"][] | null; + user: components["schemas"]["simple-user"] | null; + labels: { + id?: number; + node_id?: string; + url?: string; + name?: string; + color?: string; + default?: boolean; + description?: string | null; + }[]; + state: string; + assignee: components["schemas"]["simple-user"] | null; + milestone: components["schemas"]["milestone"] | null; + comments: number; + created_at: string; + updated_at: string; + closed_at: string | null; + text_matches?: components["schemas"]["search-result-text-matches"]; + pull_request?: { + merged_at?: string | null; + diff_url: string | null; + html_url: string | null; + patch_url: string | null; + url: string | null; + }; + body?: string; + score: number; + author_association: string; + draft?: boolean; + repository?: components["schemas"]["repository"]; + body_html?: string; + body_text?: string; + timeline_url?: string; + performed_via_github_app?: components["schemas"]["integration"] | null; + }; + /** + * Label Search Result Item + */ + "label-search-result-item": { + id: number; + node_id: string; + url: string; + name: string; + color: string; + default: boolean; + description: string | null; + score: number; + text_matches?: components["schemas"]["search-result-text-matches"]; + }; + /** + * Repo Search Result Item + */ + "repo-search-result-item": { + id: number; + node_id: string; + name: string; + full_name: string; + owner: components["schemas"]["simple-user"] | null; + private: boolean; + html_url: string; + description: string | null; + fork: boolean; + url: string; + created_at: string; + updated_at: string; + pushed_at: string; + homepage: string | null; + size: number; + stargazers_count: number; + watchers_count: number; + language: string | null; + forks_count: number; + open_issues_count: number; + master_branch?: string; + default_branch: string; + score: number; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; + git_url: string; + ssh_url: string; + clone_url: string; + svn_url: string; + forks: number; + open_issues: number; + watchers: number; + topics?: string[]; + mirror_url: string | null; + has_issues: boolean; + has_projects: boolean; + has_pages: boolean; + has_wiki: boolean; + has_downloads: boolean; + archived: boolean; + /** + * Returns whether or not this repository disabled. + */ + disabled: boolean; + license: components["schemas"]["license-simple"] | null; + permissions?: { admin: boolean; pull: boolean; push: boolean }; + text_matches?: components["schemas"]["search-result-text-matches"]; + temp_clone_token?: string; + allow_merge_commit?: boolean; + allow_squash_merge?: boolean; + allow_rebase_merge?: boolean; + delete_branch_on_merge?: boolean; + }; + /** + * Topic Search Result Item + */ + "topic-search-result-item": { + name: string; + display_name: string | null; + short_description: string | null; + description: string | null; + created_by: string | null; + released: string | null; + created_at: string; + updated_at: string; + featured: boolean; + curated: boolean; + score: number; + repository_count?: number | null; + logo_url?: string | null; + text_matches?: components["schemas"]["search-result-text-matches"]; + related?: + | { + topic_relation?: { + id?: number; + name?: string; + topic_id?: number; + relation_type?: string; + }; + }[] + | null; + aliases?: + | { + topic_relation?: { + id?: number; + name?: string; + topic_id?: number; + relation_type?: string; + }; + }[] + | null; + }; + /** + * User Search Result Item + */ + "user-search-result-item": { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string | null; + url: string; + html_url: string; + followers_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + received_events_url: string; + type: string; + score: number; + following_url: string; + gists_url: string; + starred_url: string; + events_url: string; + public_repos?: number; + public_gists?: number; + followers?: number; + following?: number; + created_at?: string; + updated_at?: string; + name?: string | null; + bio?: string | null; + email?: string | null; + location?: string | null; + site_admin: boolean; + hireable?: boolean | null; + text_matches?: components["schemas"]["search-result-text-matches"]; + blog?: string | null; + company?: string | null; + suspended_at?: string | null; + }; + /** + * Private User + */ + "private-user": { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string | null; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string | null; + company: string | null; + blog: string | null; + location: string | null; + email: string | null; + hireable: boolean | null; + bio: string | null; + twitter_username?: string | null; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; + private_gists: number; + total_private_repos: number; + owned_private_repos: number; + disk_usage: number; + collaborators: number; + two_factor_authentication: boolean; + plan?: { + collaborators: number; + name: string; + space: number; + private_repos: number; + }; + suspended_at?: string | null; + business_plus?: boolean; + ldap_dn?: string; + }; + /** + * Public User + */ + "public-user": { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string | null; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string | null; + company: string | null; + blog: string | null; + location: string | null; + email: string | null; + hireable: boolean | null; + bio: string | null; + twitter_username?: string | null; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; + plan?: { + collaborators: number; + name: string; + space: number; + private_repos: number; + }; + suspended_at?: string | null; + private_gists?: number; + total_private_repos?: number; + owned_private_repos?: number; + disk_usage?: number; + collaborators?: number; + }; + /** + * Email + */ + email: + | { + email: string; + primary: boolean; + verified: boolean; + visibility: string | null; + } + | string; + /** + * A unique encryption key + */ + "gpg-key": { + id: number; + primary_key_id: number | null; + key_id: string; + public_key: string; + emails: { email?: string; verified?: boolean }[]; + subkeys: { + id?: number; + primary_key_id?: number; + key_id?: string; + public_key?: string; + emails?: { [key: string]: any }[]; + subkeys?: { [key: string]: any }[]; + can_sign?: boolean; + can_encrypt_comms?: boolean; + can_encrypt_storage?: boolean; + can_certify?: boolean; + created_at?: string; + expires_at?: string | null; + raw_key?: string | null; + }[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string | null; + raw_key: string | null; + }; + /** + * Key + */ + key: { + key_id: string; + key: string; + id: number; + url: string; + title: string; + created_at: string; + verified: boolean; + read_only: boolean; + }; + "marketplace-account": { + url: string; + id: number; + type: string; + node_id?: string; + login: string; + email?: string | null; + organization_billing_email?: string | null; + }; + /** + * User Marketplace Purchase + */ + "user-marketplace-purchase": { + billing_cycle: string; + next_billing_date: string | null; + unit_count: number | null; + on_free_trial: boolean; + free_trial_ends_on: string | null; + updated_at: string | null; + account: components["schemas"]["marketplace-account"]; + plan: components["schemas"]["marketplace-listing-plan"]; + }; + /** + * Starred Repository + */ + "starred-repository": { + starred_at: string; + repo: components["schemas"]["repository"]; + }; + /** + * Hovercard + */ + hovercard: { contexts: { message: string; octicon: string }[] }; + /** + * Key Simple + */ + "key-simple": { id: number; key: string }; + }; + responses: { + /** + * Resource Not Found + */ + not_found: { [key: string]: any }; + /** + * Validation Failed + */ + validation_failed_simple: { [key: string]: any }; + /** + * Preview Header Missing + */ + preview_header_missing: { [key: string]: any }; + /** + * Forbidden + */ + forbidden: { [key: string]: any }; + /** + * Requires Authentication + */ + requires_authentication: { [key: string]: any }; + /** + * Validation Failed + */ + validation_failed: { [key: string]: any }; + /** + * Not Modified + */ + not_modified: { [key: string]: any }; + /** + * Gone + */ + gone: { [key: string]: any }; + /** + * Service Unavailable + */ + service_unavailable: { [key: string]: any }; + /** + * Forbidden Gist + */ + forbidden_gist: { [key: string]: any }; + /** + * Moved Permanently + */ + moved_permanently: { [key: string]: any }; + /** + * Conflict + */ + conflict: { [key: string]: any }; + /** + * Internal Error + */ + internal_error: { [key: string]: any }; + /** + * Bad Request + */ + bad_request: { [key: string]: any }; + /** + * Found + */ + found: { [key: string]: any }; + /** + * Resource Not Found + */ + scim_not_found: { [key: string]: any }; + /** + * Forbidden + */ + scim_forbidden: { [key: string]: any }; + /** + * Bad Request + */ + scim_bad_request: { [key: string]: any }; + /** + * Internal Error + */ + scim_internal_error: { [key: string]: any }; + /** + * Conflict + */ + scim_conflict: { [key: string]: any }; + }; +} diff --git a/node_modules/@octokit/openapi-types/package.json b/node_modules/@octokit/openapi-types/package.json new file mode 100644 index 0000000..f3d57df --- /dev/null +++ b/node_modules/@octokit/openapi-types/package.json @@ -0,0 +1,67 @@ +{ + "_args": [ + [ + "@octokit/openapi-types@2.3.1", + "." + ] + ], + "_from": "@octokit/openapi-types@2.3.1", + "_id": "@octokit/openapi-types@2.3.1", + "_inBundle": false, + "_integrity": "sha512-KTzpRDT07euvbBYbPs121YDqq5DT94nBDFIyogsDhOnWL8yDCHev6myeiPTgS+VLmyUbdNCYu6L/gVj+Bd1q8Q==", + "_location": "/@octokit/openapi-types", + "_phantomChildren": {}, + "_requested": { + "type": "version", + "registry": true, + "raw": "@octokit/openapi-types@2.3.1", + "name": "@octokit/openapi-types", + "escapedName": "@octokit%2fopenapi-types", + "scope": "@octokit", + "rawSpec": "2.3.1", + "saveSpec": null, + "fetchSpec": "2.3.1" + }, + "_requiredBy": [ + "/@octokit/types" + ], + "_resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-2.3.1.tgz", + "_spec": "2.3.1", + "_where": ".", + "author": { + "name": "Gregor Martynus", + "url": "https://twitter.com/gr2m" + }, + "bugs": { + "url": "https://github.com/octokit/openapi-types.ts/issues" + }, + "description": "Generated TypeScript definitions based on GitHub's OpenAPI spec", + "devDependencies": { + "openapi-typescript": "^2.4.2" + }, + "homepage": "https://github.com/octokit/openapi-types.ts#readme", + "keywords": [], + "license": "MIT", + "main": "generated/types.ts", + "name": "@octokit/openapi-types", + "octokit": { + "openapi-version": "2.3.1" + }, + "publishConfig": { + "access": "public" + }, + "release": { + "branches": "main" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/octokit/openapi-types.ts.git" + }, + "scripts": { + "download": "node scripts/download", + "generate-types": "npx openapi-typescript cache/openapi-schema.json -o generated/types.ts", + "postgenerate-types": "node scripts/update-package" + }, + "types": "generated/types.ts", + "version": "2.3.1" +} diff --git a/node_modules/@octokit/openapi-types/scripts/download.js b/node_modules/@octokit/openapi-types/scripts/download.js new file mode 100644 index 0000000..edd1d88 --- /dev/null +++ b/node_modules/@octokit/openapi-types/scripts/download.js @@ -0,0 +1,35 @@ +const { get } = require("https"); +const fs = require("fs"); + +if (!process.env.VERSION) { + throw new Error("VERSION is not set"); +} + +download(process.env.VERSION.replace(/^v/, "")).then( + () => console.log("done"), + console.error +); + +function download(version) { + const path = `cache/openapi-schema.json`; + const url = `https://unpkg.com/@octokit/openapi@${version}/generated/api.github.com.json`; + + const file = fs.createWriteStream(path); + + console.log("Downloading %s", url); + + return new Promise((resolve, reject) => { + get(url, (response) => { + response.pipe(file); + file + .on("finish", () => + file.close((error) => { + if (error) return reject(error); + console.log("%s written", path); + resolve(); + }) + ) + .on("error", (error) => reject(error.message)); + }); + }); +} diff --git a/node_modules/@octokit/openapi-types/scripts/update-package.js b/node_modules/@octokit/openapi-types/scripts/update-package.js new file mode 100644 index 0000000..2fe3948 --- /dev/null +++ b/node_modules/@octokit/openapi-types/scripts/update-package.js @@ -0,0 +1,15 @@ +const { writeFileSync } = require("fs"); + +if (!process.env.VERSION) { + throw new Error("VERSION is not set"); +} + +const pkg = require("../package.json"); + +if (!pkg.octokit) { + pkg.octokit = {}; +} + +pkg.octokit["openapi-version"] = process.env.VERSION.replace(/^v/, ""); + +writeFileSync("package.json", JSON.stringify(pkg, null, 2) + "\n"); diff --git a/node_modules/get-stream/license b/node_modules/@octokit/plugin-paginate-rest/LICENSE similarity index 80% rename from node_modules/get-stream/license rename to node_modules/@octokit/plugin-paginate-rest/LICENSE index e7af2f7..57bee5f 100644 --- a/node_modules/get-stream/license +++ b/node_modules/@octokit/plugin-paginate-rest/LICENSE @@ -1,9 +1,7 @@ -MIT License - -Copyright (c) Sindre Sorhus (sindresorhus.com) +MIT License Copyright (c) 2019 Octokit contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/@octokit/plugin-paginate-rest/README.md b/node_modules/@octokit/plugin-paginate-rest/README.md new file mode 100644 index 0000000..f73580a --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/README.md @@ -0,0 +1,192 @@ +# plugin-paginate-rest.js + +> Octokit plugin to paginate REST API endpoint responses + +[![@latest](https://img.shields.io/npm/v/@octokit/plugin-paginate-rest.svg)](https://www.npmjs.com/package/@octokit/plugin-paginate-rest) +[![Build Status](https://github.com/octokit/plugin-paginate-rest.js/workflows/Test/badge.svg)](https://github.com/octokit/plugin-paginate-rest.js/actions?workflow=Test) + +## Usage + + + + + + +
+Browsers + + +Load `@octokit/plugin-paginate-rest` and [`@octokit/core`](https://github.com/octokit/core.js) (or core-compatible module) directly from [cdn.skypack.dev](https://cdn.skypack.dev) + +```html + +``` + +
+Node + + +Install with `npm install @octokit/core @octokit/plugin-paginate-rest`. Optionally replace `@octokit/core` with a core-compatible module + +```js +const { Octokit } = require("@octokit/core"); +const { + paginateRest, + composePaginateRest, +} = require("@octokit/plugin-paginate-rest"); +``` + +
+ +```js +const MyOctokit = Octokit.plugin(paginateRest); +const octokit = new MyOctokit({ auth: "secret123" }); + +// See https://developer.github.com/v3/issues/#list-issues-for-a-repository +const issues = await octokit.paginate("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "hello-world", + since: "2010-10-01", + per_page: 100, +}); +``` + +If you want to utilize the pagination methods in another plugin, use `composePaginateRest`. + +```js +function myPlugin(octokit, options) { + return { + allStars({owner, repo}) => { + return composePaginateRest( + octokit, + "GET /repos/{owner}/{repo}/stargazers", + {owner, repo } + ) + } + } +} +``` + +## `octokit.paginate()` + +The `paginateRest` plugin adds a new `octokit.paginate()` method which accepts the same parameters as [`octokit.request`](https://github.com/octokit/request.js#request). Only "List ..." endpoints such as [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) are supporting pagination. Their [response includes a Link header](https://developer.github.com/v3/issues/#response-1). For other endpoints, `octokit.paginate()` behaves the same as `octokit.request()`. + +The `per_page` parameter is usually defaulting to `30`, and can be set to up to `100`, which helps retrieving a big amount of data without hitting the rate limits too soon. + +An optional `mapFunction` can be passed to map each page response to a new value, usually an array with only the data you need. This can help to reduce memory usage, as only the relevant data has to be kept in memory until the pagination is complete. + +```js +const issueTitles = await octokit.paginate( + "GET /repos/{owner}/{repo}/issues", + { + owner: "octocat", + repo: "hello-world", + since: "2010-10-01", + per_page: 100, + }, + (response) => response.data.map((issue) => issue.title) +); +``` + +The `mapFunction` gets a 2nd argument `done` which can be called to end the pagination early. + +```js +const issues = await octokit.paginate( + "GET /repos/{owner}/{repo}/issues", + { + owner: "octocat", + repo: "hello-world", + since: "2010-10-01", + per_page: 100, + }, + (response, done) => { + if (response.data.find((issues) => issue.title.includes("something"))) { + done(); + } + return response.data; + } +); +``` + +Alternatively you can pass a `request` method as first argument. This is great when using in combination with [`@octokit/plugin-rest-endpoint-methods`](https://github.com/octokit/plugin-rest-endpoint-methods.js/): + +```js +const issues = await octokit.paginate(octokit.issues.listForRepo, { + owner: "octocat", + repo: "hello-world", + since: "2010-10-01", + per_page: 100, +}); +``` + +## `octokit.paginate.iterator()` + +If your target runtime environments supports async iterators (such as most modern browsers and Node 10+), you can iterate through each response + +```js +const parameters = { + owner: "octocat", + repo: "hello-world", + since: "2010-10-01", + per_page: 100, +}; +for await (const response of octokit.paginate.iterator( + "GET /repos/{owner}/{repo}/issues", + parameters +)) { + // do whatever you want with each response, break out of the loop, etc. + console.log(response.data.title); +} +``` + +Alternatively you can pass a `request` method as first argument. This is great when using in combination with [`@octokit/plugin-rest-endpoint-methods`](https://github.com/octokit/plugin-rest-endpoint-methods.js/): + +```js +const parameters = { + owner: "octocat", + repo: "hello-world", + since: "2010-10-01", + per_page: 100, +}; +for await (const response of octokit.paginate.iterator( + octokit.issues.listForRepo, + parameters +)) { + // do whatever you want with each response, break out of the loop, etc. + console.log(response.data.title); +} +``` + +## `composePaginateRest` and `composePaginateRest.iterator` + +The `compose*` methods work just like their `octokit.*` counterparts described above, with the differenct that both methods require an `octokit` instance to be passed as first argument + +## How it works + +`octokit.paginate()` wraps `octokit.request()`. As long as a `rel="next"` link value is present in the response's `Link` header, it sends another request for that URL, and so on. + +Most of GitHub's paginating REST API endpoints return an array, but there are a few exceptions which return an object with a key that includes the items array. For example: + +- [Search repositories](https://developer.github.com/v3/search/#example) (key `items`) +- [List check runs for a specific ref](https://developer.github.com/v3/checks/runs/#response-3) (key: `check_runs`) +- [List check suites for a specific ref](https://developer.github.com/v3/checks/suites/#response-1) (key: `check_suites`) +- [List repositories](https://developer.github.com/v3/apps/installations/#list-repositories) for an installation (key: `repositories`) +- [List installations for a user](https://developer.github.com/v3/apps/installations/#response-1) (key `installations`) + +`octokit.paginate()` is working around these inconsistencies so you don't have to worry about it. + +If a response is lacking the `Link` header, `octokit.paginate()` still resolves with an array, even if the response returns a single object. + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js b/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js new file mode 100644 index 0000000..325d8b6 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js @@ -0,0 +1,132 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +const VERSION = "2.7.1"; + +/** + * Some “list” response that can be paginated have a different response structure + * + * They have a `total_count` key in the response (search also has `incomplete_results`, + * /installation/repositories also has `repository_selection`), as well as a key with + * the list of the items which name varies from endpoint to endpoint. + * + * Octokit normalizes these responses so that paginated results are always returned following + * the same structure. One challenge is that if the list response has only one page, no Link + * header is provided, so this header alone is not sufficient to check wether a response is + * paginated or not. + * + * We check if a "total_count" key is present in the response data, but also make sure that + * a "url" property is not, as the "Get the combined status for a specific ref" endpoint would + * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + */ +function normalizePaginatedListResponse(response) { + const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data); + if (!responseNeedsNormalization) return response; // keep the additional properties intact as there is currently no other way + // to retrieve the same information. + + const incompleteResults = response.data.incomplete_results; + const repositorySelection = response.data.repository_selection; + const totalCount = response.data.total_count; + delete response.data.incomplete_results; + delete response.data.repository_selection; + delete response.data.total_count; + const namespaceKey = Object.keys(response.data)[0]; + const data = response.data[namespaceKey]; + response.data = data; + + if (typeof incompleteResults !== "undefined") { + response.data.incomplete_results = incompleteResults; + } + + if (typeof repositorySelection !== "undefined") { + response.data.repository_selection = repositorySelection; + } + + response.data.total_count = totalCount; + return response; +} + +function iterator(octokit, route, parameters) { + const options = typeof route === "function" ? route.endpoint(parameters) : octokit.request.endpoint(route, parameters); + const requestMethod = typeof route === "function" ? route : octokit.request; + const method = options.method; + const headers = options.headers; + let url = options.url; + return { + [Symbol.asyncIterator]: () => ({ + async next() { + if (!url) return { + done: true + }; + const response = await requestMethod({ + method, + url, + headers + }); + const normalizedResponse = normalizePaginatedListResponse(response); // `response.headers.link` format: + // '; rel="next", ; rel="last"' + // sets `url` to undefined if "next" URL is not present or `link` header is not set + + url = ((normalizedResponse.headers.link || "").match(/<([^>]+)>;\s*rel="next"/) || [])[1]; + return { + value: normalizedResponse + }; + } + + }) + }; +} + +function paginate(octokit, route, parameters, mapFn) { + if (typeof parameters === "function") { + mapFn = parameters; + parameters = undefined; + } + + return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn); +} + +function gather(octokit, results, iterator, mapFn) { + return iterator.next().then(result => { + if (result.done) { + return results; + } + + let earlyExit = false; + + function done() { + earlyExit = true; + } + + results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data); + + if (earlyExit) { + return results; + } + + return gather(octokit, results, iterator, mapFn); + }); +} + +const composePaginateRest = Object.assign(paginate, { + iterator +}); + +/** + * @param octokit Octokit instance + * @param options Options passed to Octokit constructor + */ + +function paginateRest(octokit) { + return { + paginate: Object.assign(paginate.bind(null, octokit), { + iterator: iterator.bind(null, octokit) + }) + }; +} +paginateRest.VERSION = VERSION; + +exports.composePaginateRest = composePaginateRest; +exports.paginateRest = paginateRest; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map b/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map new file mode 100644 index 0000000..4908aa1 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/normalize-paginated-list-response.js","../dist-src/iterator.js","../dist-src/paginate.js","../dist-src/compose-paginate.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"2.7.1\";\n","/**\n * Some “list” response that can be paginated have a different response structure\n *\n * They have a `total_count` key in the response (search also has `incomplete_results`,\n * /installation/repositories also has `repository_selection`), as well as a key with\n * the list of the items which name varies from endpoint to endpoint.\n *\n * Octokit normalizes these responses so that paginated results are always returned following\n * the same structure. One challenge is that if the list response has only one page, no Link\n * header is provided, so this header alone is not sufficient to check wether a response is\n * paginated or not.\n *\n * We check if a \"total_count\" key is present in the response data, but also make sure that\n * a \"url\" property is not, as the \"Get the combined status for a specific ref\" endpoint would\n * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref\n */\nexport function normalizePaginatedListResponse(response) {\n const responseNeedsNormalization = \"total_count\" in response.data && !(\"url\" in response.data);\n if (!responseNeedsNormalization)\n return response;\n // keep the additional properties intact as there is currently no other way\n // to retrieve the same information.\n const incompleteResults = response.data.incomplete_results;\n const repositorySelection = response.data.repository_selection;\n const totalCount = response.data.total_count;\n delete response.data.incomplete_results;\n delete response.data.repository_selection;\n delete response.data.total_count;\n const namespaceKey = Object.keys(response.data)[0];\n const data = response.data[namespaceKey];\n response.data = data;\n if (typeof incompleteResults !== \"undefined\") {\n response.data.incomplete_results = incompleteResults;\n }\n if (typeof repositorySelection !== \"undefined\") {\n response.data.repository_selection = repositorySelection;\n }\n response.data.total_count = totalCount;\n return response;\n}\n","import { normalizePaginatedListResponse } from \"./normalize-paginated-list-response\";\nexport function iterator(octokit, route, parameters) {\n const options = typeof route === \"function\"\n ? route.endpoint(parameters)\n : octokit.request.endpoint(route, parameters);\n const requestMethod = typeof route === \"function\" ? route : octokit.request;\n const method = options.method;\n const headers = options.headers;\n let url = options.url;\n return {\n [Symbol.asyncIterator]: () => ({\n async next() {\n if (!url)\n return { done: true };\n const response = await requestMethod({ method, url, headers });\n const normalizedResponse = normalizePaginatedListResponse(response);\n // `response.headers.link` format:\n // '; rel=\"next\", ; rel=\"last\"'\n // sets `url` to undefined if \"next\" URL is not present or `link` header is not set\n url = ((normalizedResponse.headers.link || \"\").match(/<([^>]+)>;\\s*rel=\"next\"/) || [])[1];\n return { value: normalizedResponse };\n },\n }),\n };\n}\n","import { iterator } from \"./iterator\";\nexport function paginate(octokit, route, parameters, mapFn) {\n if (typeof parameters === \"function\") {\n mapFn = parameters;\n parameters = undefined;\n }\n return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn);\n}\nfunction gather(octokit, results, iterator, mapFn) {\n return iterator.next().then((result) => {\n if (result.done) {\n return results;\n }\n let earlyExit = false;\n function done() {\n earlyExit = true;\n }\n results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data);\n if (earlyExit) {\n return results;\n }\n return gather(octokit, results, iterator, mapFn);\n });\n}\n","import { paginate } from \"./paginate\";\nimport { iterator } from \"./iterator\";\nexport const composePaginateRest = Object.assign(paginate, {\n iterator,\n});\n","import { VERSION } from \"./version\";\nimport { paginate } from \"./paginate\";\nimport { iterator } from \"./iterator\";\nexport { composePaginateRest } from \"./compose-paginate\";\n/**\n * @param octokit Octokit instance\n * @param options Options passed to Octokit constructor\n */\nexport function paginateRest(octokit) {\n return {\n paginate: Object.assign(paginate.bind(null, octokit), {\n iterator: iterator.bind(null, octokit),\n }),\n };\n}\npaginateRest.VERSION = VERSION;\n"],"names":["VERSION","normalizePaginatedListResponse","response","responseNeedsNormalization","data","incompleteResults","incomplete_results","repositorySelection","repository_selection","totalCount","total_count","namespaceKey","Object","keys","iterator","octokit","route","parameters","options","endpoint","request","requestMethod","method","headers","url","Symbol","asyncIterator","next","done","normalizedResponse","link","match","value","paginate","mapFn","undefined","gather","results","then","result","earlyExit","concat","composePaginateRest","assign","paginateRest","bind"],"mappings":";;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACAP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,AAAO,SAASC,8BAAT,CAAwCC,QAAxC,EAAkD;AACrD,QAAMC,0BAA0B,GAAG,iBAAiBD,QAAQ,CAACE,IAA1B,IAAkC,EAAE,SAASF,QAAQ,CAACE,IAApB,CAArE;AACA,MAAI,CAACD,0BAAL,EACI,OAAOD,QAAP,CAHiD;AAKrD;;AACA,QAAMG,iBAAiB,GAAGH,QAAQ,CAACE,IAAT,CAAcE,kBAAxC;AACA,QAAMC,mBAAmB,GAAGL,QAAQ,CAACE,IAAT,CAAcI,oBAA1C;AACA,QAAMC,UAAU,GAAGP,QAAQ,CAACE,IAAT,CAAcM,WAAjC;AACA,SAAOR,QAAQ,CAACE,IAAT,CAAcE,kBAArB;AACA,SAAOJ,QAAQ,CAACE,IAAT,CAAcI,oBAArB;AACA,SAAON,QAAQ,CAACE,IAAT,CAAcM,WAArB;AACA,QAAMC,YAAY,GAAGC,MAAM,CAACC,IAAP,CAAYX,QAAQ,CAACE,IAArB,EAA2B,CAA3B,CAArB;AACA,QAAMA,IAAI,GAAGF,QAAQ,CAACE,IAAT,CAAcO,YAAd,CAAb;AACAT,EAAAA,QAAQ,CAACE,IAAT,GAAgBA,IAAhB;;AACA,MAAI,OAAOC,iBAAP,KAA6B,WAAjC,EAA8C;AAC1CH,IAAAA,QAAQ,CAACE,IAAT,CAAcE,kBAAd,GAAmCD,iBAAnC;AACH;;AACD,MAAI,OAAOE,mBAAP,KAA+B,WAAnC,EAAgD;AAC5CL,IAAAA,QAAQ,CAACE,IAAT,CAAcI,oBAAd,GAAqCD,mBAArC;AACH;;AACDL,EAAAA,QAAQ,CAACE,IAAT,CAAcM,WAAd,GAA4BD,UAA5B;AACA,SAAOP,QAAP;AACH;;ACtCM,SAASY,QAAT,CAAkBC,OAAlB,EAA2BC,KAA3B,EAAkCC,UAAlC,EAA8C;AACjD,QAAMC,OAAO,GAAG,OAAOF,KAAP,KAAiB,UAAjB,GACVA,KAAK,CAACG,QAAN,CAAeF,UAAf,CADU,GAEVF,OAAO,CAACK,OAAR,CAAgBD,QAAhB,CAAyBH,KAAzB,EAAgCC,UAAhC,CAFN;AAGA,QAAMI,aAAa,GAAG,OAAOL,KAAP,KAAiB,UAAjB,GAA8BA,KAA9B,GAAsCD,OAAO,CAACK,OAApE;AACA,QAAME,MAAM,GAAGJ,OAAO,CAACI,MAAvB;AACA,QAAMC,OAAO,GAAGL,OAAO,CAACK,OAAxB;AACA,MAAIC,GAAG,GAAGN,OAAO,CAACM,GAAlB;AACA,SAAO;AACH,KAACC,MAAM,CAACC,aAAR,GAAwB,OAAO;AAC3B,YAAMC,IAAN,GAAa;AACT,YAAI,CAACH,GAAL,EACI,OAAO;AAAEI,UAAAA,IAAI,EAAE;AAAR,SAAP;AACJ,cAAM1B,QAAQ,GAAG,MAAMmB,aAAa,CAAC;AAAEC,UAAAA,MAAF;AAAUE,UAAAA,GAAV;AAAeD,UAAAA;AAAf,SAAD,CAApC;AACA,cAAMM,kBAAkB,GAAG5B,8BAA8B,CAACC,QAAD,CAAzD,CAJS;AAMT;AACA;;AACAsB,QAAAA,GAAG,GAAG,CAAC,CAACK,kBAAkB,CAACN,OAAnB,CAA2BO,IAA3B,IAAmC,EAApC,EAAwCC,KAAxC,CAA8C,yBAA9C,KAA4E,EAA7E,EAAiF,CAAjF,CAAN;AACA,eAAO;AAAEC,UAAAA,KAAK,EAAEH;AAAT,SAAP;AACH;;AAX0B,KAAP;AADrB,GAAP;AAeH;;ACvBM,SAASI,QAAT,CAAkBlB,OAAlB,EAA2BC,KAA3B,EAAkCC,UAAlC,EAA8CiB,KAA9C,EAAqD;AACxD,MAAI,OAAOjB,UAAP,KAAsB,UAA1B,EAAsC;AAClCiB,IAAAA,KAAK,GAAGjB,UAAR;AACAA,IAAAA,UAAU,GAAGkB,SAAb;AACH;;AACD,SAAOC,MAAM,CAACrB,OAAD,EAAU,EAAV,EAAcD,QAAQ,CAACC,OAAD,EAAUC,KAAV,EAAiBC,UAAjB,CAAR,CAAqCQ,MAAM,CAACC,aAA5C,GAAd,EAA4EQ,KAA5E,CAAb;AACH;;AACD,SAASE,MAAT,CAAgBrB,OAAhB,EAAyBsB,OAAzB,EAAkCvB,QAAlC,EAA4CoB,KAA5C,EAAmD;AAC/C,SAAOpB,QAAQ,CAACa,IAAT,GAAgBW,IAAhB,CAAsBC,MAAD,IAAY;AACpC,QAAIA,MAAM,CAACX,IAAX,EAAiB;AACb,aAAOS,OAAP;AACH;;AACD,QAAIG,SAAS,GAAG,KAAhB;;AACA,aAASZ,IAAT,GAAgB;AACZY,MAAAA,SAAS,GAAG,IAAZ;AACH;;AACDH,IAAAA,OAAO,GAAGA,OAAO,CAACI,MAAR,CAAeP,KAAK,GAAGA,KAAK,CAACK,MAAM,CAACP,KAAR,EAAeJ,IAAf,CAAR,GAA+BW,MAAM,CAACP,KAAP,CAAa5B,IAAhE,CAAV;;AACA,QAAIoC,SAAJ,EAAe;AACX,aAAOH,OAAP;AACH;;AACD,WAAOD,MAAM,CAACrB,OAAD,EAAUsB,OAAV,EAAmBvB,QAAnB,EAA6BoB,KAA7B,CAAb;AACH,GAbM,CAAP;AAcH;;MCrBYQ,mBAAmB,GAAG9B,MAAM,CAAC+B,MAAP,CAAcV,QAAd,EAAwB;AACvDnB,EAAAA;AADuD,CAAxB,CAA5B;;ACEP;AACA;AACA;AACA;;AACA,AAAO,SAAS8B,YAAT,CAAsB7B,OAAtB,EAA+B;AAClC,SAAO;AACHkB,IAAAA,QAAQ,EAAErB,MAAM,CAAC+B,MAAP,CAAcV,QAAQ,CAACY,IAAT,CAAc,IAAd,EAAoB9B,OAApB,CAAd,EAA4C;AAClDD,MAAAA,QAAQ,EAAEA,QAAQ,CAAC+B,IAAT,CAAc,IAAd,EAAoB9B,OAApB;AADwC,KAA5C;AADP,GAAP;AAKH;AACD6B,YAAY,CAAC5C,OAAb,GAAuBA,OAAvB;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js new file mode 100644 index 0000000..09ca53f --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js @@ -0,0 +1,5 @@ +import { paginate } from "./paginate"; +import { iterator } from "./iterator"; +export const composePaginateRest = Object.assign(paginate, { + iterator, +}); diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/index.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/index.js new file mode 100644 index 0000000..b207803 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/index.js @@ -0,0 +1,16 @@ +import { VERSION } from "./version"; +import { paginate } from "./paginate"; +import { iterator } from "./iterator"; +export { composePaginateRest } from "./compose-paginate"; +/** + * @param octokit Octokit instance + * @param options Options passed to Octokit constructor + */ +export function paginateRest(octokit) { + return { + paginate: Object.assign(paginate.bind(null, octokit), { + iterator: iterator.bind(null, octokit), + }), + }; +} +paginateRest.VERSION = VERSION; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js new file mode 100644 index 0000000..14684db --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js @@ -0,0 +1,25 @@ +import { normalizePaginatedListResponse } from "./normalize-paginated-list-response"; +export function iterator(octokit, route, parameters) { + const options = typeof route === "function" + ? route.endpoint(parameters) + : octokit.request.endpoint(route, parameters); + const requestMethod = typeof route === "function" ? route : octokit.request; + const method = options.method; + const headers = options.headers; + let url = options.url; + return { + [Symbol.asyncIterator]: () => ({ + async next() { + if (!url) + return { done: true }; + const response = await requestMethod({ method, url, headers }); + const normalizedResponse = normalizePaginatedListResponse(response); + // `response.headers.link` format: + // '; rel="next", ; rel="last"' + // sets `url` to undefined if "next" URL is not present or `link` header is not set + url = ((normalizedResponse.headers.link || "").match(/<([^>]+)>;\s*rel="next"/) || [])[1]; + return { value: normalizedResponse }; + }, + }), + }; +} diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js new file mode 100644 index 0000000..d29c677 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js @@ -0,0 +1,40 @@ +/** + * Some “list” response that can be paginated have a different response structure + * + * They have a `total_count` key in the response (search also has `incomplete_results`, + * /installation/repositories also has `repository_selection`), as well as a key with + * the list of the items which name varies from endpoint to endpoint. + * + * Octokit normalizes these responses so that paginated results are always returned following + * the same structure. One challenge is that if the list response has only one page, no Link + * header is provided, so this header alone is not sufficient to check wether a response is + * paginated or not. + * + * We check if a "total_count" key is present in the response data, but also make sure that + * a "url" property is not, as the "Get the combined status for a specific ref" endpoint would + * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + */ +export function normalizePaginatedListResponse(response) { + const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data); + if (!responseNeedsNormalization) + return response; + // keep the additional properties intact as there is currently no other way + // to retrieve the same information. + const incompleteResults = response.data.incomplete_results; + const repositorySelection = response.data.repository_selection; + const totalCount = response.data.total_count; + delete response.data.incomplete_results; + delete response.data.repository_selection; + delete response.data.total_count; + const namespaceKey = Object.keys(response.data)[0]; + const data = response.data[namespaceKey]; + response.data = data; + if (typeof incompleteResults !== "undefined") { + response.data.incomplete_results = incompleteResults; + } + if (typeof repositorySelection !== "undefined") { + response.data.repository_selection = repositorySelection; + } + response.data.total_count = totalCount; + return response; +} diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js new file mode 100644 index 0000000..8d18a60 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js @@ -0,0 +1,24 @@ +import { iterator } from "./iterator"; +export function paginate(octokit, route, parameters, mapFn) { + if (typeof parameters === "function") { + mapFn = parameters; + parameters = undefined; + } + return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn); +} +function gather(octokit, results, iterator, mapFn) { + return iterator.next().then((result) => { + if (result.done) { + return results; + } + let earlyExit = false; + function done() { + earlyExit = true; + } + results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data); + if (earlyExit) { + return results; + } + return gather(octokit, results, iterator, mapFn); + }); +} diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/types.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/types.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/version.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/version.js new file mode 100644 index 0000000..05a6b94 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "2.7.1"; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts new file mode 100644 index 0000000..38a7432 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts @@ -0,0 +1,2 @@ +import { ComposePaginateInterface } from "./types"; +export declare const composePaginateRest: ComposePaginateInterface; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts new file mode 100644 index 0000000..c5ec470 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts @@ -0,0 +1,1387 @@ +import { Endpoints } from "@octokit/types"; +export interface PaginatingEndpoints { + /** + * @see https://docs.github.com/v3/apps/#list-installations-for-the-authenticated-app + */ + "GET /app/installations": { + parameters: Endpoints["GET /app/installations"]["parameters"]; + response: Endpoints["GET /app/installations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#list-your-grants + */ + "GET /applications/grants": { + parameters: Endpoints["GET /applications/grants"]["parameters"]; + response: Endpoints["GET /applications/grants"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations + */ + "GET /authorizations": { + parameters: Endpoints["GET /authorizations"]["parameters"]; + response: Endpoints["GET /authorizations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/permissions/organizations": { + parameters: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["parameters"]; + response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["response"] & { + data: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["response"]["data"]["organizations"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups": { + parameters: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups"]["parameters"]; + response: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups"]["response"] & { + data: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups"]["response"]["data"]["runner_groups"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + parameters: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations"]["parameters"]; + response: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations"]["response"] & { + data: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations"]["response"]["data"]["organizations"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + parameters: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners"]["parameters"]; + response: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners"]["response"] & { + data: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners"]["response"]["data"]["runners"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runners": { + parameters: Endpoints["GET /enterprises/{enterprise}/actions/runners"]["parameters"]; + response: Endpoints["GET /enterprises/{enterprise}/actions/runners"]["response"] & { + data: Endpoints["GET /enterprises/{enterprise}/actions/runners"]["response"]["data"]["runners"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-runner-applications-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runners/downloads": { + parameters: Endpoints["GET /enterprises/{enterprise}/actions/runners/downloads"]["parameters"]; + response: Endpoints["GET /enterprises/{enterprise}/actions/runners/downloads"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events + */ + "GET /events": { + parameters: Endpoints["GET /events"]["parameters"]; + response: Endpoints["GET /events"]["response"]; + }; + /** + * @see https://docs.github.com/v3/gists/#list-gists-for-the-authenticated-user + */ + "GET /gists": { + parameters: Endpoints["GET /gists"]["parameters"]; + response: Endpoints["GET /gists"]["response"]; + }; + /** + * @see https://docs.github.com/v3/gists/#list-public-gists + */ + "GET /gists/public": { + parameters: Endpoints["GET /gists/public"]["parameters"]; + response: Endpoints["GET /gists/public"]["response"]; + }; + /** + * @see https://docs.github.com/v3/gists/#list-starred-gists + */ + "GET /gists/starred": { + parameters: Endpoints["GET /gists/starred"]["parameters"]; + response: Endpoints["GET /gists/starred"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/gists#list-gist-comments + */ + "GET /gists/{gist_id}/comments": { + parameters: Endpoints["GET /gists/{gist_id}/comments"]["parameters"]; + response: Endpoints["GET /gists/{gist_id}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/v3/gists/#list-gist-commits + */ + "GET /gists/{gist_id}/commits": { + parameters: Endpoints["GET /gists/{gist_id}/commits"]["parameters"]; + response: Endpoints["GET /gists/{gist_id}/commits"]["response"]; + }; + /** + * @see https://docs.github.com/v3/gists/#list-gist-forks + */ + "GET /gists/{gist_id}/forks": { + parameters: Endpoints["GET /gists/{gist_id}/forks"]["parameters"]; + response: Endpoints["GET /gists/{gist_id}/forks"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-app-installation + */ + "GET /installation/repositories": { + parameters: Endpoints["GET /installation/repositories"]["parameters"]; + response: Endpoints["GET /installation/repositories"]["response"] & { + data: Endpoints["GET /installation/repositories"]["response"]["data"]["repositories"]; + }; + }; + /** + * @see https://docs.github.com/v3/issues/#list-issues-assigned-to-the-authenticated-user + */ + "GET /issues": { + parameters: Endpoints["GET /issues"]["parameters"]; + response: Endpoints["GET /issues"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-plans + */ + "GET /marketplace_listing/plans": { + parameters: Endpoints["GET /marketplace_listing/plans"]["parameters"]; + response: Endpoints["GET /marketplace_listing/plans"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan + */ + "GET /marketplace_listing/plans/{plan_id}/accounts": { + parameters: Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["parameters"]; + response: Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-plans-stubbed + */ + "GET /marketplace_listing/stubbed/plans": { + parameters: Endpoints["GET /marketplace_listing/stubbed/plans"]["parameters"]; + response: Endpoints["GET /marketplace_listing/stubbed/plans"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan-stubbed + */ + "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts": { + parameters: Endpoints["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"]["parameters"]; + response: Endpoints["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories + */ + "GET /networks/{owner}/{repo}/events": { + parameters: Endpoints["GET /networks/{owner}/{repo}/events"]["parameters"]; + response: Endpoints["GET /networks/{owner}/{repo}/events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user + */ + "GET /notifications": { + parameters: Endpoints["GET /notifications"]["parameters"]; + response: Endpoints["GET /notifications"]["response"]; + }; + /** + * @see https://docs.github.com/v3/orgs/#list-organizations + */ + "GET /organizations": { + parameters: Endpoints["GET /organizations"]["parameters"]; + response: Endpoints["GET /organizations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization + */ + "GET /orgs/{org}/actions/permissions/repositories": { + parameters: Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["response"]["data"]["repositories"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runner-groups-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups": { + parameters: Endpoints["GET /orgs/{org}/actions/runner-groups"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/runner-groups"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/runner-groups"]["response"]["data"]["runner_groups"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + parameters: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories"]["response"]["data"]["repositories"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-in-a-group-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + parameters: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners"]["response"]["data"]["runners"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization + */ + "GET /orgs/{org}/actions/runners": { + parameters: Endpoints["GET /orgs/{org}/actions/runners"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/runners"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/runners"]["response"]["data"]["runners"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization + */ + "GET /orgs/{org}/actions/runners/downloads": { + parameters: Endpoints["GET /orgs/{org}/actions/runners/downloads"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/runners/downloads"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-organization-secrets + */ + "GET /orgs/{org}/actions/secrets": { + parameters: Endpoints["GET /orgs/{org}/actions/secrets"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/secrets"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/secrets"]["response"]["data"]["secrets"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret + */ + "GET /orgs/{org}/actions/secrets/{secret_name}/repositories": { + parameters: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"]["response"]["data"]["repositories"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-users-blocked-by-an-organization + */ + "GET /orgs/{org}/blocks": { + parameters: Endpoints["GET /orgs/{org}/blocks"]["parameters"]; + response: Endpoints["GET /orgs/{org}/blocks"]["response"]; + }; + /** + * @see https://docs.github.com/v3/orgs/#list-saml-sso-authorizations-for-an-organization + */ + "GET /orgs/{org}/credential-authorizations": { + parameters: Endpoints["GET /orgs/{org}/credential-authorizations"]["parameters"]; + response: Endpoints["GET /orgs/{org}/credential-authorizations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-organization-events + */ + "GET /orgs/{org}/events": { + parameters: Endpoints["GET /orgs/{org}/events"]["parameters"]; + response: Endpoints["GET /orgs/{org}/events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-webhooks + */ + "GET /orgs/{org}/hooks": { + parameters: Endpoints["GET /orgs/{org}/hooks"]["parameters"]; + response: Endpoints["GET /orgs/{org}/hooks"]["response"]; + }; + /** + * @see https://docs.github.com/v3/orgs/#list-app-installations-for-an-organization + */ + "GET /orgs/{org}/installations": { + parameters: Endpoints["GET /orgs/{org}/installations"]["parameters"]; + response: Endpoints["GET /orgs/{org}/installations"]["response"] & { + data: Endpoints["GET /orgs/{org}/installations"]["response"]["data"]["installations"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-pending-organization-invitations + */ + "GET /orgs/{org}/invitations": { + parameters: Endpoints["GET /orgs/{org}/invitations"]["parameters"]; + response: Endpoints["GET /orgs/{org}/invitations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-invitation-teams + */ + "GET /orgs/{org}/invitations/{invitation_id}/teams": { + parameters: Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["parameters"]; + response: Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["response"]; + }; + /** + * @see https://docs.github.com/v3/issues/#list-organization-issues-assigned-to-the-authenticated-user + */ + "GET /orgs/{org}/issues": { + parameters: Endpoints["GET /orgs/{org}/issues"]["parameters"]; + response: Endpoints["GET /orgs/{org}/issues"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-members + */ + "GET /orgs/{org}/members": { + parameters: Endpoints["GET /orgs/{org}/members"]["parameters"]; + response: Endpoints["GET /orgs/{org}/members"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/migrations#list-organization-migrations + */ + "GET /orgs/{org}/migrations": { + parameters: Endpoints["GET /orgs/{org}/migrations"]["parameters"]; + response: Endpoints["GET /orgs/{org}/migrations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/migrations#list-repositories-in-an-organization-migration + */ + "GET /orgs/{org}/migrations/{migration_id}/repositories": { + parameters: Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["parameters"]; + response: Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-outside-collaborators-for-an-organization + */ + "GET /orgs/{org}/outside_collaborators": { + parameters: Endpoints["GET /orgs/{org}/outside_collaborators"]["parameters"]; + response: Endpoints["GET /orgs/{org}/outside_collaborators"]["response"]; + }; + /** + * @see https://docs.github.com/v3/projects/#list-organization-projects + */ + "GET /orgs/{org}/projects": { + parameters: Endpoints["GET /orgs/{org}/projects"]["parameters"]; + response: Endpoints["GET /orgs/{org}/projects"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-public-organization-members + */ + "GET /orgs/{org}/public_members": { + parameters: Endpoints["GET /orgs/{org}/public_members"]["parameters"]; + response: Endpoints["GET /orgs/{org}/public_members"]["response"]; + }; + /** + * @see https://docs.github.com/v3/repos/#list-organization-repositories + */ + "GET /orgs/{org}/repos": { + parameters: Endpoints["GET /orgs/{org}/repos"]["parameters"]; + response: Endpoints["GET /orgs/{org}/repos"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-an-organization + */ + "GET /orgs/{org}/team-sync/groups": { + parameters: Endpoints["GET /orgs/{org}/team-sync/groups"]["parameters"]; + response: Endpoints["GET /orgs/{org}/team-sync/groups"]["response"] & { + data: Endpoints["GET /orgs/{org}/team-sync/groups"]["response"]["data"]["groups"]; + }; + }; + /** + * @see https://docs.github.com/v3/teams/#list-teams + */ + "GET /orgs/{org}/teams": { + parameters: Endpoints["GET /orgs/{org}/teams"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussions + */ + "GET /orgs/{org}/teams/{team_slug}/discussions": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussion-comments + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-a-team-discussion + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-pending-team-invitations + */ + "GET /orgs/{org}/teams/{team_slug}/invitations": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/invitations"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/invitations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-team-members + */ + "GET /orgs/{org}/teams/{team_slug}/members": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/members"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/members"]["response"]; + }; + /** + * @see https://docs.github.com/v3/teams/#list-team-projects + */ + "GET /orgs/{org}/teams/{team_slug}/projects": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["response"]; + }; + /** + * @see https://docs.github.com/v3/teams/#list-team-repositories + */ + "GET /orgs/{org}/teams/{team_slug}/repos": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team + */ + "GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings"]["response"] & { + data: Endpoints["GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings"]["response"]["data"]["groups"]; + }; + }; + /** + * @see https://docs.github.com/v3/teams/#list-child-teams + */ + "GET /orgs/{org}/teams/{team_slug}/teams": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/teams"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/teams"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/projects#list-project-cards + */ + "GET /projects/columns/{column_id}/cards": { + parameters: Endpoints["GET /projects/columns/{column_id}/cards"]["parameters"]; + response: Endpoints["GET /projects/columns/{column_id}/cards"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/projects#list-project-collaborators + */ + "GET /projects/{project_id}/collaborators": { + parameters: Endpoints["GET /projects/{project_id}/collaborators"]["parameters"]; + response: Endpoints["GET /projects/{project_id}/collaborators"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/projects#list-project-columns + */ + "GET /projects/{project_id}/columns": { + parameters: Endpoints["GET /projects/{project_id}/columns"]["parameters"]; + response: Endpoints["GET /projects/{project_id}/columns"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/artifacts": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts"]["response"]["data"]["artifacts"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runners": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runners"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/runners"]["response"]["data"]["runners"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runners/downloads": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runners/downloads"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners/downloads"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-workflow-runs-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runs": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["response"]["data"]["workflow_runs"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-workflow-run-artifacts + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["response"]["data"]["artifacts"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["response"]["data"]["jobs"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-repository-secrets + */ + "GET /repos/{owner}/{repo}/actions/secrets": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/secrets"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/secrets"]["response"]["data"]["secrets"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-repository-workflows + */ + "GET /repos/{owner}/{repo}/actions/workflows": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"]["data"]["workflows"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-workflow-runs + */ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"]["response"]["data"]["workflow_runs"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-assignees + */ + "GET /repos/{owner}/{repo}/assignees": { + parameters: Endpoints["GET /repos/{owner}/{repo}/assignees"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/assignees"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-branches + */ + "GET /repos/{owner}/{repo}/branches": { + parameters: Endpoints["GET /repos/{owner}/{repo}/branches"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-run-annotations + */ + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + parameters: Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite + */ + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + parameters: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"]["response"]["data"]["check_runs"]; + }; + }; + /** + * @see https://docs.github.com/v3/code-scanning/#list-code-scanning-alerts-for-a-repository + */ + "GET /repos/{owner}/{repo}/code-scanning/alerts": { + parameters: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts"]["response"]; + }; + /** + * @see https://docs.github.com/v3/code-scanning/#list-recent-analyses + */ + "GET /repos/{owner}/{repo}/code-scanning/analyses": { + parameters: Endpoints["GET /repos/{owner}/{repo}/code-scanning/analyses"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/analyses"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-collaborators + */ + "GET /repos/{owner}/{repo}/collaborators": { + parameters: Endpoints["GET /repos/{owner}/{repo}/collaborators"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/collaborators"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-commit-comments-for-a-repository + */ + "GET /repos/{owner}/{repo}/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-a-commit-comment + */ + "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions": { + parameters: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-commits + */ + "GET /repos/{owner}/{repo}/commits": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-branches-for-head-commit + */ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-commit-comments + */ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-pull-requests-associated-with-a-commit + */ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/check-runs": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"]["response"]["data"]["check_runs"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/check-suites": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["response"]["data"]["check_suites"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-commit-statuses-for-a-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/statuses": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/statuses"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/statuses"]["response"]; + }; + /** + * @see https://docs.github.com/v3/repos/#list-repository-contributors + */ + "GET /repos/{owner}/{repo}/contributors": { + parameters: Endpoints["GET /repos/{owner}/{repo}/contributors"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/contributors"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-deployments + */ + "GET /repos/{owner}/{repo}/deployments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/deployments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/deployments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-deployment-statuses + */ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + parameters: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-repository-events + */ + "GET /repos/{owner}/{repo}/events": { + parameters: Endpoints["GET /repos/{owner}/{repo}/events"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-forks + */ + "GET /repos/{owner}/{repo}/forks": { + parameters: Endpoints["GET /repos/{owner}/{repo}/forks"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/forks"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/git#list-matching-references + */ + "GET /repos/{owner}/{repo}/git/matching-refs/{ref}": { + parameters: Endpoints["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-webhooks + */ + "GET /repos/{owner}/{repo}/hooks": { + parameters: Endpoints["GET /repos/{owner}/{repo}/hooks"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/hooks"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-invitations + */ + "GET /repos/{owner}/{repo}/invitations": { + parameters: Endpoints["GET /repos/{owner}/{repo}/invitations"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/invitations"]["response"]; + }; + /** + * @see https://docs.github.com/v3/issues/#list-repository-issues + */ + "GET /repos/{owner}/{repo}/issues": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-comments-for-a-repository + */ + "GET /repos/{owner}/{repo}/issues/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments"]["response"]; + }; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-an-issue-comment + */ + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-events-for-a-repository + */ + "GET /repos/{owner}/{repo}/issues/events": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/events"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-comments + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-events + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/events": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/events"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-labels-for-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/labels": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; + }; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-timeline-events-for-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-deploy-keys + */ + "GET /repos/{owner}/{repo}/keys": { + parameters: Endpoints["GET /repos/{owner}/{repo}/keys"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/keys"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-labels-for-a-repository + */ + "GET /repos/{owner}/{repo}/labels": { + parameters: Endpoints["GET /repos/{owner}/{repo}/labels"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/labels"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-milestones + */ + "GET /repos/{owner}/{repo}/milestones": { + parameters: Endpoints["GET /repos/{owner}/{repo}/milestones"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/milestones"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-labels-for-issues-in-a-milestone + */ + "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + parameters: Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user + */ + "GET /repos/{owner}/{repo}/notifications": { + parameters: Endpoints["GET /repos/{owner}/{repo}/notifications"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/notifications"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-github-pages-builds + */ + "GET /repos/{owner}/{repo}/pages/builds": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pages/builds"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pages/builds"]["response"]; + }; + /** + * @see https://docs.github.com/v3/projects/#list-repository-projects + */ + "GET /repos/{owner}/{repo}/projects": { + parameters: Endpoints["GET /repos/{owner}/{repo}/projects"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/projects"]["response"]; + }; + /** + * @see https://docs.github.com/v3/pulls/#list-pull-requests + */ + "GET /repos/{owner}/{repo}/pulls": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/pulls#list-review-comments-in-a-repository + */ + "GET /repos/{owner}/{repo}/pulls/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments"]["response"]; + }; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment + */ + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/pulls#list-review-comments-on-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/v3/pulls/#list-commits-on-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/commits": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["response"]; + }; + /** + * @see https://docs.github.com/v3/pulls/#list-pull-requests-files + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/files": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"]["data"]["users"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/pulls#list-reviews-for-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/pulls#list-comments-for-a-pull-request-review + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-releases + */ + "GET /repos/{owner}/{repo}/releases": { + parameters: Endpoints["GET /repos/{owner}/{repo}/releases"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/releases"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-release-assets + */ + "GET /repos/{owner}/{repo}/releases/{release_id}/assets": { + parameters: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/assets"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/assets"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository + */ + "GET /repos/{owner}/{repo}/secret-scanning/alerts": { + parameters: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-stargazers + */ + "GET /repos/{owner}/{repo}/stargazers": { + parameters: Endpoints["GET /repos/{owner}/{repo}/stargazers"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/stargazers"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-watchers + */ + "GET /repos/{owner}/{repo}/subscribers": { + parameters: Endpoints["GET /repos/{owner}/{repo}/subscribers"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/subscribers"]["response"]; + }; + /** + * @see https://docs.github.com/v3/repos/#list-repository-tags + */ + "GET /repos/{owner}/{repo}/tags": { + parameters: Endpoints["GET /repos/{owner}/{repo}/tags"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/tags"]["response"]; + }; + /** + * @see https://docs.github.com/v3/repos/#list-repository-teams + */ + "GET /repos/{owner}/{repo}/teams": { + parameters: Endpoints["GET /repos/{owner}/{repo}/teams"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/teams"]["response"]; + }; + /** + * @see https://docs.github.com/v3/repos/#list-public-repositories + */ + "GET /repositories": { + parameters: Endpoints["GET /repositories"]["parameters"]; + response: Endpoints["GET /repositories"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-provisioned-scim groups-for-an-enterprise + */ + "GET /scim/v2/enterprises/{enterprise}/Groups": { + parameters: Endpoints["GET /scim/v2/enterprises/{enterprise}/Groups"]["parameters"]; + response: Endpoints["GET /scim/v2/enterprises/{enterprise}/Groups"]["response"] & { + data: Endpoints["GET /scim/v2/enterprises/{enterprise}/Groups"]["response"]["data"]["Resources"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-scim-provisioned-identities-for-an-enterprise + */ + "GET /scim/v2/enterprises/{enterprise}/Users": { + parameters: Endpoints["GET /scim/v2/enterprises/{enterprise}/Users"]["parameters"]; + response: Endpoints["GET /scim/v2/enterprises/{enterprise}/Users"]["response"] & { + data: Endpoints["GET /scim/v2/enterprises/{enterprise}/Users"]["response"]["data"]["Resources"]; + }; + }; + /** + * @see https://docs.github.com/v3/scim/#list-scim-provisioned-identities + */ + "GET /scim/v2/organizations/{org}/Users": { + parameters: Endpoints["GET /scim/v2/organizations/{org}/Users"]["parameters"]; + response: Endpoints["GET /scim/v2/organizations/{org}/Users"]["response"] & { + data: Endpoints["GET /scim/v2/organizations/{org}/Users"]["response"]["data"]["Resources"]; + }; + }; + /** + * @see https://docs.github.com/v3/search/#search-code + */ + "GET /search/code": { + parameters: Endpoints["GET /search/code"]["parameters"]; + response: Endpoints["GET /search/code"]["response"] & { + data: Endpoints["GET /search/code"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/v3/search/#search-commits + */ + "GET /search/commits": { + parameters: Endpoints["GET /search/commits"]["parameters"]; + response: Endpoints["GET /search/commits"]["response"] & { + data: Endpoints["GET /search/commits"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/v3/search/#search-issues-and-pull-requests + */ + "GET /search/issues": { + parameters: Endpoints["GET /search/issues"]["parameters"]; + response: Endpoints["GET /search/issues"]["response"] & { + data: Endpoints["GET /search/issues"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/v3/search/#search-labels + */ + "GET /search/labels": { + parameters: Endpoints["GET /search/labels"]["parameters"]; + response: Endpoints["GET /search/labels"]["response"] & { + data: Endpoints["GET /search/labels"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/v3/search/#search-repositories + */ + "GET /search/repositories": { + parameters: Endpoints["GET /search/repositories"]["parameters"]; + response: Endpoints["GET /search/repositories"]["response"] & { + data: Endpoints["GET /search/repositories"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/v3/search/#search-topics + */ + "GET /search/topics": { + parameters: Endpoints["GET /search/topics"]["parameters"]; + response: Endpoints["GET /search/topics"]["response"] & { + data: Endpoints["GET /search/topics"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/v3/search/#search-users + */ + "GET /search/users": { + parameters: Endpoints["GET /search/users"]["parameters"]; + response: Endpoints["GET /search/users"]["response"] & { + data: Endpoints["GET /search/users"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussions-legacy + */ + "GET /teams/{team_id}/discussions": { + parameters: Endpoints["GET /teams/{team_id}/discussions"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/discussions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussion-comments-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/comments": { + parameters: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/comments"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/reactions": { + parameters: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/reactions"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-pending-team-invitations-legacy + */ + "GET /teams/{team_id}/invitations": { + parameters: Endpoints["GET /teams/{team_id}/invitations"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/invitations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-team-members-legacy + */ + "GET /teams/{team_id}/members": { + parameters: Endpoints["GET /teams/{team_id}/members"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/members"]["response"]; + }; + /** + * @see https://docs.github.com/v3/teams/#list-team-projects-legacy + */ + "GET /teams/{team_id}/projects": { + parameters: Endpoints["GET /teams/{team_id}/projects"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/projects"]["response"]; + }; + /** + * @see https://docs.github.com/v3/teams/#list-team-repositories-legacy + */ + "GET /teams/{team_id}/repos": { + parameters: Endpoints["GET /teams/{team_id}/repos"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/repos"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team-legacy + */ + "GET /teams/{team_id}/team-sync/group-mappings": { + parameters: Endpoints["GET /teams/{team_id}/team-sync/group-mappings"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/team-sync/group-mappings"]["response"] & { + data: Endpoints["GET /teams/{team_id}/team-sync/group-mappings"]["response"]["data"]["groups"]; + }; + }; + /** + * @see https://docs.github.com/v3/teams/#list-child-teams-legacy + */ + "GET /teams/{team_id}/teams": { + parameters: Endpoints["GET /teams/{team_id}/teams"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/teams"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user + */ + "GET /user/blocks": { + parameters: Endpoints["GET /user/blocks"]["parameters"]; + response: Endpoints["GET /user/blocks"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user + */ + "GET /user/emails": { + parameters: Endpoints["GET /user/emails"]["parameters"]; + response: Endpoints["GET /user/emails"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-followers-of-the-authenticated-user + */ + "GET /user/followers": { + parameters: Endpoints["GET /user/followers"]["parameters"]; + response: Endpoints["GET /user/followers"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows + */ + "GET /user/following": { + parameters: Endpoints["GET /user/following"]["parameters"]; + response: Endpoints["GET /user/following"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user + */ + "GET /user/gpg_keys": { + parameters: Endpoints["GET /user/gpg_keys"]["parameters"]; + response: Endpoints["GET /user/gpg_keys"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token + */ + "GET /user/installations": { + parameters: Endpoints["GET /user/installations"]["parameters"]; + response: Endpoints["GET /user/installations"]["response"] & { + data: Endpoints["GET /user/installations"]["response"]["data"]["installations"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-user-access-token + */ + "GET /user/installations/{installation_id}/repositories": { + parameters: Endpoints["GET /user/installations/{installation_id}/repositories"]["parameters"]; + response: Endpoints["GET /user/installations/{installation_id}/repositories"]["response"] & { + data: Endpoints["GET /user/installations/{installation_id}/repositories"]["response"]["data"]["repositories"]; + }; + }; + /** + * @see https://docs.github.com/v3/issues/#list-user-account-issues-assigned-to-the-authenticated-user + */ + "GET /user/issues": { + parameters: Endpoints["GET /user/issues"]["parameters"]; + response: Endpoints["GET /user/issues"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user + */ + "GET /user/keys": { + parameters: Endpoints["GET /user/keys"]["parameters"]; + response: Endpoints["GET /user/keys"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user + */ + "GET /user/marketplace_purchases": { + parameters: Endpoints["GET /user/marketplace_purchases"]["parameters"]; + response: Endpoints["GET /user/marketplace_purchases"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user-stubbed + */ + "GET /user/marketplace_purchases/stubbed": { + parameters: Endpoints["GET /user/marketplace_purchases/stubbed"]["parameters"]; + response: Endpoints["GET /user/marketplace_purchases/stubbed"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user + */ + "GET /user/memberships/orgs": { + parameters: Endpoints["GET /user/memberships/orgs"]["parameters"]; + response: Endpoints["GET /user/memberships/orgs"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/migrations#list-user-migrations + */ + "GET /user/migrations": { + parameters: Endpoints["GET /user/migrations"]["parameters"]; + response: Endpoints["GET /user/migrations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration + */ + "GET /user/migrations/{migration_id}/repositories": { + parameters: Endpoints["GET /user/migrations/{migration_id}/repositories"]["parameters"]; + response: Endpoints["GET /user/migrations/{migration_id}/repositories"]["response"]; + }; + /** + * @see https://docs.github.com/v3/orgs/#list-organizations-for-the-authenticated-user + */ + "GET /user/orgs": { + parameters: Endpoints["GET /user/orgs"]["parameters"]; + response: Endpoints["GET /user/orgs"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user + */ + "GET /user/public_emails": { + parameters: Endpoints["GET /user/public_emails"]["parameters"]; + response: Endpoints["GET /user/public_emails"]["response"]; + }; + /** + * @see https://docs.github.com/v3/repos/#list-repositories-for-the-authenticated-user + */ + "GET /user/repos": { + parameters: Endpoints["GET /user/repos"]["parameters"]; + response: Endpoints["GET /user/repos"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-invitations-for-the-authenticated-user + */ + "GET /user/repository_invitations": { + parameters: Endpoints["GET /user/repository_invitations"]["parameters"]; + response: Endpoints["GET /user/repository_invitations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user + */ + "GET /user/starred": { + parameters: Endpoints["GET /user/starred"]["parameters"]; + response: Endpoints["GET /user/starred"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-watched-by-the-authenticated-user + */ + "GET /user/subscriptions": { + parameters: Endpoints["GET /user/subscriptions"]["parameters"]; + response: Endpoints["GET /user/subscriptions"]["response"]; + }; + /** + * @see https://docs.github.com/v3/teams/#list-teams-for-the-authenticated-user + */ + "GET /user/teams": { + parameters: Endpoints["GET /user/teams"]["parameters"]; + response: Endpoints["GET /user/teams"]["response"]; + }; + /** + * @see https://docs.github.com/v3/users/#list-users + */ + "GET /users": { + parameters: Endpoints["GET /users"]["parameters"]; + response: Endpoints["GET /users"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-events-for-the-authenticated-user + */ + "GET /users/{username}/events": { + parameters: Endpoints["GET /users/{username}/events"]["parameters"]; + response: Endpoints["GET /users/{username}/events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-organization-events-for-the-authenticated-user + */ + "GET /users/{username}/events/orgs/{org}": { + parameters: Endpoints["GET /users/{username}/events/orgs/{org}"]["parameters"]; + response: Endpoints["GET /users/{username}/events/orgs/{org}"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events-for-a-user + */ + "GET /users/{username}/events/public": { + parameters: Endpoints["GET /users/{username}/events/public"]["parameters"]; + response: Endpoints["GET /users/{username}/events/public"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-followers-of-a-user + */ + "GET /users/{username}/followers": { + parameters: Endpoints["GET /users/{username}/followers"]["parameters"]; + response: Endpoints["GET /users/{username}/followers"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-the-people-a-user-follows + */ + "GET /users/{username}/following": { + parameters: Endpoints["GET /users/{username}/following"]["parameters"]; + response: Endpoints["GET /users/{username}/following"]["response"]; + }; + /** + * @see https://docs.github.com/v3/gists/#list-gists-for-a-user + */ + "GET /users/{username}/gists": { + parameters: Endpoints["GET /users/{username}/gists"]["parameters"]; + response: Endpoints["GET /users/{username}/gists"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-gpg-keys-for-a-user + */ + "GET /users/{username}/gpg_keys": { + parameters: Endpoints["GET /users/{username}/gpg_keys"]["parameters"]; + response: Endpoints["GET /users/{username}/gpg_keys"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-public-keys-for-a-user + */ + "GET /users/{username}/keys": { + parameters: Endpoints["GET /users/{username}/keys"]["parameters"]; + response: Endpoints["GET /users/{username}/keys"]["response"]; + }; + /** + * @see https://docs.github.com/v3/orgs/#list-organizations-for-a-user + */ + "GET /users/{username}/orgs": { + parameters: Endpoints["GET /users/{username}/orgs"]["parameters"]; + response: Endpoints["GET /users/{username}/orgs"]["response"]; + }; + /** + * @see https://docs.github.com/v3/projects/#list-user-projects + */ + "GET /users/{username}/projects": { + parameters: Endpoints["GET /users/{username}/projects"]["parameters"]; + response: Endpoints["GET /users/{username}/projects"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-events-received-by-the-authenticated-user + */ + "GET /users/{username}/received_events": { + parameters: Endpoints["GET /users/{username}/received_events"]["parameters"]; + response: Endpoints["GET /users/{username}/received_events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user + */ + "GET /users/{username}/received_events/public": { + parameters: Endpoints["GET /users/{username}/received_events/public"]["parameters"]; + response: Endpoints["GET /users/{username}/received_events/public"]["response"]; + }; + /** + * @see https://docs.github.com/v3/repos/#list-repositories-for-a-user + */ + "GET /users/{username}/repos": { + parameters: Endpoints["GET /users/{username}/repos"]["parameters"]; + response: Endpoints["GET /users/{username}/repos"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user + */ + "GET /users/{username}/starred": { + parameters: Endpoints["GET /users/{username}/starred"]["parameters"]; + response: Endpoints["GET /users/{username}/starred"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-watched-by-a-user + */ + "GET /users/{username}/subscriptions": { + parameters: Endpoints["GET /users/{username}/subscriptions"]["parameters"]; + response: Endpoints["GET /users/{username}/subscriptions"]["response"]; + }; +} diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts new file mode 100644 index 0000000..44fd234 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts @@ -0,0 +1,14 @@ +import { Octokit } from "@octokit/core"; +import { PaginateInterface } from "./types"; +export { PaginateInterface } from "./types"; +export { composePaginateRest } from "./compose-paginate"; +/** + * @param octokit Octokit instance + * @param options Options passed to Octokit constructor + */ +export declare function paginateRest(octokit: Octokit): { + paginate: PaginateInterface; +}; +export declare namespace paginateRest { + var VERSION: string; +} diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts new file mode 100644 index 0000000..276f6d9 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts @@ -0,0 +1,13 @@ +import { Octokit } from "@octokit/core"; +import { RequestInterface, RequestParameters, Route } from "./types"; +export declare function iterator(octokit: Octokit, route: Route | RequestInterface, parameters?: RequestParameters): { + [Symbol.asyncIterator]: () => { + next(): Promise<{ + done: boolean; + value?: undefined; + } | { + value: import("@octokit/types/dist-types/OctokitResponse").OctokitResponse; + done?: undefined; + }>; + }; +}; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts new file mode 100644 index 0000000..f948a78 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts @@ -0,0 +1,18 @@ +/** + * Some “list” response that can be paginated have a different response structure + * + * They have a `total_count` key in the response (search also has `incomplete_results`, + * /installation/repositories also has `repository_selection`), as well as a key with + * the list of the items which name varies from endpoint to endpoint. + * + * Octokit normalizes these responses so that paginated results are always returned following + * the same structure. One challenge is that if the list response has only one page, no Link + * header is provided, so this header alone is not sufficient to check wether a response is + * paginated or not. + * + * We check if a "total_count" key is present in the response data, but also make sure that + * a "url" property is not, as the "Get the combined status for a specific ref" endpoint would + * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + */ +import { OctokitResponse } from "./types"; +export declare function normalizePaginatedListResponse(response: OctokitResponse): OctokitResponse; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts new file mode 100644 index 0000000..774c604 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts @@ -0,0 +1,3 @@ +import { Octokit } from "@octokit/core"; +import { MapFunction, PaginationResults, RequestParameters, Route, RequestInterface } from "./types"; +export declare function paginate(octokit: Octokit, route: Route | RequestInterface, parameters?: RequestParameters, mapFn?: MapFunction): Promise>; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts new file mode 100644 index 0000000..3e35fbe --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts @@ -0,0 +1,241 @@ +import { Octokit } from "@octokit/core"; +import * as OctokitTypes from "@octokit/types"; +export { EndpointOptions, RequestInterface, OctokitResponse, RequestParameters, Route, } from "@octokit/types"; +import { PaginatingEndpoints } from "./generated/paginating-endpoints"; +declare type KnownKeys = Extract<{ + [K in keyof T]: string extends K ? never : number extends K ? never : K; +} extends { + [_ in keyof T]: infer U; +} ? U : never, keyof T>; +declare type KeysMatching = { + [K in keyof T]: T[K] extends V ? K : never; +}[keyof T]; +declare type KnownKeysMatching = KeysMatching>, V>; +declare type GetResultsType = T extends { + data: any[]; +} ? T["data"] : T extends { + data: object; +} ? T["data"][KnownKeysMatching] : never; +declare type NormalizeResponse = T & { + data: GetResultsType; +}; +declare type DataType = "data" extends keyof T ? T["data"] : unknown; +export interface MapFunction { + (response: OctokitTypes.OctokitResponse>, done: () => void): R[]; +} +export declare type PaginationResults = T[]; +export interface PaginateInterface { + /** + * Paginate a request using endpoint options and map each response to a custom array + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * @param {function} mapFn Optional method to map each response to a custom array + */ + (options: OctokitTypes.EndpointOptions, mapFn: MapFunction): Promise>; + /** + * Paginate a request using endpoint options + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: OctokitTypes.EndpointOptions): Promise>; + /** + * Paginate a request using a known endpoint route string and map each response to a custom array + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {function} mapFn Optional method to map each response to a custom array + */ + (route: R, mapFn: (response: PaginatingEndpoints[R]["response"], done: () => void) => MR): Promise; + /** + * Paginate a request using a known endpoint route string and parameters, and map each response to a custom array + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * @param {function} mapFn Optional method to map each response to a custom array + */ + (route: R, parameters: PaginatingEndpoints[R]["parameters"], mapFn: (response: PaginatingEndpoints[R]["response"], done: () => void) => MR): Promise; + /** + * Paginate a request using an known endpoint route string + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: R, parameters?: PaginatingEndpoints[R]["parameters"]): Promise>; + /** + * Paginate a request using an unknown endpoint route string + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: R, parameters?: R extends keyof PaginatingEndpoints ? PaginatingEndpoints[R]["parameters"] : OctokitTypes.RequestParameters): Promise; + /** + * Paginate a request using an endpoint method and a map function + * + * @param {string} request Request method (`octokit.request` or `@octokit/request`) + * @param {function} mapFn? Optional method to map each response to a custom array + */ + (request: R, mapFn: (response: NormalizeResponse>, done: () => void) => MR): Promise; + /** + * Paginate a request using an endpoint method, parameters, and a map function + * + * @param {string} request Request method (`octokit.request` or `@octokit/request`) + * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * @param {function} mapFn? Optional method to map each response to a custom array + */ + (request: R, parameters: Parameters[0], mapFn: (response: NormalizeResponse>, done?: () => void) => MR): Promise; + /** + * Paginate a request using an endpoint method and parameters + * + * @param {string} request Request method (`octokit.request` or `@octokit/request`) + * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: R, parameters?: Parameters[0]): Promise>["data"]>; + iterator: { + /** + * Get an async iterator to paginate a request using endpoint options + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (EndpointOptions: OctokitTypes.EndpointOptions): AsyncIterableIterator>>; + /** + * Get an async iterator to paginate a request using a known endpoint route string and optional parameters + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: R, parameters?: PaginatingEndpoints[R]["parameters"]): AsyncIterableIterator>>; + /** + * Get an async iterator to paginate a request using an unknown endpoint route string and optional parameters + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: R, parameters?: R extends keyof PaginatingEndpoints ? PaginatingEndpoints[R]["parameters"] : OctokitTypes.RequestParameters): AsyncIterableIterator>>; + /** + * Get an async iterator to paginate a request using a request method and optional parameters + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * @param {string} request `@octokit/request` or `octokit.request` method + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: R, parameters?: Parameters[0]): AsyncIterableIterator>>; + }; +} +export interface ComposePaginateInterface { + /** + * Paginate a request using endpoint options and map each response to a custom array + * + * @param {object} octokit Octokit instance + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * @param {function} mapFn Optional method to map each response to a custom array + */ + (octokit: Octokit, options: OctokitTypes.EndpointOptions, mapFn: MapFunction): Promise>; + /** + * Paginate a request using endpoint options + * + * @param {object} octokit Octokit instance + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, options: OctokitTypes.EndpointOptions): Promise>; + /** + * Paginate a request using a known endpoint route string and map each response to a custom array + * + * @param {object} octokit Octokit instance + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {function} mapFn Optional method to map each response to a custom array + */ + (octokit: Octokit, route: R, mapFn: (response: PaginatingEndpoints[R]["response"], done: () => void) => MR): Promise; + /** + * Paginate a request using a known endpoint route string and parameters, and map each response to a custom array + * + * @param {object} octokit Octokit instance + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * @param {function} mapFn Optional method to map each response to a custom array + */ + (octokit: Octokit, route: R, parameters: PaginatingEndpoints[R]["parameters"], mapFn: (response: PaginatingEndpoints[R]["response"], done: () => void) => MR): Promise; + /** + * Paginate a request using an known endpoint route string + * + * @param {object} octokit Octokit instance + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, route: R, parameters?: PaginatingEndpoints[R]["parameters"]): Promise>; + /** + * Paginate a request using an unknown endpoint route string + * + * @param {object} octokit Octokit instance + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, route: R, parameters?: R extends keyof PaginatingEndpoints ? PaginatingEndpoints[R]["parameters"] : OctokitTypes.RequestParameters): Promise; + /** + * Paginate a request using an endpoint method and a map function + * + * @param {object} octokit Octokit instance + * @param {string} request Request method (`octokit.request` or `@octokit/request`) + * @param {function} mapFn? Optional method to map each response to a custom array + */ + (octokit: Octokit, request: R, mapFn: (response: NormalizeResponse>, done: () => void) => MR): Promise; + /** + * Paginate a request using an endpoint method, parameters, and a map function + * + * @param {object} octokit Octokit instance + * @param {string} request Request method (`octokit.request` or `@octokit/request`) + * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * @param {function} mapFn? Optional method to map each response to a custom array + */ + (octokit: Octokit, request: R, parameters: Parameters[0], mapFn: (response: NormalizeResponse>, done?: () => void) => MR): Promise; + /** + * Paginate a request using an endpoint method and parameters + * + * @param {object} octokit Octokit instance + * @param {string} request Request method (`octokit.request` or `@octokit/request`) + * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, request: R, parameters?: Parameters[0]): Promise>["data"]>; + iterator: { + /** + * Get an async iterator to paginate a request using endpoint options + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * + * @param {object} octokit Octokit instance + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, EndpointOptions: OctokitTypes.EndpointOptions): AsyncIterableIterator>>; + /** + * Get an async iterator to paginate a request using a known endpoint route string and optional parameters + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * + * @param {object} octokit Octokit instance + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, route: R, parameters?: PaginatingEndpoints[R]["parameters"]): AsyncIterableIterator>>; + /** + * Get an async iterator to paginate a request using an unknown endpoint route string and optional parameters + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * + * @param {object} octokit Octokit instance + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, route: R, parameters?: R extends keyof PaginatingEndpoints ? PaginatingEndpoints[R]["parameters"] : OctokitTypes.RequestParameters): AsyncIterableIterator>>; + /** + * Get an async iterator to paginate a request using a request method and optional parameters + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * + * @param {object} octokit Octokit instance + * @param {string} request `@octokit/request` or `octokit.request` method + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, request: R, parameters?: Parameters[0]): AsyncIterableIterator>>; + }; +} diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/version.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/version.d.ts new file mode 100644 index 0000000..6b703e2 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "2.7.1"; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js b/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js new file mode 100644 index 0000000..9a0abaa --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js @@ -0,0 +1,111 @@ +const VERSION = "2.7.1"; + +/** + * Some “list” response that can be paginated have a different response structure + * + * They have a `total_count` key in the response (search also has `incomplete_results`, + * /installation/repositories also has `repository_selection`), as well as a key with + * the list of the items which name varies from endpoint to endpoint. + * + * Octokit normalizes these responses so that paginated results are always returned following + * the same structure. One challenge is that if the list response has only one page, no Link + * header is provided, so this header alone is not sufficient to check wether a response is + * paginated or not. + * + * We check if a "total_count" key is present in the response data, but also make sure that + * a "url" property is not, as the "Get the combined status for a specific ref" endpoint would + * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + */ +function normalizePaginatedListResponse(response) { + const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data); + if (!responseNeedsNormalization) + return response; + // keep the additional properties intact as there is currently no other way + // to retrieve the same information. + const incompleteResults = response.data.incomplete_results; + const repositorySelection = response.data.repository_selection; + const totalCount = response.data.total_count; + delete response.data.incomplete_results; + delete response.data.repository_selection; + delete response.data.total_count; + const namespaceKey = Object.keys(response.data)[0]; + const data = response.data[namespaceKey]; + response.data = data; + if (typeof incompleteResults !== "undefined") { + response.data.incomplete_results = incompleteResults; + } + if (typeof repositorySelection !== "undefined") { + response.data.repository_selection = repositorySelection; + } + response.data.total_count = totalCount; + return response; +} + +function iterator(octokit, route, parameters) { + const options = typeof route === "function" + ? route.endpoint(parameters) + : octokit.request.endpoint(route, parameters); + const requestMethod = typeof route === "function" ? route : octokit.request; + const method = options.method; + const headers = options.headers; + let url = options.url; + return { + [Symbol.asyncIterator]: () => ({ + async next() { + if (!url) + return { done: true }; + const response = await requestMethod({ method, url, headers }); + const normalizedResponse = normalizePaginatedListResponse(response); + // `response.headers.link` format: + // '; rel="next", ; rel="last"' + // sets `url` to undefined if "next" URL is not present or `link` header is not set + url = ((normalizedResponse.headers.link || "").match(/<([^>]+)>;\s*rel="next"/) || [])[1]; + return { value: normalizedResponse }; + }, + }), + }; +} + +function paginate(octokit, route, parameters, mapFn) { + if (typeof parameters === "function") { + mapFn = parameters; + parameters = undefined; + } + return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn); +} +function gather(octokit, results, iterator, mapFn) { + return iterator.next().then((result) => { + if (result.done) { + return results; + } + let earlyExit = false; + function done() { + earlyExit = true; + } + results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data); + if (earlyExit) { + return results; + } + return gather(octokit, results, iterator, mapFn); + }); +} + +const composePaginateRest = Object.assign(paginate, { + iterator, +}); + +/** + * @param octokit Octokit instance + * @param options Options passed to Octokit constructor + */ +function paginateRest(octokit) { + return { + paginate: Object.assign(paginate.bind(null, octokit), { + iterator: iterator.bind(null, octokit), + }), + }; +} +paginateRest.VERSION = VERSION; + +export { composePaginateRest, paginateRest }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js.map b/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js.map new file mode 100644 index 0000000..d5a6947 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/normalize-paginated-list-response.js","../dist-src/iterator.js","../dist-src/paginate.js","../dist-src/compose-paginate.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"2.7.1\";\n","/**\n * Some “list” response that can be paginated have a different response structure\n *\n * They have a `total_count` key in the response (search also has `incomplete_results`,\n * /installation/repositories also has `repository_selection`), as well as a key with\n * the list of the items which name varies from endpoint to endpoint.\n *\n * Octokit normalizes these responses so that paginated results are always returned following\n * the same structure. One challenge is that if the list response has only one page, no Link\n * header is provided, so this header alone is not sufficient to check wether a response is\n * paginated or not.\n *\n * We check if a \"total_count\" key is present in the response data, but also make sure that\n * a \"url\" property is not, as the \"Get the combined status for a specific ref\" endpoint would\n * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref\n */\nexport function normalizePaginatedListResponse(response) {\n const responseNeedsNormalization = \"total_count\" in response.data && !(\"url\" in response.data);\n if (!responseNeedsNormalization)\n return response;\n // keep the additional properties intact as there is currently no other way\n // to retrieve the same information.\n const incompleteResults = response.data.incomplete_results;\n const repositorySelection = response.data.repository_selection;\n const totalCount = response.data.total_count;\n delete response.data.incomplete_results;\n delete response.data.repository_selection;\n delete response.data.total_count;\n const namespaceKey = Object.keys(response.data)[0];\n const data = response.data[namespaceKey];\n response.data = data;\n if (typeof incompleteResults !== \"undefined\") {\n response.data.incomplete_results = incompleteResults;\n }\n if (typeof repositorySelection !== \"undefined\") {\n response.data.repository_selection = repositorySelection;\n }\n response.data.total_count = totalCount;\n return response;\n}\n","import { normalizePaginatedListResponse } from \"./normalize-paginated-list-response\";\nexport function iterator(octokit, route, parameters) {\n const options = typeof route === \"function\"\n ? route.endpoint(parameters)\n : octokit.request.endpoint(route, parameters);\n const requestMethod = typeof route === \"function\" ? route : octokit.request;\n const method = options.method;\n const headers = options.headers;\n let url = options.url;\n return {\n [Symbol.asyncIterator]: () => ({\n async next() {\n if (!url)\n return { done: true };\n const response = await requestMethod({ method, url, headers });\n const normalizedResponse = normalizePaginatedListResponse(response);\n // `response.headers.link` format:\n // '; rel=\"next\", ; rel=\"last\"'\n // sets `url` to undefined if \"next\" URL is not present or `link` header is not set\n url = ((normalizedResponse.headers.link || \"\").match(/<([^>]+)>;\\s*rel=\"next\"/) || [])[1];\n return { value: normalizedResponse };\n },\n }),\n };\n}\n","import { iterator } from \"./iterator\";\nexport function paginate(octokit, route, parameters, mapFn) {\n if (typeof parameters === \"function\") {\n mapFn = parameters;\n parameters = undefined;\n }\n return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn);\n}\nfunction gather(octokit, results, iterator, mapFn) {\n return iterator.next().then((result) => {\n if (result.done) {\n return results;\n }\n let earlyExit = false;\n function done() {\n earlyExit = true;\n }\n results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data);\n if (earlyExit) {\n return results;\n }\n return gather(octokit, results, iterator, mapFn);\n });\n}\n","import { paginate } from \"./paginate\";\nimport { iterator } from \"./iterator\";\nexport const composePaginateRest = Object.assign(paginate, {\n iterator,\n});\n","import { VERSION } from \"./version\";\nimport { paginate } from \"./paginate\";\nimport { iterator } from \"./iterator\";\nexport { composePaginateRest } from \"./compose-paginate\";\n/**\n * @param octokit Octokit instance\n * @param options Options passed to Octokit constructor\n */\nexport function paginateRest(octokit) {\n return {\n paginate: Object.assign(paginate.bind(null, octokit), {\n iterator: iterator.bind(null, octokit),\n }),\n };\n}\npaginateRest.VERSION = VERSION;\n"],"names":[],"mappings":"AAAO,MAAM,OAAO,GAAG,mBAAmB;;ACA1C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,AAAO,SAAS,8BAA8B,CAAC,QAAQ,EAAE;AACzD,IAAI,MAAM,0BAA0B,GAAG,aAAa,IAAI,QAAQ,CAAC,IAAI,IAAI,EAAE,KAAK,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;AACnG,IAAI,IAAI,CAAC,0BAA0B;AACnC,QAAQ,OAAO,QAAQ,CAAC;AACxB;AACA;AACA,IAAI,MAAM,iBAAiB,GAAG,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC;AAC/D,IAAI,MAAM,mBAAmB,GAAG,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC;AACnE,IAAI,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;AACjD,IAAI,OAAO,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC;AAC5C,IAAI,OAAO,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC;AAC9C,IAAI,OAAO,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;AACrC,IAAI,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACvD,IAAI,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AAC7C,IAAI,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;AACzB,IAAI,IAAI,OAAO,iBAAiB,KAAK,WAAW,EAAE;AAClD,QAAQ,QAAQ,CAAC,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;AAC7D,KAAK;AACL,IAAI,IAAI,OAAO,mBAAmB,KAAK,WAAW,EAAE;AACpD,QAAQ,QAAQ,CAAC,IAAI,CAAC,oBAAoB,GAAG,mBAAmB,CAAC;AACjE,KAAK;AACL,IAAI,QAAQ,CAAC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;AAC3C,IAAI,OAAO,QAAQ,CAAC;AACpB,CAAC;;ACtCM,SAAS,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE;AACrD,IAAI,MAAM,OAAO,GAAG,OAAO,KAAK,KAAK,UAAU;AAC/C,UAAU,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC;AACpC,UAAU,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AACtD,IAAI,MAAM,aAAa,GAAG,OAAO,KAAK,KAAK,UAAU,GAAG,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC;AAChF,IAAI,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AAClC,IAAI,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;AACpC,IAAI,IAAI,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;AAC1B,IAAI,OAAO;AACX,QAAQ,CAAC,MAAM,CAAC,aAAa,GAAG,OAAO;AACvC,YAAY,MAAM,IAAI,GAAG;AACzB,gBAAgB,IAAI,CAAC,GAAG;AACxB,oBAAoB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAC1C,gBAAgB,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;AAC/E,gBAAgB,MAAM,kBAAkB,GAAG,8BAA8B,CAAC,QAAQ,CAAC,CAAC;AACpF;AACA;AACA;AACA,gBAAgB,GAAG,GAAG,CAAC,CAAC,kBAAkB,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,EAAE,KAAK,CAAC,yBAAyB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;AAC1G,gBAAgB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;AACrD,aAAa;AACb,SAAS,CAAC;AACV,KAAK,CAAC;AACN,CAAC;;ACvBM,SAAS,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE;AAC5D,IAAI,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE;AAC1C,QAAQ,KAAK,GAAG,UAAU,CAAC;AAC3B,QAAQ,UAAU,GAAG,SAAS,CAAC;AAC/B,KAAK;AACL,IAAI,OAAO,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AACpG,CAAC;AACD,SAAS,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE;AACnD,IAAI,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK;AAC5C,QAAQ,IAAI,MAAM,CAAC,IAAI,EAAE;AACzB,YAAY,OAAO,OAAO,CAAC;AAC3B,SAAS;AACT,QAAQ,IAAI,SAAS,GAAG,KAAK,CAAC;AAC9B,QAAQ,SAAS,IAAI,GAAG;AACxB,YAAY,SAAS,GAAG,IAAI,CAAC;AAC7B,SAAS;AACT,QAAQ,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACxF,QAAQ,IAAI,SAAS,EAAE;AACvB,YAAY,OAAO,OAAO,CAAC;AAC3B,SAAS;AACT,QAAQ,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AACzD,KAAK,CAAC,CAAC;AACP,CAAC;;ACrBW,MAAC,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;AAC3D,IAAI,QAAQ;AACZ,CAAC,CAAC;;ACAF;AACA;AACA;AACA;AACA,AAAO,SAAS,YAAY,CAAC,OAAO,EAAE;AACtC,IAAI,OAAO;AACX,QAAQ,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE;AAC9D,YAAY,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC;AAClD,SAAS,CAAC;AACV,KAAK,CAAC;AACN,CAAC;AACD,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/plugin-paginate-rest/package.json b/node_modules/@octokit/plugin-paginate-rest/package.json new file mode 100644 index 0000000..50746f6 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/package.json @@ -0,0 +1,87 @@ +{ + "_args": [ + [ + "@octokit/plugin-paginate-rest@2.7.1", + "." + ] + ], + "_from": "@octokit/plugin-paginate-rest@2.7.1", + "_id": "@octokit/plugin-paginate-rest@2.7.1", + "_inBundle": false, + "_integrity": "sha512-dUsxsEIrBqhlQNfXRhMhXOTQi0SSG38+QWcPGO226HFPFJk44vWukegHfMG3496vLv9T2oT7IuAGssGpcUg5bQ==", + "_location": "/@octokit/plugin-paginate-rest", + "_phantomChildren": {}, + "_requested": { + "type": "version", + "registry": true, + "raw": "@octokit/plugin-paginate-rest@2.7.1", + "name": "@octokit/plugin-paginate-rest", + "escapedName": "@octokit%2fplugin-paginate-rest", + "scope": "@octokit", + "rawSpec": "2.7.1", + "saveSpec": null, + "fetchSpec": "2.7.1" + }, + "_requiredBy": [ + "/@actions/github" + ], + "_resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.7.1.tgz", + "_spec": "2.7.1", + "_where": ".", + "bugs": { + "url": "https://github.com/octokit/plugin-paginate-rest.js/issues" + }, + "dependencies": { + "@octokit/types": "^6.3.1" + }, + "description": "Octokit plugin to paginate REST API endpoint responses", + "devDependencies": { + "@octokit/core": "^3.0.0", + "@octokit/plugin-rest-endpoint-methods": "^4.0.0", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/fetch-mock": "^7.3.1", + "@types/jest": "^26.0.0", + "@types/node": "^14.0.4", + "fetch-mock": "^9.0.0", + "jest": "^26.0.1", + "npm-run-all": "^4.1.5", + "prettier": "^2.0.4", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "ts-jest": "^26.0.0", + "typescript": "^4.0.2" + }, + "files": [ + "dist-*/", + "bin/" + ], + "homepage": "https://github.com/octokit/plugin-paginate-rest.js#readme", + "keywords": [ + "github", + "api", + "sdk", + "toolkit" + ], + "license": "MIT", + "main": "dist-node/index.js", + "module": "dist-web/index.js", + "name": "@octokit/plugin-paginate-rest", + "peerDependencies": { + "@octokit/core": ">=2" + }, + "pika": true, + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/octokit/plugin-paginate-rest.js.git" + }, + "sideEffects": false, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "version": "2.7.1" +} diff --git a/node_modules/os-name/license b/node_modules/@octokit/plugin-rest-endpoint-methods/LICENSE similarity index 80% rename from node_modules/os-name/license rename to node_modules/@octokit/plugin-rest-endpoint-methods/LICENSE index e7af2f7..57bee5f 100644 --- a/node_modules/os-name/license +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/LICENSE @@ -1,9 +1,7 @@ -MIT License - -Copyright (c) Sindre Sorhus (sindresorhus.com) +MIT License Copyright (c) 2019 Octokit contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/README.md b/node_modules/@octokit/plugin-rest-endpoint-methods/README.md new file mode 100644 index 0000000..0658dee --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/README.md @@ -0,0 +1,72 @@ +# plugin-rest-endpoint-methods.js + +> Octokit plugin adding one method for all of api.github.com REST API endpoints + +[![@latest](https://img.shields.io/npm/v/@octokit/plugin-rest-endpoint-methods.svg)](https://www.npmjs.com/package/@octokit/plugin-rest-endpoint-methods) +[![Build Status](https://github.com/octokit/plugin-rest-endpoint-methods.js/workflows/Test/badge.svg)](https://github.com/octokit/plugin-rest-endpoint-methods.js/actions?workflow=Test) + +## Usage + + + + + + +
+Browsers + + +Load `@octokit/plugin-rest-endpoint-methods` and [`@octokit/core`](https://github.com/octokit/core.js) (or core-compatible module) directly from [cdn.skypack.dev](https://cdn.skypack.dev) + +```html + +``` + +
+Node + + +Install with `npm install @octokit/core @octokit/plugin-rest-endpoint-methods`. Optionally replace `@octokit/core` with a compatible module + +```js +const { Octokit } = require("@octokit/core"); +const { + restEndpointMethods, +} = require("@octokit/plugin-rest-endpoint-methods"); +``` + +
+ +```js +const MyOctokit = Octokit.plugin(restEndpointMethods); +const octokit = new MyOctokit({ auth: "secret123" }); + +// https://developer.github.com/v3/users/#get-the-authenticated-user +octokit.users.getAuthenticated(); +``` + +There is one method for each REST API endpoint documented at [https://developer.github.com/v3](https://developer.github.com/v3). All endpoint methods are documented in the [docs/](docs/) folder, e.g. [docs/users/getAuthenticated.md](docs/users/getAuthenticated.md) + +## TypeScript + +Parameter and response types for all endpoint methods exported as `{ RestEndpointMethodTypes }`. + +Example + +```ts +import { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods"; + +type UpdateLabelParameters = RestEndpointMethodTypes["issues"]["updateLabel"]["parameters"]; +type UpdateLabelResponse = RestEndpointMethodTypes["issues"]["updateLabel"]["response"]; +``` + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js new file mode 100644 index 0000000..9570cd1 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js @@ -0,0 +1,1134 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +const Endpoints = { + actions: { + addSelectedRepoToOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"], + cancelWorkflowRun: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel"], + createOrUpdateOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}"], + createOrUpdateRepoSecret: ["PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}"], + createRegistrationTokenForOrg: ["POST /orgs/{org}/actions/runners/registration-token"], + createRegistrationTokenForRepo: ["POST /repos/{owner}/{repo}/actions/runners/registration-token"], + createRemoveTokenForOrg: ["POST /orgs/{org}/actions/runners/remove-token"], + createRemoveTokenForRepo: ["POST /repos/{owner}/{repo}/actions/runners/remove-token"], + createWorkflowDispatch: ["POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches"], + deleteArtifact: ["DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"], + deleteOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}"], + deleteRepoSecret: ["DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}"], + deleteSelfHostedRunnerFromOrg: ["DELETE /orgs/{org}/actions/runners/{runner_id}"], + deleteSelfHostedRunnerFromRepo: ["DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}"], + deleteWorkflowRun: ["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}"], + deleteWorkflowRunLogs: ["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs"], + disableSelectedRepositoryGithubActionsOrganization: ["DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}"], + disableWorkflow: ["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable"], + downloadArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}"], + downloadJobLogsForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"], + downloadWorkflowRunLogs: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs"], + enableSelectedRepositoryGithubActionsOrganization: ["PUT /orgs/{org}/actions/permissions/repositories/{repository_id}"], + enableWorkflow: ["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable"], + getAllowedActionsOrganization: ["GET /orgs/{org}/actions/permissions/selected-actions"], + getAllowedActionsRepository: ["GET /repos/{owner}/{repo}/actions/permissions/selected-actions"], + getArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"], + getGithubActionsPermissionsOrganization: ["GET /orgs/{org}/actions/permissions"], + getGithubActionsPermissionsRepository: ["GET /repos/{owner}/{repo}/actions/permissions"], + getJobForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"], + getOrgPublicKey: ["GET /orgs/{org}/actions/secrets/public-key"], + getOrgSecret: ["GET /orgs/{org}/actions/secrets/{secret_name}"], + getRepoPermissions: ["GET /repos/{owner}/{repo}/actions/permissions", {}, { + renamed: ["actions", "getGithubActionsPermissionsRepository"] + }], + getRepoPublicKey: ["GET /repos/{owner}/{repo}/actions/secrets/public-key"], + getRepoSecret: ["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"], + getSelfHostedRunnerForOrg: ["GET /orgs/{org}/actions/runners/{runner_id}"], + getSelfHostedRunnerForRepo: ["GET /repos/{owner}/{repo}/actions/runners/{runner_id}"], + getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], + getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], + getWorkflowRunUsage: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing"], + getWorkflowUsage: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing"], + listArtifactsForRepo: ["GET /repos/{owner}/{repo}/actions/artifacts"], + listJobsForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"], + listOrgSecrets: ["GET /orgs/{org}/actions/secrets"], + listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], + listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], + listRunnerApplicationsForOrg: ["GET /orgs/{org}/actions/runners/downloads"], + listRunnerApplicationsForRepo: ["GET /repos/{owner}/{repo}/actions/runners/downloads"], + listSelectedReposForOrgSecret: ["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"], + listSelectedRepositoriesEnabledGithubActionsOrganization: ["GET /orgs/{org}/actions/permissions/repositories"], + listSelfHostedRunnersForOrg: ["GET /orgs/{org}/actions/runners"], + listSelfHostedRunnersForRepo: ["GET /repos/{owner}/{repo}/actions/runners"], + listWorkflowRunArtifacts: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"], + listWorkflowRuns: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"], + listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"], + reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"], + removeSelectedRepoFromOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"], + setAllowedActionsOrganization: ["PUT /orgs/{org}/actions/permissions/selected-actions"], + setAllowedActionsRepository: ["PUT /repos/{owner}/{repo}/actions/permissions/selected-actions"], + setGithubActionsPermissionsOrganization: ["PUT /orgs/{org}/actions/permissions"], + setGithubActionsPermissionsRepository: ["PUT /repos/{owner}/{repo}/actions/permissions"], + setSelectedReposForOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories"], + setSelectedRepositoriesEnabledGithubActionsOrganization: ["PUT /orgs/{org}/actions/permissions/repositories"] + }, + activity: { + checkRepoIsStarredByAuthenticatedUser: ["GET /user/starred/{owner}/{repo}"], + deleteRepoSubscription: ["DELETE /repos/{owner}/{repo}/subscription"], + deleteThreadSubscription: ["DELETE /notifications/threads/{thread_id}/subscription"], + getFeeds: ["GET /feeds"], + getRepoSubscription: ["GET /repos/{owner}/{repo}/subscription"], + getThread: ["GET /notifications/threads/{thread_id}"], + getThreadSubscriptionForAuthenticatedUser: ["GET /notifications/threads/{thread_id}/subscription"], + listEventsForAuthenticatedUser: ["GET /users/{username}/events"], + listNotificationsForAuthenticatedUser: ["GET /notifications"], + listOrgEventsForAuthenticatedUser: ["GET /users/{username}/events/orgs/{org}"], + listPublicEvents: ["GET /events"], + listPublicEventsForRepoNetwork: ["GET /networks/{owner}/{repo}/events"], + listPublicEventsForUser: ["GET /users/{username}/events/public"], + listPublicOrgEvents: ["GET /orgs/{org}/events"], + listReceivedEventsForUser: ["GET /users/{username}/received_events"], + listReceivedPublicEventsForUser: ["GET /users/{username}/received_events/public"], + listRepoEvents: ["GET /repos/{owner}/{repo}/events"], + listRepoNotificationsForAuthenticatedUser: ["GET /repos/{owner}/{repo}/notifications"], + listReposStarredByAuthenticatedUser: ["GET /user/starred"], + listReposStarredByUser: ["GET /users/{username}/starred"], + listReposWatchedByUser: ["GET /users/{username}/subscriptions"], + listStargazersForRepo: ["GET /repos/{owner}/{repo}/stargazers"], + listWatchedReposForAuthenticatedUser: ["GET /user/subscriptions"], + listWatchersForRepo: ["GET /repos/{owner}/{repo}/subscribers"], + markNotificationsAsRead: ["PUT /notifications"], + markRepoNotificationsAsRead: ["PUT /repos/{owner}/{repo}/notifications"], + markThreadAsRead: ["PATCH /notifications/threads/{thread_id}"], + setRepoSubscription: ["PUT /repos/{owner}/{repo}/subscription"], + setThreadSubscription: ["PUT /notifications/threads/{thread_id}/subscription"], + starRepoForAuthenticatedUser: ["PUT /user/starred/{owner}/{repo}"], + unstarRepoForAuthenticatedUser: ["DELETE /user/starred/{owner}/{repo}"] + }, + apps: { + addRepoToInstallation: ["PUT /user/installations/{installation_id}/repositories/{repository_id}"], + checkToken: ["POST /applications/{client_id}/token"], + createContentAttachment: ["POST /content_references/{content_reference_id}/attachments", { + mediaType: { + previews: ["corsair"] + } + }], + createFromManifest: ["POST /app-manifests/{code}/conversions"], + createInstallationAccessToken: ["POST /app/installations/{installation_id}/access_tokens"], + deleteAuthorization: ["DELETE /applications/{client_id}/grant"], + deleteInstallation: ["DELETE /app/installations/{installation_id}"], + deleteToken: ["DELETE /applications/{client_id}/token"], + getAuthenticated: ["GET /app"], + getBySlug: ["GET /apps/{app_slug}"], + getInstallation: ["GET /app/installations/{installation_id}"], + getOrgInstallation: ["GET /orgs/{org}/installation"], + getRepoInstallation: ["GET /repos/{owner}/{repo}/installation"], + getSubscriptionPlanForAccount: ["GET /marketplace_listing/accounts/{account_id}"], + getSubscriptionPlanForAccountStubbed: ["GET /marketplace_listing/stubbed/accounts/{account_id}"], + getUserInstallation: ["GET /users/{username}/installation"], + getWebhookConfigForApp: ["GET /app/hook/config"], + listAccountsForPlan: ["GET /marketplace_listing/plans/{plan_id}/accounts"], + listAccountsForPlanStubbed: ["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"], + listInstallationReposForAuthenticatedUser: ["GET /user/installations/{installation_id}/repositories"], + listInstallations: ["GET /app/installations"], + listInstallationsForAuthenticatedUser: ["GET /user/installations"], + listPlans: ["GET /marketplace_listing/plans"], + listPlansStubbed: ["GET /marketplace_listing/stubbed/plans"], + listReposAccessibleToInstallation: ["GET /installation/repositories"], + listSubscriptionsForAuthenticatedUser: ["GET /user/marketplace_purchases"], + listSubscriptionsForAuthenticatedUserStubbed: ["GET /user/marketplace_purchases/stubbed"], + removeRepoFromInstallation: ["DELETE /user/installations/{installation_id}/repositories/{repository_id}"], + resetToken: ["PATCH /applications/{client_id}/token"], + revokeInstallationAccessToken: ["DELETE /installation/token"], + scopeToken: ["POST /applications/{client_id}/token/scoped"], + suspendInstallation: ["PUT /app/installations/{installation_id}/suspended"], + unsuspendInstallation: ["DELETE /app/installations/{installation_id}/suspended"], + updateWebhookConfigForApp: ["PATCH /app/hook/config"] + }, + billing: { + getGithubActionsBillingOrg: ["GET /orgs/{org}/settings/billing/actions"], + getGithubActionsBillingUser: ["GET /users/{username}/settings/billing/actions"], + getGithubPackagesBillingOrg: ["GET /orgs/{org}/settings/billing/packages"], + getGithubPackagesBillingUser: ["GET /users/{username}/settings/billing/packages"], + getSharedStorageBillingOrg: ["GET /orgs/{org}/settings/billing/shared-storage"], + getSharedStorageBillingUser: ["GET /users/{username}/settings/billing/shared-storage"] + }, + checks: { + create: ["POST /repos/{owner}/{repo}/check-runs"], + createSuite: ["POST /repos/{owner}/{repo}/check-suites"], + get: ["GET /repos/{owner}/{repo}/check-runs/{check_run_id}"], + getSuite: ["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}"], + listAnnotations: ["GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"], + listForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"], + listForSuite: ["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"], + listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"], + rerequestSuite: ["POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"], + setSuitesPreferences: ["PATCH /repos/{owner}/{repo}/check-suites/preferences"], + update: ["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"] + }, + codeScanning: { + getAlert: ["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", {}, { + renamedParameters: { + alert_id: "alert_number" + } + }], + listAlertsForRepo: ["GET /repos/{owner}/{repo}/code-scanning/alerts"], + listRecentAnalyses: ["GET /repos/{owner}/{repo}/code-scanning/analyses"], + updateAlert: ["PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"], + uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"] + }, + codesOfConduct: { + getAllCodesOfConduct: ["GET /codes_of_conduct", { + mediaType: { + previews: ["scarlet-witch"] + } + }], + getConductCode: ["GET /codes_of_conduct/{key}", { + mediaType: { + previews: ["scarlet-witch"] + } + }], + getForRepo: ["GET /repos/{owner}/{repo}/community/code_of_conduct", { + mediaType: { + previews: ["scarlet-witch"] + } + }] + }, + emojis: { + get: ["GET /emojis"] + }, + enterpriseAdmin: { + disableSelectedOrganizationGithubActionsEnterprise: ["DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"], + enableSelectedOrganizationGithubActionsEnterprise: ["PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"], + getAllowedActionsEnterprise: ["GET /enterprises/{enterprise}/actions/permissions/selected-actions"], + getGithubActionsPermissionsEnterprise: ["GET /enterprises/{enterprise}/actions/permissions"], + listSelectedOrganizationsEnabledGithubActionsEnterprise: ["GET /enterprises/{enterprise}/actions/permissions/organizations"], + setAllowedActionsEnterprise: ["PUT /enterprises/{enterprise}/actions/permissions/selected-actions"], + setGithubActionsPermissionsEnterprise: ["PUT /enterprises/{enterprise}/actions/permissions"], + setSelectedOrganizationsEnabledGithubActionsEnterprise: ["PUT /enterprises/{enterprise}/actions/permissions/organizations"] + }, + gists: { + checkIsStarred: ["GET /gists/{gist_id}/star"], + create: ["POST /gists"], + createComment: ["POST /gists/{gist_id}/comments"], + delete: ["DELETE /gists/{gist_id}"], + deleteComment: ["DELETE /gists/{gist_id}/comments/{comment_id}"], + fork: ["POST /gists/{gist_id}/forks"], + get: ["GET /gists/{gist_id}"], + getComment: ["GET /gists/{gist_id}/comments/{comment_id}"], + getRevision: ["GET /gists/{gist_id}/{sha}"], + list: ["GET /gists"], + listComments: ["GET /gists/{gist_id}/comments"], + listCommits: ["GET /gists/{gist_id}/commits"], + listForUser: ["GET /users/{username}/gists"], + listForks: ["GET /gists/{gist_id}/forks"], + listPublic: ["GET /gists/public"], + listStarred: ["GET /gists/starred"], + star: ["PUT /gists/{gist_id}/star"], + unstar: ["DELETE /gists/{gist_id}/star"], + update: ["PATCH /gists/{gist_id}"], + updateComment: ["PATCH /gists/{gist_id}/comments/{comment_id}"] + }, + git: { + createBlob: ["POST /repos/{owner}/{repo}/git/blobs"], + createCommit: ["POST /repos/{owner}/{repo}/git/commits"], + createRef: ["POST /repos/{owner}/{repo}/git/refs"], + createTag: ["POST /repos/{owner}/{repo}/git/tags"], + createTree: ["POST /repos/{owner}/{repo}/git/trees"], + deleteRef: ["DELETE /repos/{owner}/{repo}/git/refs/{ref}"], + getBlob: ["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"], + getCommit: ["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"], + getRef: ["GET /repos/{owner}/{repo}/git/ref/{ref}"], + getTag: ["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"], + getTree: ["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"], + listMatchingRefs: ["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"], + updateRef: ["PATCH /repos/{owner}/{repo}/git/refs/{ref}"] + }, + gitignore: { + getAllTemplates: ["GET /gitignore/templates"], + getTemplate: ["GET /gitignore/templates/{name}"] + }, + interactions: { + getRestrictionsForOrg: ["GET /orgs/{org}/interaction-limits"], + getRestrictionsForRepo: ["GET /repos/{owner}/{repo}/interaction-limits"], + getRestrictionsForYourPublicRepos: ["GET /user/interaction-limits"], + removeRestrictionsForOrg: ["DELETE /orgs/{org}/interaction-limits"], + removeRestrictionsForRepo: ["DELETE /repos/{owner}/{repo}/interaction-limits"], + removeRestrictionsForYourPublicRepos: ["DELETE /user/interaction-limits"], + setRestrictionsForOrg: ["PUT /orgs/{org}/interaction-limits"], + setRestrictionsForRepo: ["PUT /repos/{owner}/{repo}/interaction-limits"], + setRestrictionsForYourPublicRepos: ["PUT /user/interaction-limits"] + }, + issues: { + addAssignees: ["POST /repos/{owner}/{repo}/issues/{issue_number}/assignees"], + addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"], + checkUserCanBeAssigned: ["GET /repos/{owner}/{repo}/assignees/{assignee}"], + create: ["POST /repos/{owner}/{repo}/issues"], + createComment: ["POST /repos/{owner}/{repo}/issues/{issue_number}/comments"], + createLabel: ["POST /repos/{owner}/{repo}/labels"], + createMilestone: ["POST /repos/{owner}/{repo}/milestones"], + deleteComment: ["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}"], + deleteLabel: ["DELETE /repos/{owner}/{repo}/labels/{name}"], + deleteMilestone: ["DELETE /repos/{owner}/{repo}/milestones/{milestone_number}"], + get: ["GET /repos/{owner}/{repo}/issues/{issue_number}"], + getComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"], + getEvent: ["GET /repos/{owner}/{repo}/issues/events/{event_id}"], + getLabel: ["GET /repos/{owner}/{repo}/labels/{name}"], + getMilestone: ["GET /repos/{owner}/{repo}/milestones/{milestone_number}"], + list: ["GET /issues"], + listAssignees: ["GET /repos/{owner}/{repo}/assignees"], + listComments: ["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"], + listCommentsForRepo: ["GET /repos/{owner}/{repo}/issues/comments"], + listEvents: ["GET /repos/{owner}/{repo}/issues/{issue_number}/events"], + listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"], + listEventsForTimeline: ["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", { + mediaType: { + previews: ["mockingbird"] + } + }], + listForAuthenticatedUser: ["GET /user/issues"], + listForOrg: ["GET /orgs/{org}/issues"], + listForRepo: ["GET /repos/{owner}/{repo}/issues"], + listLabelsForMilestone: ["GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels"], + listLabelsForRepo: ["GET /repos/{owner}/{repo}/labels"], + listLabelsOnIssue: ["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"], + listMilestones: ["GET /repos/{owner}/{repo}/milestones"], + lock: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"], + removeAllLabels: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels"], + removeAssignees: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees"], + removeLabel: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}"], + setLabels: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"], + unlock: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"], + update: ["PATCH /repos/{owner}/{repo}/issues/{issue_number}"], + updateComment: ["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"], + updateLabel: ["PATCH /repos/{owner}/{repo}/labels/{name}"], + updateMilestone: ["PATCH /repos/{owner}/{repo}/milestones/{milestone_number}"] + }, + licenses: { + get: ["GET /licenses/{license}"], + getAllCommonlyUsed: ["GET /licenses"], + getForRepo: ["GET /repos/{owner}/{repo}/license"] + }, + markdown: { + render: ["POST /markdown"], + renderRaw: ["POST /markdown/raw", { + headers: { + "content-type": "text/plain; charset=utf-8" + } + }] + }, + meta: { + get: ["GET /meta"], + getOctocat: ["GET /octocat"], + getZen: ["GET /zen"], + root: ["GET /"] + }, + migrations: { + cancelImport: ["DELETE /repos/{owner}/{repo}/import"], + deleteArchiveForAuthenticatedUser: ["DELETE /user/migrations/{migration_id}/archive", { + mediaType: { + previews: ["wyandotte"] + } + }], + deleteArchiveForOrg: ["DELETE /orgs/{org}/migrations/{migration_id}/archive", { + mediaType: { + previews: ["wyandotte"] + } + }], + downloadArchiveForOrg: ["GET /orgs/{org}/migrations/{migration_id}/archive", { + mediaType: { + previews: ["wyandotte"] + } + }], + getArchiveForAuthenticatedUser: ["GET /user/migrations/{migration_id}/archive", { + mediaType: { + previews: ["wyandotte"] + } + }], + getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"], + getImportStatus: ["GET /repos/{owner}/{repo}/import"], + getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"], + getStatusForAuthenticatedUser: ["GET /user/migrations/{migration_id}", { + mediaType: { + previews: ["wyandotte"] + } + }], + getStatusForOrg: ["GET /orgs/{org}/migrations/{migration_id}", { + mediaType: { + previews: ["wyandotte"] + } + }], + listForAuthenticatedUser: ["GET /user/migrations", { + mediaType: { + previews: ["wyandotte"] + } + }], + listForOrg: ["GET /orgs/{org}/migrations", { + mediaType: { + previews: ["wyandotte"] + } + }], + listReposForOrg: ["GET /orgs/{org}/migrations/{migration_id}/repositories", { + mediaType: { + previews: ["wyandotte"] + } + }], + listReposForUser: ["GET /user/migrations/{migration_id}/repositories", { + mediaType: { + previews: ["wyandotte"] + } + }], + mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"], + setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"], + startForAuthenticatedUser: ["POST /user/migrations"], + startForOrg: ["POST /orgs/{org}/migrations"], + startImport: ["PUT /repos/{owner}/{repo}/import"], + unlockRepoForAuthenticatedUser: ["DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock", { + mediaType: { + previews: ["wyandotte"] + } + }], + unlockRepoForOrg: ["DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", { + mediaType: { + previews: ["wyandotte"] + } + }], + updateImport: ["PATCH /repos/{owner}/{repo}/import"] + }, + orgs: { + blockUser: ["PUT /orgs/{org}/blocks/{username}"], + checkBlockedUser: ["GET /orgs/{org}/blocks/{username}"], + checkMembershipForUser: ["GET /orgs/{org}/members/{username}"], + checkPublicMembershipForUser: ["GET /orgs/{org}/public_members/{username}"], + convertMemberToOutsideCollaborator: ["PUT /orgs/{org}/outside_collaborators/{username}"], + createInvitation: ["POST /orgs/{org}/invitations"], + createWebhook: ["POST /orgs/{org}/hooks"], + deleteWebhook: ["DELETE /orgs/{org}/hooks/{hook_id}"], + get: ["GET /orgs/{org}"], + getMembershipForAuthenticatedUser: ["GET /user/memberships/orgs/{org}"], + getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], + getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], + getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"], + list: ["GET /organizations"], + listAppInstallations: ["GET /orgs/{org}/installations"], + listBlockedUsers: ["GET /orgs/{org}/blocks"], + listForAuthenticatedUser: ["GET /user/orgs"], + listForUser: ["GET /users/{username}/orgs"], + listInvitationTeams: ["GET /orgs/{org}/invitations/{invitation_id}/teams"], + listMembers: ["GET /orgs/{org}/members"], + listMembershipsForAuthenticatedUser: ["GET /user/memberships/orgs"], + listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], + listPendingInvitations: ["GET /orgs/{org}/invitations"], + listPublicMembers: ["GET /orgs/{org}/public_members"], + listWebhooks: ["GET /orgs/{org}/hooks"], + pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], + removeMember: ["DELETE /orgs/{org}/members/{username}"], + removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"], + removeOutsideCollaborator: ["DELETE /orgs/{org}/outside_collaborators/{username}"], + removePublicMembershipForAuthenticatedUser: ["DELETE /orgs/{org}/public_members/{username}"], + setMembershipForUser: ["PUT /orgs/{org}/memberships/{username}"], + setPublicMembershipForAuthenticatedUser: ["PUT /orgs/{org}/public_members/{username}"], + unblockUser: ["DELETE /orgs/{org}/blocks/{username}"], + update: ["PATCH /orgs/{org}"], + updateMembershipForAuthenticatedUser: ["PATCH /user/memberships/orgs/{org}"], + updateWebhook: ["PATCH /orgs/{org}/hooks/{hook_id}"], + updateWebhookConfigForOrg: ["PATCH /orgs/{org}/hooks/{hook_id}/config"] + }, + projects: { + addCollaborator: ["PUT /projects/{project_id}/collaborators/{username}", { + mediaType: { + previews: ["inertia"] + } + }], + createCard: ["POST /projects/columns/{column_id}/cards", { + mediaType: { + previews: ["inertia"] + } + }], + createColumn: ["POST /projects/{project_id}/columns", { + mediaType: { + previews: ["inertia"] + } + }], + createForAuthenticatedUser: ["POST /user/projects", { + mediaType: { + previews: ["inertia"] + } + }], + createForOrg: ["POST /orgs/{org}/projects", { + mediaType: { + previews: ["inertia"] + } + }], + createForRepo: ["POST /repos/{owner}/{repo}/projects", { + mediaType: { + previews: ["inertia"] + } + }], + delete: ["DELETE /projects/{project_id}", { + mediaType: { + previews: ["inertia"] + } + }], + deleteCard: ["DELETE /projects/columns/cards/{card_id}", { + mediaType: { + previews: ["inertia"] + } + }], + deleteColumn: ["DELETE /projects/columns/{column_id}", { + mediaType: { + previews: ["inertia"] + } + }], + get: ["GET /projects/{project_id}", { + mediaType: { + previews: ["inertia"] + } + }], + getCard: ["GET /projects/columns/cards/{card_id}", { + mediaType: { + previews: ["inertia"] + } + }], + getColumn: ["GET /projects/columns/{column_id}", { + mediaType: { + previews: ["inertia"] + } + }], + getPermissionForUser: ["GET /projects/{project_id}/collaborators/{username}/permission", { + mediaType: { + previews: ["inertia"] + } + }], + listCards: ["GET /projects/columns/{column_id}/cards", { + mediaType: { + previews: ["inertia"] + } + }], + listCollaborators: ["GET /projects/{project_id}/collaborators", { + mediaType: { + previews: ["inertia"] + } + }], + listColumns: ["GET /projects/{project_id}/columns", { + mediaType: { + previews: ["inertia"] + } + }], + listForOrg: ["GET /orgs/{org}/projects", { + mediaType: { + previews: ["inertia"] + } + }], + listForRepo: ["GET /repos/{owner}/{repo}/projects", { + mediaType: { + previews: ["inertia"] + } + }], + listForUser: ["GET /users/{username}/projects", { + mediaType: { + previews: ["inertia"] + } + }], + moveCard: ["POST /projects/columns/cards/{card_id}/moves", { + mediaType: { + previews: ["inertia"] + } + }], + moveColumn: ["POST /projects/columns/{column_id}/moves", { + mediaType: { + previews: ["inertia"] + } + }], + removeCollaborator: ["DELETE /projects/{project_id}/collaborators/{username}", { + mediaType: { + previews: ["inertia"] + } + }], + update: ["PATCH /projects/{project_id}", { + mediaType: { + previews: ["inertia"] + } + }], + updateCard: ["PATCH /projects/columns/cards/{card_id}", { + mediaType: { + previews: ["inertia"] + } + }], + updateColumn: ["PATCH /projects/columns/{column_id}", { + mediaType: { + previews: ["inertia"] + } + }] + }, + pulls: { + checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + create: ["POST /repos/{owner}/{repo}/pulls"], + createReplyForReviewComment: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"], + createReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + createReviewComment: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments"], + deletePendingReview: ["DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"], + deleteReviewComment: ["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}"], + dismissReview: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals"], + get: ["GET /repos/{owner}/{repo}/pulls/{pull_number}"], + getReview: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"], + getReviewComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"], + list: ["GET /repos/{owner}/{repo}/pulls"], + listCommentsForReview: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments"], + listCommits: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"], + listFiles: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"], + listRequestedReviewers: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"], + listReviewComments: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"], + listReviewCommentsForRepo: ["GET /repos/{owner}/{repo}/pulls/comments"], + listReviews: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + merge: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + removeRequestedReviewers: ["DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"], + requestReviewers: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"], + submitReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"], + update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"], + updateBranch: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch", { + mediaType: { + previews: ["lydian"] + } + }], + updateReview: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"], + updateReviewComment: ["PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}"] + }, + rateLimit: { + get: ["GET /rate_limit"] + }, + reactions: { + createForCommitComment: ["POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + createForIssue: ["POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + createForIssueComment: ["POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + createForPullRequestReviewComment: ["POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + createForTeamDiscussionCommentInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + createForTeamDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteForCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteForIssue: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteForIssueComment: ["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteForPullRequestComment: ["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteForTeamDiscussion: ["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteForTeamDiscussionComment: ["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteLegacy: ["DELETE /reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }, { + deprecated: "octokit.reactions.deleteLegacy() is deprecated, see https://docs.github.com/v3/reactions/#delete-a-reaction-legacy" + }], + listForCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + listForIssue: ["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + listForIssueComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + listForPullRequestReviewComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + listForTeamDiscussionCommentInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + listForTeamDiscussionInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }] + }, + repos: { + acceptInvitation: ["PATCH /user/repository_invitations/{invitation_id}"], + addAppAccessRestrictions: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", {}, { + mapToData: "apps" + }], + addCollaborator: ["PUT /repos/{owner}/{repo}/collaborators/{username}"], + addStatusCheckContexts: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", {}, { + mapToData: "contexts" + }], + addTeamAccessRestrictions: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", {}, { + mapToData: "teams" + }], + addUserAccessRestrictions: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", {}, { + mapToData: "users" + }], + checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], + checkVulnerabilityAlerts: ["GET /repos/{owner}/{repo}/vulnerability-alerts", { + mediaType: { + previews: ["dorian"] + } + }], + compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], + createCommitComment: ["POST /repos/{owner}/{repo}/commits/{commit_sha}/comments"], + createCommitSignatureProtection: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", { + mediaType: { + previews: ["zzzax"] + } + }], + createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"], + createDeployKey: ["POST /repos/{owner}/{repo}/keys"], + createDeployment: ["POST /repos/{owner}/{repo}/deployments"], + createDeploymentStatus: ["POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"], + createDispatchEvent: ["POST /repos/{owner}/{repo}/dispatches"], + createForAuthenticatedUser: ["POST /user/repos"], + createFork: ["POST /repos/{owner}/{repo}/forks"], + createInOrg: ["POST /orgs/{org}/repos"], + createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], + createPagesSite: ["POST /repos/{owner}/{repo}/pages", { + mediaType: { + previews: ["switcheroo"] + } + }], + createRelease: ["POST /repos/{owner}/{repo}/releases"], + createUsingTemplate: ["POST /repos/{template_owner}/{template_repo}/generate", { + mediaType: { + previews: ["baptiste"] + } + }], + createWebhook: ["POST /repos/{owner}/{repo}/hooks"], + declineInvitation: ["DELETE /user/repository_invitations/{invitation_id}"], + delete: ["DELETE /repos/{owner}/{repo}"], + deleteAccessRestrictions: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"], + deleteAdminBranchProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"], + deleteBranchProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection"], + deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"], + deleteCommitSignatureProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", { + mediaType: { + previews: ["zzzax"] + } + }], + deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"], + deleteDeployment: ["DELETE /repos/{owner}/{repo}/deployments/{deployment_id}"], + deleteFile: ["DELETE /repos/{owner}/{repo}/contents/{path}"], + deleteInvitation: ["DELETE /repos/{owner}/{repo}/invitations/{invitation_id}"], + deletePagesSite: ["DELETE /repos/{owner}/{repo}/pages", { + mediaType: { + previews: ["switcheroo"] + } + }], + deletePullRequestReviewProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"], + deleteRelease: ["DELETE /repos/{owner}/{repo}/releases/{release_id}"], + deleteReleaseAsset: ["DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}"], + deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], + disableAutomatedSecurityFixes: ["DELETE /repos/{owner}/{repo}/automated-security-fixes", { + mediaType: { + previews: ["london"] + } + }], + disableVulnerabilityAlerts: ["DELETE /repos/{owner}/{repo}/vulnerability-alerts", { + mediaType: { + previews: ["dorian"] + } + }], + downloadArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}", {}, { + renamed: ["repos", "downloadZipballArchive"] + }], + downloadTarballArchive: ["GET /repos/{owner}/{repo}/tarball/{ref}"], + downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"], + enableAutomatedSecurityFixes: ["PUT /repos/{owner}/{repo}/automated-security-fixes", { + mediaType: { + previews: ["london"] + } + }], + enableVulnerabilityAlerts: ["PUT /repos/{owner}/{repo}/vulnerability-alerts", { + mediaType: { + previews: ["dorian"] + } + }], + get: ["GET /repos/{owner}/{repo}"], + getAccessRestrictions: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"], + getAdminBranchProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"], + getAllStatusCheckContexts: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"], + getAllTopics: ["GET /repos/{owner}/{repo}/topics", { + mediaType: { + previews: ["mercy"] + } + }], + getAppsWithAccessToProtectedBranch: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"], + getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"], + getBranchProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection"], + getClones: ["GET /repos/{owner}/{repo}/traffic/clones"], + getCodeFrequencyStats: ["GET /repos/{owner}/{repo}/stats/code_frequency"], + getCollaboratorPermissionLevel: ["GET /repos/{owner}/{repo}/collaborators/{username}/permission"], + getCombinedStatusForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/status"], + getCommit: ["GET /repos/{owner}/{repo}/commits/{ref}"], + getCommitActivityStats: ["GET /repos/{owner}/{repo}/stats/commit_activity"], + getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"], + getCommitSignatureProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", { + mediaType: { + previews: ["zzzax"] + } + }], + getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"], + getContent: ["GET /repos/{owner}/{repo}/contents/{path}"], + getContributorsStats: ["GET /repos/{owner}/{repo}/stats/contributors"], + getDeployKey: ["GET /repos/{owner}/{repo}/keys/{key_id}"], + getDeployment: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}"], + getDeploymentStatus: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}"], + getLatestPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/latest"], + getLatestRelease: ["GET /repos/{owner}/{repo}/releases/latest"], + getPages: ["GET /repos/{owner}/{repo}/pages"], + getPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/{build_id}"], + getParticipationStats: ["GET /repos/{owner}/{repo}/stats/participation"], + getPullRequestReviewProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"], + getPunchCardStats: ["GET /repos/{owner}/{repo}/stats/punch_card"], + getReadme: ["GET /repos/{owner}/{repo}/readme"], + getRelease: ["GET /repos/{owner}/{repo}/releases/{release_id}"], + getReleaseAsset: ["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"], + getReleaseByTag: ["GET /repos/{owner}/{repo}/releases/tags/{tag}"], + getStatusChecksProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"], + getTeamsWithAccessToProtectedBranch: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"], + getTopPaths: ["GET /repos/{owner}/{repo}/traffic/popular/paths"], + getTopReferrers: ["GET /repos/{owner}/{repo}/traffic/popular/referrers"], + getUsersWithAccessToProtectedBranch: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"], + getViews: ["GET /repos/{owner}/{repo}/traffic/views"], + getWebhook: ["GET /repos/{owner}/{repo}/hooks/{hook_id}"], + getWebhookConfigForRepo: ["GET /repos/{owner}/{repo}/hooks/{hook_id}/config"], + listBranches: ["GET /repos/{owner}/{repo}/branches"], + listBranchesForHeadCommit: ["GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", { + mediaType: { + previews: ["groot"] + } + }], + listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"], + listCommentsForCommit: ["GET /repos/{owner}/{repo}/commits/{commit_sha}/comments"], + listCommitCommentsForRepo: ["GET /repos/{owner}/{repo}/comments"], + listCommitStatusesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/statuses"], + listCommits: ["GET /repos/{owner}/{repo}/commits"], + listContributors: ["GET /repos/{owner}/{repo}/contributors"], + listDeployKeys: ["GET /repos/{owner}/{repo}/keys"], + listDeploymentStatuses: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"], + listDeployments: ["GET /repos/{owner}/{repo}/deployments"], + listForAuthenticatedUser: ["GET /user/repos"], + listForOrg: ["GET /orgs/{org}/repos"], + listForUser: ["GET /users/{username}/repos"], + listForks: ["GET /repos/{owner}/{repo}/forks"], + listInvitations: ["GET /repos/{owner}/{repo}/invitations"], + listInvitationsForAuthenticatedUser: ["GET /user/repository_invitations"], + listLanguages: ["GET /repos/{owner}/{repo}/languages"], + listPagesBuilds: ["GET /repos/{owner}/{repo}/pages/builds"], + listPublic: ["GET /repositories"], + listPullRequestsAssociatedWithCommit: ["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", { + mediaType: { + previews: ["groot"] + } + }], + listReleaseAssets: ["GET /repos/{owner}/{repo}/releases/{release_id}/assets"], + listReleases: ["GET /repos/{owner}/{repo}/releases"], + listTags: ["GET /repos/{owner}/{repo}/tags"], + listTeams: ["GET /repos/{owner}/{repo}/teams"], + listWebhooks: ["GET /repos/{owner}/{repo}/hooks"], + merge: ["POST /repos/{owner}/{repo}/merges"], + pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"], + removeAppAccessRestrictions: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", {}, { + mapToData: "apps" + }], + removeCollaborator: ["DELETE /repos/{owner}/{repo}/collaborators/{username}"], + removeStatusCheckContexts: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", {}, { + mapToData: "contexts" + }], + removeStatusCheckProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"], + removeTeamAccessRestrictions: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", {}, { + mapToData: "teams" + }], + removeUserAccessRestrictions: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", {}, { + mapToData: "users" + }], + replaceAllTopics: ["PUT /repos/{owner}/{repo}/topics", { + mediaType: { + previews: ["mercy"] + } + }], + requestPagesBuild: ["POST /repos/{owner}/{repo}/pages/builds"], + setAdminBranchProtection: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"], + setAppAccessRestrictions: ["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", {}, { + mapToData: "apps" + }], + setStatusCheckContexts: ["PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", {}, { + mapToData: "contexts" + }], + setTeamAccessRestrictions: ["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", {}, { + mapToData: "teams" + }], + setUserAccessRestrictions: ["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", {}, { + mapToData: "users" + }], + testPushWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"], + transfer: ["POST /repos/{owner}/{repo}/transfer"], + update: ["PATCH /repos/{owner}/{repo}"], + updateBranchProtection: ["PUT /repos/{owner}/{repo}/branches/{branch}/protection"], + updateCommitComment: ["PATCH /repos/{owner}/{repo}/comments/{comment_id}"], + updateInformationAboutPagesSite: ["PUT /repos/{owner}/{repo}/pages"], + updateInvitation: ["PATCH /repos/{owner}/{repo}/invitations/{invitation_id}"], + updatePullRequestReviewProtection: ["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"], + updateRelease: ["PATCH /repos/{owner}/{repo}/releases/{release_id}"], + updateReleaseAsset: ["PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}"], + updateStatusCheckPotection: ["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", {}, { + renamed: ["repos", "updateStatusCheckProtection"] + }], + updateStatusCheckProtection: ["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"], + updateWebhook: ["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"], + updateWebhookConfigForRepo: ["PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config"], + uploadReleaseAsset: ["POST /repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", { + baseUrl: "https://uploads.github.com" + }] + }, + search: { + code: ["GET /search/code"], + commits: ["GET /search/commits", { + mediaType: { + previews: ["cloak"] + } + }], + issuesAndPullRequests: ["GET /search/issues"], + labels: ["GET /search/labels"], + repos: ["GET /search/repositories"], + topics: ["GET /search/topics", { + mediaType: { + previews: ["mercy"] + } + }], + users: ["GET /search/users"] + }, + secretScanning: { + getAlert: ["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"], + listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], + updateAlert: ["PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"] + }, + teams: { + addOrUpdateMembershipForUserInOrg: ["PUT /orgs/{org}/teams/{team_slug}/memberships/{username}"], + addOrUpdateProjectPermissionsInOrg: ["PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", { + mediaType: { + previews: ["inertia"] + } + }], + addOrUpdateRepoPermissionsInOrg: ["PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"], + checkPermissionsForProjectInOrg: ["GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", { + mediaType: { + previews: ["inertia"] + } + }], + checkPermissionsForRepoInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"], + create: ["POST /orgs/{org}/teams"], + createDiscussionCommentInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"], + createDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions"], + deleteDiscussionCommentInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"], + deleteDiscussionInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"], + deleteInOrg: ["DELETE /orgs/{org}/teams/{team_slug}"], + getByName: ["GET /orgs/{org}/teams/{team_slug}"], + getDiscussionCommentInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"], + getDiscussionInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"], + getMembershipForUserInOrg: ["GET /orgs/{org}/teams/{team_slug}/memberships/{username}"], + list: ["GET /orgs/{org}/teams"], + listChildInOrg: ["GET /orgs/{org}/teams/{team_slug}/teams"], + listDiscussionCommentsInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"], + listDiscussionsInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions"], + listForAuthenticatedUser: ["GET /user/teams"], + listMembersInOrg: ["GET /orgs/{org}/teams/{team_slug}/members"], + listPendingInvitationsInOrg: ["GET /orgs/{org}/teams/{team_slug}/invitations"], + listProjectsInOrg: ["GET /orgs/{org}/teams/{team_slug}/projects", { + mediaType: { + previews: ["inertia"] + } + }], + listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], + removeMembershipForUserInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}"], + removeProjectInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}"], + removeRepoInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"], + updateDiscussionCommentInOrg: ["PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"], + updateDiscussionInOrg: ["PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"], + updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"] + }, + users: { + addEmailForAuthenticated: ["POST /user/emails"], + block: ["PUT /user/blocks/{username}"], + checkBlocked: ["GET /user/blocks/{username}"], + checkFollowingForUser: ["GET /users/{username}/following/{target_user}"], + checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"], + createGpgKeyForAuthenticated: ["POST /user/gpg_keys"], + createPublicSshKeyForAuthenticated: ["POST /user/keys"], + deleteEmailForAuthenticated: ["DELETE /user/emails"], + deleteGpgKeyForAuthenticated: ["DELETE /user/gpg_keys/{gpg_key_id}"], + deletePublicSshKeyForAuthenticated: ["DELETE /user/keys/{key_id}"], + follow: ["PUT /user/following/{username}"], + getAuthenticated: ["GET /user"], + getByUsername: ["GET /users/{username}"], + getContextForUser: ["GET /users/{username}/hovercard"], + getGpgKeyForAuthenticated: ["GET /user/gpg_keys/{gpg_key_id}"], + getPublicSshKeyForAuthenticated: ["GET /user/keys/{key_id}"], + list: ["GET /users"], + listBlockedByAuthenticated: ["GET /user/blocks"], + listEmailsForAuthenticated: ["GET /user/emails"], + listFollowedByAuthenticated: ["GET /user/following"], + listFollowersForAuthenticatedUser: ["GET /user/followers"], + listFollowersForUser: ["GET /users/{username}/followers"], + listFollowingForUser: ["GET /users/{username}/following"], + listGpgKeysForAuthenticated: ["GET /user/gpg_keys"], + listGpgKeysForUser: ["GET /users/{username}/gpg_keys"], + listPublicEmailsForAuthenticated: ["GET /user/public_emails"], + listPublicKeysForUser: ["GET /users/{username}/keys"], + listPublicSshKeysForAuthenticated: ["GET /user/keys"], + setPrimaryEmailVisibilityForAuthenticated: ["PATCH /user/email/visibility"], + unblock: ["DELETE /user/blocks/{username}"], + unfollow: ["DELETE /user/following/{username}"], + updateAuthenticated: ["PATCH /user"] + } +}; + +const VERSION = "4.5.2"; + +function endpointsToMethods(octokit, endpointsMap) { + const newMethods = {}; + + for (const [scope, endpoints] of Object.entries(endpointsMap)) { + for (const [methodName, endpoint] of Object.entries(endpoints)) { + const [route, defaults, decorations] = endpoint; + const [method, url] = route.split(/ /); + const endpointDefaults = Object.assign({ + method, + url + }, defaults); + + if (!newMethods[scope]) { + newMethods[scope] = {}; + } + + const scopeMethods = newMethods[scope]; + + if (decorations) { + scopeMethods[methodName] = decorate(octokit, scope, methodName, endpointDefaults, decorations); + continue; + } + + scopeMethods[methodName] = octokit.request.defaults(endpointDefaults); + } + } + + return newMethods; +} + +function decorate(octokit, scope, methodName, defaults, decorations) { + const requestWithDefaults = octokit.request.defaults(defaults); + /* istanbul ignore next */ + + function withDecorations(...args) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + let options = requestWithDefaults.endpoint.merge(...args); // There are currently no other decorations than `.mapToData` + + if (decorations.mapToData) { + options = Object.assign({}, options, { + data: options[decorations.mapToData], + [decorations.mapToData]: undefined + }); + return requestWithDefaults(options); + } + + if (decorations.renamed) { + const [newScope, newMethodName] = decorations.renamed; + octokit.log.warn(`octokit.${scope}.${methodName}() has been renamed to octokit.${newScope}.${newMethodName}()`); + } + + if (decorations.deprecated) { + octokit.log.warn(decorations.deprecated); + } + + if (decorations.renamedParameters) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + const options = requestWithDefaults.endpoint.merge(...args); + + for (const [name, alias] of Object.entries(decorations.renamedParameters)) { + if (name in options) { + octokit.log.warn(`"${name}" parameter is deprecated for "octokit.${scope}.${methodName}()". Use "${alias}" instead`); + + if (!(alias in options)) { + options[alias] = options[name]; + } + + delete options[name]; + } + } + + return requestWithDefaults(options); + } // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + + + return requestWithDefaults(...args); + } + + return Object.assign(withDecorations, requestWithDefaults); +} + +/** + * This plugin is a 1:1 copy of internal @octokit/rest plugins. The primary + * goal is to rebuild @octokit/rest on top of @octokit/core. Once that is + * done, we will remove the registerEndpoints methods and return the methods + * directly as with the other plugins. At that point we will also remove the + * legacy workarounds and deprecations. + * + * See the plan at + * https://github.com/octokit/plugin-rest-endpoint-methods.js/pull/1 + */ + +function restEndpointMethods(octokit) { + return endpointsToMethods(octokit, Endpoints); +} +restEndpointMethods.VERSION = VERSION; + +exports.restEndpointMethods = restEndpointMethods; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js.map b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js.map new file mode 100644 index 0000000..55f66ec --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/generated/endpoints.js","../dist-src/version.js","../dist-src/endpoints-to-methods.js","../dist-src/index.js"],"sourcesContent":["const Endpoints = {\n actions: {\n addSelectedRepoToOrgSecret: [\n \"PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}\",\n ],\n cancelWorkflowRun: [\n \"POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel\",\n ],\n createOrUpdateOrgSecret: [\"PUT /orgs/{org}/actions/secrets/{secret_name}\"],\n createOrUpdateRepoSecret: [\n \"PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}\",\n ],\n createRegistrationTokenForOrg: [\n \"POST /orgs/{org}/actions/runners/registration-token\",\n ],\n createRegistrationTokenForRepo: [\n \"POST /repos/{owner}/{repo}/actions/runners/registration-token\",\n ],\n createRemoveTokenForOrg: [\"POST /orgs/{org}/actions/runners/remove-token\"],\n createRemoveTokenForRepo: [\n \"POST /repos/{owner}/{repo}/actions/runners/remove-token\",\n ],\n createWorkflowDispatch: [\n \"POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches\",\n ],\n deleteArtifact: [\n \"DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}\",\n ],\n deleteOrgSecret: [\"DELETE /orgs/{org}/actions/secrets/{secret_name}\"],\n deleteRepoSecret: [\n \"DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}\",\n ],\n deleteSelfHostedRunnerFromOrg: [\n \"DELETE /orgs/{org}/actions/runners/{runner_id}\",\n ],\n deleteSelfHostedRunnerFromRepo: [\n \"DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}\",\n ],\n deleteWorkflowRun: [\"DELETE /repos/{owner}/{repo}/actions/runs/{run_id}\"],\n deleteWorkflowRunLogs: [\n \"DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs\",\n ],\n disableSelectedRepositoryGithubActionsOrganization: [\n \"DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}\",\n ],\n disableWorkflow: [\n \"PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable\",\n ],\n downloadArtifact: [\n \"GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}\",\n ],\n downloadJobLogsForWorkflowRun: [\n \"GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs\",\n ],\n downloadWorkflowRunLogs: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs\",\n ],\n enableSelectedRepositoryGithubActionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions/repositories/{repository_id}\",\n ],\n enableWorkflow: [\n \"PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable\",\n ],\n getAllowedActionsOrganization: [\n \"GET /orgs/{org}/actions/permissions/selected-actions\",\n ],\n getAllowedActionsRepository: [\n \"GET /repos/{owner}/{repo}/actions/permissions/selected-actions\",\n ],\n getArtifact: [\"GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}\"],\n getGithubActionsPermissionsOrganization: [\n \"GET /orgs/{org}/actions/permissions\",\n ],\n getGithubActionsPermissionsRepository: [\n \"GET /repos/{owner}/{repo}/actions/permissions\",\n ],\n getJobForWorkflowRun: [\"GET /repos/{owner}/{repo}/actions/jobs/{job_id}\"],\n getOrgPublicKey: [\"GET /orgs/{org}/actions/secrets/public-key\"],\n getOrgSecret: [\"GET /orgs/{org}/actions/secrets/{secret_name}\"],\n getRepoPermissions: [\n \"GET /repos/{owner}/{repo}/actions/permissions\",\n {},\n { renamed: [\"actions\", \"getGithubActionsPermissionsRepository\"] },\n ],\n getRepoPublicKey: [\"GET /repos/{owner}/{repo}/actions/secrets/public-key\"],\n getRepoSecret: [\"GET /repos/{owner}/{repo}/actions/secrets/{secret_name}\"],\n getSelfHostedRunnerForOrg: [\"GET /orgs/{org}/actions/runners/{runner_id}\"],\n getSelfHostedRunnerForRepo: [\n \"GET /repos/{owner}/{repo}/actions/runners/{runner_id}\",\n ],\n getWorkflow: [\"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}\"],\n getWorkflowRun: [\"GET /repos/{owner}/{repo}/actions/runs/{run_id}\"],\n getWorkflowRunUsage: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing\",\n ],\n getWorkflowUsage: [\n \"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing\",\n ],\n listArtifactsForRepo: [\"GET /repos/{owner}/{repo}/actions/artifacts\"],\n listJobsForWorkflowRun: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs\",\n ],\n listOrgSecrets: [\"GET /orgs/{org}/actions/secrets\"],\n listRepoSecrets: [\"GET /repos/{owner}/{repo}/actions/secrets\"],\n listRepoWorkflows: [\"GET /repos/{owner}/{repo}/actions/workflows\"],\n listRunnerApplicationsForOrg: [\"GET /orgs/{org}/actions/runners/downloads\"],\n listRunnerApplicationsForRepo: [\n \"GET /repos/{owner}/{repo}/actions/runners/downloads\",\n ],\n listSelectedReposForOrgSecret: [\n \"GET /orgs/{org}/actions/secrets/{secret_name}/repositories\",\n ],\n listSelectedRepositoriesEnabledGithubActionsOrganization: [\n \"GET /orgs/{org}/actions/permissions/repositories\",\n ],\n listSelfHostedRunnersForOrg: [\"GET /orgs/{org}/actions/runners\"],\n listSelfHostedRunnersForRepo: [\"GET /repos/{owner}/{repo}/actions/runners\"],\n listWorkflowRunArtifacts: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts\",\n ],\n listWorkflowRuns: [\n \"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs\",\n ],\n listWorkflowRunsForRepo: [\"GET /repos/{owner}/{repo}/actions/runs\"],\n reRunWorkflow: [\"POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun\"],\n removeSelectedRepoFromOrgSecret: [\n \"DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}\",\n ],\n setAllowedActionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions/selected-actions\",\n ],\n setAllowedActionsRepository: [\n \"PUT /repos/{owner}/{repo}/actions/permissions/selected-actions\",\n ],\n setGithubActionsPermissionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions\",\n ],\n setGithubActionsPermissionsRepository: [\n \"PUT /repos/{owner}/{repo}/actions/permissions\",\n ],\n setSelectedReposForOrgSecret: [\n \"PUT /orgs/{org}/actions/secrets/{secret_name}/repositories\",\n ],\n setSelectedRepositoriesEnabledGithubActionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions/repositories\",\n ],\n },\n activity: {\n checkRepoIsStarredByAuthenticatedUser: [\"GET /user/starred/{owner}/{repo}\"],\n deleteRepoSubscription: [\"DELETE /repos/{owner}/{repo}/subscription\"],\n deleteThreadSubscription: [\n \"DELETE /notifications/threads/{thread_id}/subscription\",\n ],\n getFeeds: [\"GET /feeds\"],\n getRepoSubscription: [\"GET /repos/{owner}/{repo}/subscription\"],\n getThread: [\"GET /notifications/threads/{thread_id}\"],\n getThreadSubscriptionForAuthenticatedUser: [\n \"GET /notifications/threads/{thread_id}/subscription\",\n ],\n listEventsForAuthenticatedUser: [\"GET /users/{username}/events\"],\n listNotificationsForAuthenticatedUser: [\"GET /notifications\"],\n listOrgEventsForAuthenticatedUser: [\n \"GET /users/{username}/events/orgs/{org}\",\n ],\n listPublicEvents: [\"GET /events\"],\n listPublicEventsForRepoNetwork: [\"GET /networks/{owner}/{repo}/events\"],\n listPublicEventsForUser: [\"GET /users/{username}/events/public\"],\n listPublicOrgEvents: [\"GET /orgs/{org}/events\"],\n listReceivedEventsForUser: [\"GET /users/{username}/received_events\"],\n listReceivedPublicEventsForUser: [\n \"GET /users/{username}/received_events/public\",\n ],\n listRepoEvents: [\"GET /repos/{owner}/{repo}/events\"],\n listRepoNotificationsForAuthenticatedUser: [\n \"GET /repos/{owner}/{repo}/notifications\",\n ],\n listReposStarredByAuthenticatedUser: [\"GET /user/starred\"],\n listReposStarredByUser: [\"GET /users/{username}/starred\"],\n listReposWatchedByUser: [\"GET /users/{username}/subscriptions\"],\n listStargazersForRepo: [\"GET /repos/{owner}/{repo}/stargazers\"],\n listWatchedReposForAuthenticatedUser: [\"GET /user/subscriptions\"],\n listWatchersForRepo: [\"GET /repos/{owner}/{repo}/subscribers\"],\n markNotificationsAsRead: [\"PUT /notifications\"],\n markRepoNotificationsAsRead: [\"PUT /repos/{owner}/{repo}/notifications\"],\n markThreadAsRead: [\"PATCH /notifications/threads/{thread_id}\"],\n setRepoSubscription: [\"PUT /repos/{owner}/{repo}/subscription\"],\n setThreadSubscription: [\n \"PUT /notifications/threads/{thread_id}/subscription\",\n ],\n starRepoForAuthenticatedUser: [\"PUT /user/starred/{owner}/{repo}\"],\n unstarRepoForAuthenticatedUser: [\"DELETE /user/starred/{owner}/{repo}\"],\n },\n apps: {\n addRepoToInstallation: [\n \"PUT /user/installations/{installation_id}/repositories/{repository_id}\",\n ],\n checkToken: [\"POST /applications/{client_id}/token\"],\n createContentAttachment: [\n \"POST /content_references/{content_reference_id}/attachments\",\n { mediaType: { previews: [\"corsair\"] } },\n ],\n createFromManifest: [\"POST /app-manifests/{code}/conversions\"],\n createInstallationAccessToken: [\n \"POST /app/installations/{installation_id}/access_tokens\",\n ],\n deleteAuthorization: [\"DELETE /applications/{client_id}/grant\"],\n deleteInstallation: [\"DELETE /app/installations/{installation_id}\"],\n deleteToken: [\"DELETE /applications/{client_id}/token\"],\n getAuthenticated: [\"GET /app\"],\n getBySlug: [\"GET /apps/{app_slug}\"],\n getInstallation: [\"GET /app/installations/{installation_id}\"],\n getOrgInstallation: [\"GET /orgs/{org}/installation\"],\n getRepoInstallation: [\"GET /repos/{owner}/{repo}/installation\"],\n getSubscriptionPlanForAccount: [\n \"GET /marketplace_listing/accounts/{account_id}\",\n ],\n getSubscriptionPlanForAccountStubbed: [\n \"GET /marketplace_listing/stubbed/accounts/{account_id}\",\n ],\n getUserInstallation: [\"GET /users/{username}/installation\"],\n getWebhookConfigForApp: [\"GET /app/hook/config\"],\n listAccountsForPlan: [\"GET /marketplace_listing/plans/{plan_id}/accounts\"],\n listAccountsForPlanStubbed: [\n \"GET /marketplace_listing/stubbed/plans/{plan_id}/accounts\",\n ],\n listInstallationReposForAuthenticatedUser: [\n \"GET /user/installations/{installation_id}/repositories\",\n ],\n listInstallations: [\"GET /app/installations\"],\n listInstallationsForAuthenticatedUser: [\"GET /user/installations\"],\n listPlans: [\"GET /marketplace_listing/plans\"],\n listPlansStubbed: [\"GET /marketplace_listing/stubbed/plans\"],\n listReposAccessibleToInstallation: [\"GET /installation/repositories\"],\n listSubscriptionsForAuthenticatedUser: [\"GET /user/marketplace_purchases\"],\n listSubscriptionsForAuthenticatedUserStubbed: [\n \"GET /user/marketplace_purchases/stubbed\",\n ],\n removeRepoFromInstallation: [\n \"DELETE /user/installations/{installation_id}/repositories/{repository_id}\",\n ],\n resetToken: [\"PATCH /applications/{client_id}/token\"],\n revokeInstallationAccessToken: [\"DELETE /installation/token\"],\n scopeToken: [\"POST /applications/{client_id}/token/scoped\"],\n suspendInstallation: [\"PUT /app/installations/{installation_id}/suspended\"],\n unsuspendInstallation: [\n \"DELETE /app/installations/{installation_id}/suspended\",\n ],\n updateWebhookConfigForApp: [\"PATCH /app/hook/config\"],\n },\n billing: {\n getGithubActionsBillingOrg: [\"GET /orgs/{org}/settings/billing/actions\"],\n getGithubActionsBillingUser: [\n \"GET /users/{username}/settings/billing/actions\",\n ],\n getGithubPackagesBillingOrg: [\"GET /orgs/{org}/settings/billing/packages\"],\n getGithubPackagesBillingUser: [\n \"GET /users/{username}/settings/billing/packages\",\n ],\n getSharedStorageBillingOrg: [\n \"GET /orgs/{org}/settings/billing/shared-storage\",\n ],\n getSharedStorageBillingUser: [\n \"GET /users/{username}/settings/billing/shared-storage\",\n ],\n },\n checks: {\n create: [\"POST /repos/{owner}/{repo}/check-runs\"],\n createSuite: [\"POST /repos/{owner}/{repo}/check-suites\"],\n get: [\"GET /repos/{owner}/{repo}/check-runs/{check_run_id}\"],\n getSuite: [\"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}\"],\n listAnnotations: [\n \"GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations\",\n ],\n listForRef: [\"GET /repos/{owner}/{repo}/commits/{ref}/check-runs\"],\n listForSuite: [\n \"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs\",\n ],\n listSuitesForRef: [\"GET /repos/{owner}/{repo}/commits/{ref}/check-suites\"],\n rerequestSuite: [\n \"POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest\",\n ],\n setSuitesPreferences: [\n \"PATCH /repos/{owner}/{repo}/check-suites/preferences\",\n ],\n update: [\"PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}\"],\n },\n codeScanning: {\n getAlert: [\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}\",\n {},\n { renamedParameters: { alert_id: \"alert_number\" } },\n ],\n listAlertsForRepo: [\"GET /repos/{owner}/{repo}/code-scanning/alerts\"],\n listRecentAnalyses: [\"GET /repos/{owner}/{repo}/code-scanning/analyses\"],\n updateAlert: [\n \"PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}\",\n ],\n uploadSarif: [\"POST /repos/{owner}/{repo}/code-scanning/sarifs\"],\n },\n codesOfConduct: {\n getAllCodesOfConduct: [\n \"GET /codes_of_conduct\",\n { mediaType: { previews: [\"scarlet-witch\"] } },\n ],\n getConductCode: [\n \"GET /codes_of_conduct/{key}\",\n { mediaType: { previews: [\"scarlet-witch\"] } },\n ],\n getForRepo: [\n \"GET /repos/{owner}/{repo}/community/code_of_conduct\",\n { mediaType: { previews: [\"scarlet-witch\"] } },\n ],\n },\n emojis: { get: [\"GET /emojis\"] },\n enterpriseAdmin: {\n disableSelectedOrganizationGithubActionsEnterprise: [\n \"DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}\",\n ],\n enableSelectedOrganizationGithubActionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}\",\n ],\n getAllowedActionsEnterprise: [\n \"GET /enterprises/{enterprise}/actions/permissions/selected-actions\",\n ],\n getGithubActionsPermissionsEnterprise: [\n \"GET /enterprises/{enterprise}/actions/permissions\",\n ],\n listSelectedOrganizationsEnabledGithubActionsEnterprise: [\n \"GET /enterprises/{enterprise}/actions/permissions/organizations\",\n ],\n setAllowedActionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions/selected-actions\",\n ],\n setGithubActionsPermissionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions\",\n ],\n setSelectedOrganizationsEnabledGithubActionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions/organizations\",\n ],\n },\n gists: {\n checkIsStarred: [\"GET /gists/{gist_id}/star\"],\n create: [\"POST /gists\"],\n createComment: [\"POST /gists/{gist_id}/comments\"],\n delete: [\"DELETE /gists/{gist_id}\"],\n deleteComment: [\"DELETE /gists/{gist_id}/comments/{comment_id}\"],\n fork: [\"POST /gists/{gist_id}/forks\"],\n get: [\"GET /gists/{gist_id}\"],\n getComment: [\"GET /gists/{gist_id}/comments/{comment_id}\"],\n getRevision: [\"GET /gists/{gist_id}/{sha}\"],\n list: [\"GET /gists\"],\n listComments: [\"GET /gists/{gist_id}/comments\"],\n listCommits: [\"GET /gists/{gist_id}/commits\"],\n listForUser: [\"GET /users/{username}/gists\"],\n listForks: [\"GET /gists/{gist_id}/forks\"],\n listPublic: [\"GET /gists/public\"],\n listStarred: [\"GET /gists/starred\"],\n star: [\"PUT /gists/{gist_id}/star\"],\n unstar: [\"DELETE /gists/{gist_id}/star\"],\n update: [\"PATCH /gists/{gist_id}\"],\n updateComment: [\"PATCH /gists/{gist_id}/comments/{comment_id}\"],\n },\n git: {\n createBlob: [\"POST /repos/{owner}/{repo}/git/blobs\"],\n createCommit: [\"POST /repos/{owner}/{repo}/git/commits\"],\n createRef: [\"POST /repos/{owner}/{repo}/git/refs\"],\n createTag: [\"POST /repos/{owner}/{repo}/git/tags\"],\n createTree: [\"POST /repos/{owner}/{repo}/git/trees\"],\n deleteRef: [\"DELETE /repos/{owner}/{repo}/git/refs/{ref}\"],\n getBlob: [\"GET /repos/{owner}/{repo}/git/blobs/{file_sha}\"],\n getCommit: [\"GET /repos/{owner}/{repo}/git/commits/{commit_sha}\"],\n getRef: [\"GET /repos/{owner}/{repo}/git/ref/{ref}\"],\n getTag: [\"GET /repos/{owner}/{repo}/git/tags/{tag_sha}\"],\n getTree: [\"GET /repos/{owner}/{repo}/git/trees/{tree_sha}\"],\n listMatchingRefs: [\"GET /repos/{owner}/{repo}/git/matching-refs/{ref}\"],\n updateRef: [\"PATCH /repos/{owner}/{repo}/git/refs/{ref}\"],\n },\n gitignore: {\n getAllTemplates: [\"GET /gitignore/templates\"],\n getTemplate: [\"GET /gitignore/templates/{name}\"],\n },\n interactions: {\n getRestrictionsForOrg: [\"GET /orgs/{org}/interaction-limits\"],\n getRestrictionsForRepo: [\"GET /repos/{owner}/{repo}/interaction-limits\"],\n getRestrictionsForYourPublicRepos: [\"GET /user/interaction-limits\"],\n removeRestrictionsForOrg: [\"DELETE /orgs/{org}/interaction-limits\"],\n removeRestrictionsForRepo: [\n \"DELETE /repos/{owner}/{repo}/interaction-limits\",\n ],\n removeRestrictionsForYourPublicRepos: [\"DELETE /user/interaction-limits\"],\n setRestrictionsForOrg: [\"PUT /orgs/{org}/interaction-limits\"],\n setRestrictionsForRepo: [\"PUT /repos/{owner}/{repo}/interaction-limits\"],\n setRestrictionsForYourPublicRepos: [\"PUT /user/interaction-limits\"],\n },\n issues: {\n addAssignees: [\n \"POST /repos/{owner}/{repo}/issues/{issue_number}/assignees\",\n ],\n addLabels: [\"POST /repos/{owner}/{repo}/issues/{issue_number}/labels\"],\n checkUserCanBeAssigned: [\"GET /repos/{owner}/{repo}/assignees/{assignee}\"],\n create: [\"POST /repos/{owner}/{repo}/issues\"],\n createComment: [\n \"POST /repos/{owner}/{repo}/issues/{issue_number}/comments\",\n ],\n createLabel: [\"POST /repos/{owner}/{repo}/labels\"],\n createMilestone: [\"POST /repos/{owner}/{repo}/milestones\"],\n deleteComment: [\n \"DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}\",\n ],\n deleteLabel: [\"DELETE /repos/{owner}/{repo}/labels/{name}\"],\n deleteMilestone: [\n \"DELETE /repos/{owner}/{repo}/milestones/{milestone_number}\",\n ],\n get: [\"GET /repos/{owner}/{repo}/issues/{issue_number}\"],\n getComment: [\"GET /repos/{owner}/{repo}/issues/comments/{comment_id}\"],\n getEvent: [\"GET /repos/{owner}/{repo}/issues/events/{event_id}\"],\n getLabel: [\"GET /repos/{owner}/{repo}/labels/{name}\"],\n getMilestone: [\"GET /repos/{owner}/{repo}/milestones/{milestone_number}\"],\n list: [\"GET /issues\"],\n listAssignees: [\"GET /repos/{owner}/{repo}/assignees\"],\n listComments: [\"GET /repos/{owner}/{repo}/issues/{issue_number}/comments\"],\n listCommentsForRepo: [\"GET /repos/{owner}/{repo}/issues/comments\"],\n listEvents: [\"GET /repos/{owner}/{repo}/issues/{issue_number}/events\"],\n listEventsForRepo: [\"GET /repos/{owner}/{repo}/issues/events\"],\n listEventsForTimeline: [\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/timeline\",\n { mediaType: { previews: [\"mockingbird\"] } },\n ],\n listForAuthenticatedUser: [\"GET /user/issues\"],\n listForOrg: [\"GET /orgs/{org}/issues\"],\n listForRepo: [\"GET /repos/{owner}/{repo}/issues\"],\n listLabelsForMilestone: [\n \"GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels\",\n ],\n listLabelsForRepo: [\"GET /repos/{owner}/{repo}/labels\"],\n listLabelsOnIssue: [\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/labels\",\n ],\n listMilestones: [\"GET /repos/{owner}/{repo}/milestones\"],\n lock: [\"PUT /repos/{owner}/{repo}/issues/{issue_number}/lock\"],\n removeAllLabels: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels\",\n ],\n removeAssignees: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees\",\n ],\n removeLabel: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}\",\n ],\n setLabels: [\"PUT /repos/{owner}/{repo}/issues/{issue_number}/labels\"],\n unlock: [\"DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock\"],\n update: [\"PATCH /repos/{owner}/{repo}/issues/{issue_number}\"],\n updateComment: [\"PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}\"],\n updateLabel: [\"PATCH /repos/{owner}/{repo}/labels/{name}\"],\n updateMilestone: [\n \"PATCH /repos/{owner}/{repo}/milestones/{milestone_number}\",\n ],\n },\n licenses: {\n get: [\"GET /licenses/{license}\"],\n getAllCommonlyUsed: [\"GET /licenses\"],\n getForRepo: [\"GET /repos/{owner}/{repo}/license\"],\n },\n markdown: {\n render: [\"POST /markdown\"],\n renderRaw: [\n \"POST /markdown/raw\",\n { headers: { \"content-type\": \"text/plain; charset=utf-8\" } },\n ],\n },\n meta: {\n get: [\"GET /meta\"],\n getOctocat: [\"GET /octocat\"],\n getZen: [\"GET /zen\"],\n root: [\"GET /\"],\n },\n migrations: {\n cancelImport: [\"DELETE /repos/{owner}/{repo}/import\"],\n deleteArchiveForAuthenticatedUser: [\n \"DELETE /user/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n deleteArchiveForOrg: [\n \"DELETE /orgs/{org}/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n downloadArchiveForOrg: [\n \"GET /orgs/{org}/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n getArchiveForAuthenticatedUser: [\n \"GET /user/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n getCommitAuthors: [\"GET /repos/{owner}/{repo}/import/authors\"],\n getImportStatus: [\"GET /repos/{owner}/{repo}/import\"],\n getLargeFiles: [\"GET /repos/{owner}/{repo}/import/large_files\"],\n getStatusForAuthenticatedUser: [\n \"GET /user/migrations/{migration_id}\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n getStatusForOrg: [\n \"GET /orgs/{org}/migrations/{migration_id}\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listForAuthenticatedUser: [\n \"GET /user/migrations\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listForOrg: [\n \"GET /orgs/{org}/migrations\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listReposForOrg: [\n \"GET /orgs/{org}/migrations/{migration_id}/repositories\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listReposForUser: [\n \"GET /user/migrations/{migration_id}/repositories\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n mapCommitAuthor: [\"PATCH /repos/{owner}/{repo}/import/authors/{author_id}\"],\n setLfsPreference: [\"PATCH /repos/{owner}/{repo}/import/lfs\"],\n startForAuthenticatedUser: [\"POST /user/migrations\"],\n startForOrg: [\"POST /orgs/{org}/migrations\"],\n startImport: [\"PUT /repos/{owner}/{repo}/import\"],\n unlockRepoForAuthenticatedUser: [\n \"DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n unlockRepoForOrg: [\n \"DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n updateImport: [\"PATCH /repos/{owner}/{repo}/import\"],\n },\n orgs: {\n blockUser: [\"PUT /orgs/{org}/blocks/{username}\"],\n checkBlockedUser: [\"GET /orgs/{org}/blocks/{username}\"],\n checkMembershipForUser: [\"GET /orgs/{org}/members/{username}\"],\n checkPublicMembershipForUser: [\"GET /orgs/{org}/public_members/{username}\"],\n convertMemberToOutsideCollaborator: [\n \"PUT /orgs/{org}/outside_collaborators/{username}\",\n ],\n createInvitation: [\"POST /orgs/{org}/invitations\"],\n createWebhook: [\"POST /orgs/{org}/hooks\"],\n deleteWebhook: [\"DELETE /orgs/{org}/hooks/{hook_id}\"],\n get: [\"GET /orgs/{org}\"],\n getMembershipForAuthenticatedUser: [\"GET /user/memberships/orgs/{org}\"],\n getMembershipForUser: [\"GET /orgs/{org}/memberships/{username}\"],\n getWebhook: [\"GET /orgs/{org}/hooks/{hook_id}\"],\n getWebhookConfigForOrg: [\"GET /orgs/{org}/hooks/{hook_id}/config\"],\n list: [\"GET /organizations\"],\n listAppInstallations: [\"GET /orgs/{org}/installations\"],\n listBlockedUsers: [\"GET /orgs/{org}/blocks\"],\n listForAuthenticatedUser: [\"GET /user/orgs\"],\n listForUser: [\"GET /users/{username}/orgs\"],\n listInvitationTeams: [\"GET /orgs/{org}/invitations/{invitation_id}/teams\"],\n listMembers: [\"GET /orgs/{org}/members\"],\n listMembershipsForAuthenticatedUser: [\"GET /user/memberships/orgs\"],\n listOutsideCollaborators: [\"GET /orgs/{org}/outside_collaborators\"],\n listPendingInvitations: [\"GET /orgs/{org}/invitations\"],\n listPublicMembers: [\"GET /orgs/{org}/public_members\"],\n listWebhooks: [\"GET /orgs/{org}/hooks\"],\n pingWebhook: [\"POST /orgs/{org}/hooks/{hook_id}/pings\"],\n removeMember: [\"DELETE /orgs/{org}/members/{username}\"],\n removeMembershipForUser: [\"DELETE /orgs/{org}/memberships/{username}\"],\n removeOutsideCollaborator: [\n \"DELETE /orgs/{org}/outside_collaborators/{username}\",\n ],\n removePublicMembershipForAuthenticatedUser: [\n \"DELETE /orgs/{org}/public_members/{username}\",\n ],\n setMembershipForUser: [\"PUT /orgs/{org}/memberships/{username}\"],\n setPublicMembershipForAuthenticatedUser: [\n \"PUT /orgs/{org}/public_members/{username}\",\n ],\n unblockUser: [\"DELETE /orgs/{org}/blocks/{username}\"],\n update: [\"PATCH /orgs/{org}\"],\n updateMembershipForAuthenticatedUser: [\n \"PATCH /user/memberships/orgs/{org}\",\n ],\n updateWebhook: [\"PATCH /orgs/{org}/hooks/{hook_id}\"],\n updateWebhookConfigForOrg: [\"PATCH /orgs/{org}/hooks/{hook_id}/config\"],\n },\n projects: {\n addCollaborator: [\n \"PUT /projects/{project_id}/collaborators/{username}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createCard: [\n \"POST /projects/columns/{column_id}/cards\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createColumn: [\n \"POST /projects/{project_id}/columns\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createForAuthenticatedUser: [\n \"POST /user/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createForOrg: [\n \"POST /orgs/{org}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createForRepo: [\n \"POST /repos/{owner}/{repo}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n delete: [\n \"DELETE /projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n deleteCard: [\n \"DELETE /projects/columns/cards/{card_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n deleteColumn: [\n \"DELETE /projects/columns/{column_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n get: [\n \"GET /projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n getCard: [\n \"GET /projects/columns/cards/{card_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n getColumn: [\n \"GET /projects/columns/{column_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n getPermissionForUser: [\n \"GET /projects/{project_id}/collaborators/{username}/permission\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listCards: [\n \"GET /projects/columns/{column_id}/cards\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listCollaborators: [\n \"GET /projects/{project_id}/collaborators\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listColumns: [\n \"GET /projects/{project_id}/columns\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listForOrg: [\n \"GET /orgs/{org}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listForRepo: [\n \"GET /repos/{owner}/{repo}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listForUser: [\n \"GET /users/{username}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n moveCard: [\n \"POST /projects/columns/cards/{card_id}/moves\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n moveColumn: [\n \"POST /projects/columns/{column_id}/moves\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n removeCollaborator: [\n \"DELETE /projects/{project_id}/collaborators/{username}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n update: [\n \"PATCH /projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n updateCard: [\n \"PATCH /projects/columns/cards/{card_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n updateColumn: [\n \"PATCH /projects/columns/{column_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n },\n pulls: {\n checkIfMerged: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/merge\"],\n create: [\"POST /repos/{owner}/{repo}/pulls\"],\n createReplyForReviewComment: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies\",\n ],\n createReview: [\"POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews\"],\n createReviewComment: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/comments\",\n ],\n deletePendingReview: [\n \"DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}\",\n ],\n deleteReviewComment: [\n \"DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}\",\n ],\n dismissReview: [\n \"PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals\",\n ],\n get: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}\"],\n getReview: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}\",\n ],\n getReviewComment: [\"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}\"],\n list: [\"GET /repos/{owner}/{repo}/pulls\"],\n listCommentsForReview: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments\",\n ],\n listCommits: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/commits\"],\n listFiles: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/files\"],\n listRequestedReviewers: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n ],\n listReviewComments: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/comments\",\n ],\n listReviewCommentsForRepo: [\"GET /repos/{owner}/{repo}/pulls/comments\"],\n listReviews: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews\"],\n merge: [\"PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge\"],\n removeRequestedReviewers: [\n \"DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n ],\n requestReviewers: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n ],\n submitReview: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events\",\n ],\n update: [\"PATCH /repos/{owner}/{repo}/pulls/{pull_number}\"],\n updateBranch: [\n \"PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch\",\n { mediaType: { previews: [\"lydian\"] } },\n ],\n updateReview: [\n \"PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}\",\n ],\n updateReviewComment: [\n \"PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}\",\n ],\n },\n rateLimit: { get: [\"GET /rate_limit\"] },\n reactions: {\n createForCommitComment: [\n \"POST /repos/{owner}/{repo}/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForIssue: [\n \"POST /repos/{owner}/{repo}/issues/{issue_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForIssueComment: [\n \"POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForPullRequestReviewComment: [\n \"POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForTeamDiscussionCommentInOrg: [\n \"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForTeamDiscussionInOrg: [\n \"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForCommitComment: [\n \"DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForIssue: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForIssueComment: [\n \"DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForPullRequestComment: [\n \"DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForTeamDiscussion: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForTeamDiscussionComment: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteLegacy: [\n \"DELETE /reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n {\n deprecated: \"octokit.reactions.deleteLegacy() is deprecated, see https://docs.github.com/v3/reactions/#delete-a-reaction-legacy\",\n },\n ],\n listForCommitComment: [\n \"GET /repos/{owner}/{repo}/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForIssue: [\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForIssueComment: [\n \"GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForPullRequestReviewComment: [\n \"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForTeamDiscussionCommentInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForTeamDiscussionInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n },\n repos: {\n acceptInvitation: [\"PATCH /user/repository_invitations/{invitation_id}\"],\n addAppAccessRestrictions: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n {},\n { mapToData: \"apps\" },\n ],\n addCollaborator: [\"PUT /repos/{owner}/{repo}/collaborators/{username}\"],\n addStatusCheckContexts: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n {},\n { mapToData: \"contexts\" },\n ],\n addTeamAccessRestrictions: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n {},\n { mapToData: \"teams\" },\n ],\n addUserAccessRestrictions: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n {},\n { mapToData: \"users\" },\n ],\n checkCollaborator: [\"GET /repos/{owner}/{repo}/collaborators/{username}\"],\n checkVulnerabilityAlerts: [\n \"GET /repos/{owner}/{repo}/vulnerability-alerts\",\n { mediaType: { previews: [\"dorian\"] } },\n ],\n compareCommits: [\"GET /repos/{owner}/{repo}/compare/{base}...{head}\"],\n createCommitComment: [\n \"POST /repos/{owner}/{repo}/commits/{commit_sha}/comments\",\n ],\n createCommitSignatureProtection: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures\",\n { mediaType: { previews: [\"zzzax\"] } },\n ],\n createCommitStatus: [\"POST /repos/{owner}/{repo}/statuses/{sha}\"],\n createDeployKey: [\"POST /repos/{owner}/{repo}/keys\"],\n createDeployment: [\"POST /repos/{owner}/{repo}/deployments\"],\n createDeploymentStatus: [\n \"POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses\",\n ],\n createDispatchEvent: [\"POST /repos/{owner}/{repo}/dispatches\"],\n createForAuthenticatedUser: [\"POST /user/repos\"],\n createFork: [\"POST /repos/{owner}/{repo}/forks\"],\n createInOrg: [\"POST /orgs/{org}/repos\"],\n createOrUpdateFileContents: [\"PUT /repos/{owner}/{repo}/contents/{path}\"],\n createPagesSite: [\n \"POST /repos/{owner}/{repo}/pages\",\n { mediaType: { previews: [\"switcheroo\"] } },\n ],\n createRelease: [\"POST /repos/{owner}/{repo}/releases\"],\n createUsingTemplate: [\n \"POST /repos/{template_owner}/{template_repo}/generate\",\n { mediaType: { previews: [\"baptiste\"] } },\n ],\n createWebhook: [\"POST /repos/{owner}/{repo}/hooks\"],\n declineInvitation: [\"DELETE /user/repository_invitations/{invitation_id}\"],\n delete: [\"DELETE /repos/{owner}/{repo}\"],\n deleteAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions\",\n ],\n deleteAdminBranchProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins\",\n ],\n deleteBranchProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection\",\n ],\n deleteCommitComment: [\"DELETE /repos/{owner}/{repo}/comments/{comment_id}\"],\n deleteCommitSignatureProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures\",\n { mediaType: { previews: [\"zzzax\"] } },\n ],\n deleteDeployKey: [\"DELETE /repos/{owner}/{repo}/keys/{key_id}\"],\n deleteDeployment: [\n \"DELETE /repos/{owner}/{repo}/deployments/{deployment_id}\",\n ],\n deleteFile: [\"DELETE /repos/{owner}/{repo}/contents/{path}\"],\n deleteInvitation: [\n \"DELETE /repos/{owner}/{repo}/invitations/{invitation_id}\",\n ],\n deletePagesSite: [\n \"DELETE /repos/{owner}/{repo}/pages\",\n { mediaType: { previews: [\"switcheroo\"] } },\n ],\n deletePullRequestReviewProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews\",\n ],\n deleteRelease: [\"DELETE /repos/{owner}/{repo}/releases/{release_id}\"],\n deleteReleaseAsset: [\n \"DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}\",\n ],\n deleteWebhook: [\"DELETE /repos/{owner}/{repo}/hooks/{hook_id}\"],\n disableAutomatedSecurityFixes: [\n \"DELETE /repos/{owner}/{repo}/automated-security-fixes\",\n { mediaType: { previews: [\"london\"] } },\n ],\n disableVulnerabilityAlerts: [\n \"DELETE /repos/{owner}/{repo}/vulnerability-alerts\",\n { mediaType: { previews: [\"dorian\"] } },\n ],\n downloadArchive: [\n \"GET /repos/{owner}/{repo}/zipball/{ref}\",\n {},\n { renamed: [\"repos\", \"downloadZipballArchive\"] },\n ],\n downloadTarballArchive: [\"GET /repos/{owner}/{repo}/tarball/{ref}\"],\n downloadZipballArchive: [\"GET /repos/{owner}/{repo}/zipball/{ref}\"],\n enableAutomatedSecurityFixes: [\n \"PUT /repos/{owner}/{repo}/automated-security-fixes\",\n { mediaType: { previews: [\"london\"] } },\n ],\n enableVulnerabilityAlerts: [\n \"PUT /repos/{owner}/{repo}/vulnerability-alerts\",\n { mediaType: { previews: [\"dorian\"] } },\n ],\n get: [\"GET /repos/{owner}/{repo}\"],\n getAccessRestrictions: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions\",\n ],\n getAdminBranchProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins\",\n ],\n getAllStatusCheckContexts: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n ],\n getAllTopics: [\n \"GET /repos/{owner}/{repo}/topics\",\n { mediaType: { previews: [\"mercy\"] } },\n ],\n getAppsWithAccessToProtectedBranch: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n ],\n getBranch: [\"GET /repos/{owner}/{repo}/branches/{branch}\"],\n getBranchProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection\",\n ],\n getClones: [\"GET /repos/{owner}/{repo}/traffic/clones\"],\n getCodeFrequencyStats: [\"GET /repos/{owner}/{repo}/stats/code_frequency\"],\n getCollaboratorPermissionLevel: [\n \"GET /repos/{owner}/{repo}/collaborators/{username}/permission\",\n ],\n getCombinedStatusForRef: [\"GET /repos/{owner}/{repo}/commits/{ref}/status\"],\n getCommit: [\"GET /repos/{owner}/{repo}/commits/{ref}\"],\n getCommitActivityStats: [\"GET /repos/{owner}/{repo}/stats/commit_activity\"],\n getCommitComment: [\"GET /repos/{owner}/{repo}/comments/{comment_id}\"],\n getCommitSignatureProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures\",\n { mediaType: { previews: [\"zzzax\"] } },\n ],\n getCommunityProfileMetrics: [\"GET /repos/{owner}/{repo}/community/profile\"],\n getContent: [\"GET /repos/{owner}/{repo}/contents/{path}\"],\n getContributorsStats: [\"GET /repos/{owner}/{repo}/stats/contributors\"],\n getDeployKey: [\"GET /repos/{owner}/{repo}/keys/{key_id}\"],\n getDeployment: [\"GET /repos/{owner}/{repo}/deployments/{deployment_id}\"],\n getDeploymentStatus: [\n \"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}\",\n ],\n getLatestPagesBuild: [\"GET /repos/{owner}/{repo}/pages/builds/latest\"],\n getLatestRelease: [\"GET /repos/{owner}/{repo}/releases/latest\"],\n getPages: [\"GET /repos/{owner}/{repo}/pages\"],\n getPagesBuild: [\"GET /repos/{owner}/{repo}/pages/builds/{build_id}\"],\n getParticipationStats: [\"GET /repos/{owner}/{repo}/stats/participation\"],\n getPullRequestReviewProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews\",\n ],\n getPunchCardStats: [\"GET /repos/{owner}/{repo}/stats/punch_card\"],\n getReadme: [\"GET /repos/{owner}/{repo}/readme\"],\n getRelease: [\"GET /repos/{owner}/{repo}/releases/{release_id}\"],\n getReleaseAsset: [\"GET /repos/{owner}/{repo}/releases/assets/{asset_id}\"],\n getReleaseByTag: [\"GET /repos/{owner}/{repo}/releases/tags/{tag}\"],\n getStatusChecksProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n ],\n getTeamsWithAccessToProtectedBranch: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n ],\n getTopPaths: [\"GET /repos/{owner}/{repo}/traffic/popular/paths\"],\n getTopReferrers: [\"GET /repos/{owner}/{repo}/traffic/popular/referrers\"],\n getUsersWithAccessToProtectedBranch: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n ],\n getViews: [\"GET /repos/{owner}/{repo}/traffic/views\"],\n getWebhook: [\"GET /repos/{owner}/{repo}/hooks/{hook_id}\"],\n getWebhookConfigForRepo: [\n \"GET /repos/{owner}/{repo}/hooks/{hook_id}/config\",\n ],\n listBranches: [\"GET /repos/{owner}/{repo}/branches\"],\n listBranchesForHeadCommit: [\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head\",\n { mediaType: { previews: [\"groot\"] } },\n ],\n listCollaborators: [\"GET /repos/{owner}/{repo}/collaborators\"],\n listCommentsForCommit: [\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/comments\",\n ],\n listCommitCommentsForRepo: [\"GET /repos/{owner}/{repo}/comments\"],\n listCommitStatusesForRef: [\n \"GET /repos/{owner}/{repo}/commits/{ref}/statuses\",\n ],\n listCommits: [\"GET /repos/{owner}/{repo}/commits\"],\n listContributors: [\"GET /repos/{owner}/{repo}/contributors\"],\n listDeployKeys: [\"GET /repos/{owner}/{repo}/keys\"],\n listDeploymentStatuses: [\n \"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses\",\n ],\n listDeployments: [\"GET /repos/{owner}/{repo}/deployments\"],\n listForAuthenticatedUser: [\"GET /user/repos\"],\n listForOrg: [\"GET /orgs/{org}/repos\"],\n listForUser: [\"GET /users/{username}/repos\"],\n listForks: [\"GET /repos/{owner}/{repo}/forks\"],\n listInvitations: [\"GET /repos/{owner}/{repo}/invitations\"],\n listInvitationsForAuthenticatedUser: [\"GET /user/repository_invitations\"],\n listLanguages: [\"GET /repos/{owner}/{repo}/languages\"],\n listPagesBuilds: [\"GET /repos/{owner}/{repo}/pages/builds\"],\n listPublic: [\"GET /repositories\"],\n listPullRequestsAssociatedWithCommit: [\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls\",\n { mediaType: { previews: [\"groot\"] } },\n ],\n listReleaseAssets: [\n \"GET /repos/{owner}/{repo}/releases/{release_id}/assets\",\n ],\n listReleases: [\"GET /repos/{owner}/{repo}/releases\"],\n listTags: [\"GET /repos/{owner}/{repo}/tags\"],\n listTeams: [\"GET /repos/{owner}/{repo}/teams\"],\n listWebhooks: [\"GET /repos/{owner}/{repo}/hooks\"],\n merge: [\"POST /repos/{owner}/{repo}/merges\"],\n pingWebhook: [\"POST /repos/{owner}/{repo}/hooks/{hook_id}/pings\"],\n removeAppAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n {},\n { mapToData: \"apps\" },\n ],\n removeCollaborator: [\n \"DELETE /repos/{owner}/{repo}/collaborators/{username}\",\n ],\n removeStatusCheckContexts: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n {},\n { mapToData: \"contexts\" },\n ],\n removeStatusCheckProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n ],\n removeTeamAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n {},\n { mapToData: \"teams\" },\n ],\n removeUserAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n {},\n { mapToData: \"users\" },\n ],\n replaceAllTopics: [\n \"PUT /repos/{owner}/{repo}/topics\",\n { mediaType: { previews: [\"mercy\"] } },\n ],\n requestPagesBuild: [\"POST /repos/{owner}/{repo}/pages/builds\"],\n setAdminBranchProtection: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins\",\n ],\n setAppAccessRestrictions: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n {},\n { mapToData: \"apps\" },\n ],\n setStatusCheckContexts: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n {},\n { mapToData: \"contexts\" },\n ],\n setTeamAccessRestrictions: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n {},\n { mapToData: \"teams\" },\n ],\n setUserAccessRestrictions: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n {},\n { mapToData: \"users\" },\n ],\n testPushWebhook: [\"POST /repos/{owner}/{repo}/hooks/{hook_id}/tests\"],\n transfer: [\"POST /repos/{owner}/{repo}/transfer\"],\n update: [\"PATCH /repos/{owner}/{repo}\"],\n updateBranchProtection: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection\",\n ],\n updateCommitComment: [\"PATCH /repos/{owner}/{repo}/comments/{comment_id}\"],\n updateInformationAboutPagesSite: [\"PUT /repos/{owner}/{repo}/pages\"],\n updateInvitation: [\n \"PATCH /repos/{owner}/{repo}/invitations/{invitation_id}\",\n ],\n updatePullRequestReviewProtection: [\n \"PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews\",\n ],\n updateRelease: [\"PATCH /repos/{owner}/{repo}/releases/{release_id}\"],\n updateReleaseAsset: [\n \"PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}\",\n ],\n updateStatusCheckPotection: [\n \"PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n {},\n { renamed: [\"repos\", \"updateStatusCheckProtection\"] },\n ],\n updateStatusCheckProtection: [\n \"PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n ],\n updateWebhook: [\"PATCH /repos/{owner}/{repo}/hooks/{hook_id}\"],\n updateWebhookConfigForRepo: [\n \"PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config\",\n ],\n uploadReleaseAsset: [\n \"POST /repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}\",\n { baseUrl: \"https://uploads.github.com\" },\n ],\n },\n search: {\n code: [\"GET /search/code\"],\n commits: [\"GET /search/commits\", { mediaType: { previews: [\"cloak\"] } }],\n issuesAndPullRequests: [\"GET /search/issues\"],\n labels: [\"GET /search/labels\"],\n repos: [\"GET /search/repositories\"],\n topics: [\"GET /search/topics\", { mediaType: { previews: [\"mercy\"] } }],\n users: [\"GET /search/users\"],\n },\n secretScanning: {\n getAlert: [\n \"GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}\",\n ],\n listAlertsForRepo: [\"GET /repos/{owner}/{repo}/secret-scanning/alerts\"],\n updateAlert: [\n \"PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}\",\n ],\n },\n teams: {\n addOrUpdateMembershipForUserInOrg: [\n \"PUT /orgs/{org}/teams/{team_slug}/memberships/{username}\",\n ],\n addOrUpdateProjectPermissionsInOrg: [\n \"PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n addOrUpdateRepoPermissionsInOrg: [\n \"PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}\",\n ],\n checkPermissionsForProjectInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n checkPermissionsForRepoInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}\",\n ],\n create: [\"POST /orgs/{org}/teams\"],\n createDiscussionCommentInOrg: [\n \"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments\",\n ],\n createDiscussionInOrg: [\"POST /orgs/{org}/teams/{team_slug}/discussions\"],\n deleteDiscussionCommentInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}\",\n ],\n deleteDiscussionInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}\",\n ],\n deleteInOrg: [\"DELETE /orgs/{org}/teams/{team_slug}\"],\n getByName: [\"GET /orgs/{org}/teams/{team_slug}\"],\n getDiscussionCommentInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}\",\n ],\n getDiscussionInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}\",\n ],\n getMembershipForUserInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/memberships/{username}\",\n ],\n list: [\"GET /orgs/{org}/teams\"],\n listChildInOrg: [\"GET /orgs/{org}/teams/{team_slug}/teams\"],\n listDiscussionCommentsInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments\",\n ],\n listDiscussionsInOrg: [\"GET /orgs/{org}/teams/{team_slug}/discussions\"],\n listForAuthenticatedUser: [\"GET /user/teams\"],\n listMembersInOrg: [\"GET /orgs/{org}/teams/{team_slug}/members\"],\n listPendingInvitationsInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/invitations\",\n ],\n listProjectsInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listReposInOrg: [\"GET /orgs/{org}/teams/{team_slug}/repos\"],\n removeMembershipForUserInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}\",\n ],\n removeProjectInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}\",\n ],\n removeRepoInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}\",\n ],\n updateDiscussionCommentInOrg: [\n \"PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}\",\n ],\n updateDiscussionInOrg: [\n \"PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}\",\n ],\n updateInOrg: [\"PATCH /orgs/{org}/teams/{team_slug}\"],\n },\n users: {\n addEmailForAuthenticated: [\"POST /user/emails\"],\n block: [\"PUT /user/blocks/{username}\"],\n checkBlocked: [\"GET /user/blocks/{username}\"],\n checkFollowingForUser: [\"GET /users/{username}/following/{target_user}\"],\n checkPersonIsFollowedByAuthenticated: [\"GET /user/following/{username}\"],\n createGpgKeyForAuthenticated: [\"POST /user/gpg_keys\"],\n createPublicSshKeyForAuthenticated: [\"POST /user/keys\"],\n deleteEmailForAuthenticated: [\"DELETE /user/emails\"],\n deleteGpgKeyForAuthenticated: [\"DELETE /user/gpg_keys/{gpg_key_id}\"],\n deletePublicSshKeyForAuthenticated: [\"DELETE /user/keys/{key_id}\"],\n follow: [\"PUT /user/following/{username}\"],\n getAuthenticated: [\"GET /user\"],\n getByUsername: [\"GET /users/{username}\"],\n getContextForUser: [\"GET /users/{username}/hovercard\"],\n getGpgKeyForAuthenticated: [\"GET /user/gpg_keys/{gpg_key_id}\"],\n getPublicSshKeyForAuthenticated: [\"GET /user/keys/{key_id}\"],\n list: [\"GET /users\"],\n listBlockedByAuthenticated: [\"GET /user/blocks\"],\n listEmailsForAuthenticated: [\"GET /user/emails\"],\n listFollowedByAuthenticated: [\"GET /user/following\"],\n listFollowersForAuthenticatedUser: [\"GET /user/followers\"],\n listFollowersForUser: [\"GET /users/{username}/followers\"],\n listFollowingForUser: [\"GET /users/{username}/following\"],\n listGpgKeysForAuthenticated: [\"GET /user/gpg_keys\"],\n listGpgKeysForUser: [\"GET /users/{username}/gpg_keys\"],\n listPublicEmailsForAuthenticated: [\"GET /user/public_emails\"],\n listPublicKeysForUser: [\"GET /users/{username}/keys\"],\n listPublicSshKeysForAuthenticated: [\"GET /user/keys\"],\n setPrimaryEmailVisibilityForAuthenticated: [\"PATCH /user/email/visibility\"],\n unblock: [\"DELETE /user/blocks/{username}\"],\n unfollow: [\"DELETE /user/following/{username}\"],\n updateAuthenticated: [\"PATCH /user\"],\n },\n};\nexport default Endpoints;\n","export const VERSION = \"4.5.2\";\n","export function endpointsToMethods(octokit, endpointsMap) {\n const newMethods = {};\n for (const [scope, endpoints] of Object.entries(endpointsMap)) {\n for (const [methodName, endpoint] of Object.entries(endpoints)) {\n const [route, defaults, decorations] = endpoint;\n const [method, url] = route.split(/ /);\n const endpointDefaults = Object.assign({ method, url }, defaults);\n if (!newMethods[scope]) {\n newMethods[scope] = {};\n }\n const scopeMethods = newMethods[scope];\n if (decorations) {\n scopeMethods[methodName] = decorate(octokit, scope, methodName, endpointDefaults, decorations);\n continue;\n }\n scopeMethods[methodName] = octokit.request.defaults(endpointDefaults);\n }\n }\n return newMethods;\n}\nfunction decorate(octokit, scope, methodName, defaults, decorations) {\n const requestWithDefaults = octokit.request.defaults(defaults);\n /* istanbul ignore next */\n function withDecorations(...args) {\n // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488\n let options = requestWithDefaults.endpoint.merge(...args);\n // There are currently no other decorations than `.mapToData`\n if (decorations.mapToData) {\n options = Object.assign({}, options, {\n data: options[decorations.mapToData],\n [decorations.mapToData]: undefined,\n });\n return requestWithDefaults(options);\n }\n if (decorations.renamed) {\n const [newScope, newMethodName] = decorations.renamed;\n octokit.log.warn(`octokit.${scope}.${methodName}() has been renamed to octokit.${newScope}.${newMethodName}()`);\n }\n if (decorations.deprecated) {\n octokit.log.warn(decorations.deprecated);\n }\n if (decorations.renamedParameters) {\n // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488\n const options = requestWithDefaults.endpoint.merge(...args);\n for (const [name, alias] of Object.entries(decorations.renamedParameters)) {\n if (name in options) {\n octokit.log.warn(`\"${name}\" parameter is deprecated for \"octokit.${scope}.${methodName}()\". Use \"${alias}\" instead`);\n if (!(alias in options)) {\n options[alias] = options[name];\n }\n delete options[name];\n }\n }\n return requestWithDefaults(options);\n }\n // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488\n return requestWithDefaults(...args);\n }\n return Object.assign(withDecorations, requestWithDefaults);\n}\n","import ENDPOINTS from \"./generated/endpoints\";\nimport { VERSION } from \"./version\";\nimport { endpointsToMethods } from \"./endpoints-to-methods\";\n/**\n * This plugin is a 1:1 copy of internal @octokit/rest plugins. The primary\n * goal is to rebuild @octokit/rest on top of @octokit/core. Once that is\n * done, we will remove the registerEndpoints methods and return the methods\n * directly as with the other plugins. At that point we will also remove the\n * legacy workarounds and deprecations.\n *\n * See the plan at\n * https://github.com/octokit/plugin-rest-endpoint-methods.js/pull/1\n */\nexport function restEndpointMethods(octokit) {\n return endpointsToMethods(octokit, ENDPOINTS);\n}\nrestEndpointMethods.VERSION = VERSION;\n"],"names":["Endpoints","actions","addSelectedRepoToOrgSecret","cancelWorkflowRun","createOrUpdateOrgSecret","createOrUpdateRepoSecret","createRegistrationTokenForOrg","createRegistrationTokenForRepo","createRemoveTokenForOrg","createRemoveTokenForRepo","createWorkflowDispatch","deleteArtifact","deleteOrgSecret","deleteRepoSecret","deleteSelfHostedRunnerFromOrg","deleteSelfHostedRunnerFromRepo","deleteWorkflowRun","deleteWorkflowRunLogs","disableSelectedRepositoryGithubActionsOrganization","disableWorkflow","downloadArtifact","downloadJobLogsForWorkflowRun","downloadWorkflowRunLogs","enableSelectedRepositoryGithubActionsOrganization","enableWorkflow","getAllowedActionsOrganization","getAllowedActionsRepository","getArtifact","getGithubActionsPermissionsOrganization","getGithubActionsPermissionsRepository","getJobForWorkflowRun","getOrgPublicKey","getOrgSecret","getRepoPermissions","renamed","getRepoPublicKey","getRepoSecret","getSelfHostedRunnerForOrg","getSelfHostedRunnerForRepo","getWorkflow","getWorkflowRun","getWorkflowRunUsage","getWorkflowUsage","listArtifactsForRepo","listJobsForWorkflowRun","listOrgSecrets","listRepoSecrets","listRepoWorkflows","listRunnerApplicationsForOrg","listRunnerApplicationsForRepo","listSelectedReposForOrgSecret","listSelectedRepositoriesEnabledGithubActionsOrganization","listSelfHostedRunnersForOrg","listSelfHostedRunnersForRepo","listWorkflowRunArtifacts","listWorkflowRuns","listWorkflowRunsForRepo","reRunWorkflow","removeSelectedRepoFromOrgSecret","setAllowedActionsOrganization","setAllowedActionsRepository","setGithubActionsPermissionsOrganization","setGithubActionsPermissionsRepository","setSelectedReposForOrgSecret","setSelectedRepositoriesEnabledGithubActionsOrganization","activity","checkRepoIsStarredByAuthenticatedUser","deleteRepoSubscription","deleteThreadSubscription","getFeeds","getRepoSubscription","getThread","getThreadSubscriptionForAuthenticatedUser","listEventsForAuthenticatedUser","listNotificationsForAuthenticatedUser","listOrgEventsForAuthenticatedUser","listPublicEvents","listPublicEventsForRepoNetwork","listPublicEventsForUser","listPublicOrgEvents","listReceivedEventsForUser","listReceivedPublicEventsForUser","listRepoEvents","listRepoNotificationsForAuthenticatedUser","listReposStarredByAuthenticatedUser","listReposStarredByUser","listReposWatchedByUser","listStargazersForRepo","listWatchedReposForAuthenticatedUser","listWatchersForRepo","markNotificationsAsRead","markRepoNotificationsAsRead","markThreadAsRead","setRepoSubscription","setThreadSubscription","starRepoForAuthenticatedUser","unstarRepoForAuthenticatedUser","apps","addRepoToInstallation","checkToken","createContentAttachment","mediaType","previews","createFromManifest","createInstallationAccessToken","deleteAuthorization","deleteInstallation","deleteToken","getAuthenticated","getBySlug","getInstallation","getOrgInstallation","getRepoInstallation","getSubscriptionPlanForAccount","getSubscriptionPlanForAccountStubbed","getUserInstallation","getWebhookConfigForApp","listAccountsForPlan","listAccountsForPlanStubbed","listInstallationReposForAuthenticatedUser","listInstallations","listInstallationsForAuthenticatedUser","listPlans","listPlansStubbed","listReposAccessibleToInstallation","listSubscriptionsForAuthenticatedUser","listSubscriptionsForAuthenticatedUserStubbed","removeRepoFromInstallation","resetToken","revokeInstallationAccessToken","scopeToken","suspendInstallation","unsuspendInstallation","updateWebhookConfigForApp","billing","getGithubActionsBillingOrg","getGithubActionsBillingUser","getGithubPackagesBillingOrg","getGithubPackagesBillingUser","getSharedStorageBillingOrg","getSharedStorageBillingUser","checks","create","createSuite","get","getSuite","listAnnotations","listForRef","listForSuite","listSuitesForRef","rerequestSuite","setSuitesPreferences","update","codeScanning","getAlert","renamedParameters","alert_id","listAlertsForRepo","listRecentAnalyses","updateAlert","uploadSarif","codesOfConduct","getAllCodesOfConduct","getConductCode","getForRepo","emojis","enterpriseAdmin","disableSelectedOrganizationGithubActionsEnterprise","enableSelectedOrganizationGithubActionsEnterprise","getAllowedActionsEnterprise","getGithubActionsPermissionsEnterprise","listSelectedOrganizationsEnabledGithubActionsEnterprise","setAllowedActionsEnterprise","setGithubActionsPermissionsEnterprise","setSelectedOrganizationsEnabledGithubActionsEnterprise","gists","checkIsStarred","createComment","delete","deleteComment","fork","getComment","getRevision","list","listComments","listCommits","listForUser","listForks","listPublic","listStarred","star","unstar","updateComment","git","createBlob","createCommit","createRef","createTag","createTree","deleteRef","getBlob","getCommit","getRef","getTag","getTree","listMatchingRefs","updateRef","gitignore","getAllTemplates","getTemplate","interactions","getRestrictionsForOrg","getRestrictionsForRepo","getRestrictionsForYourPublicRepos","removeRestrictionsForOrg","removeRestrictionsForRepo","removeRestrictionsForYourPublicRepos","setRestrictionsForOrg","setRestrictionsForRepo","setRestrictionsForYourPublicRepos","issues","addAssignees","addLabels","checkUserCanBeAssigned","createLabel","createMilestone","deleteLabel","deleteMilestone","getEvent","getLabel","getMilestone","listAssignees","listCommentsForRepo","listEvents","listEventsForRepo","listEventsForTimeline","listForAuthenticatedUser","listForOrg","listForRepo","listLabelsForMilestone","listLabelsForRepo","listLabelsOnIssue","listMilestones","lock","removeAllLabels","removeAssignees","removeLabel","setLabels","unlock","updateLabel","updateMilestone","licenses","getAllCommonlyUsed","markdown","render","renderRaw","headers","meta","getOctocat","getZen","root","migrations","cancelImport","deleteArchiveForAuthenticatedUser","deleteArchiveForOrg","downloadArchiveForOrg","getArchiveForAuthenticatedUser","getCommitAuthors","getImportStatus","getLargeFiles","getStatusForAuthenticatedUser","getStatusForOrg","listReposForOrg","listReposForUser","mapCommitAuthor","setLfsPreference","startForAuthenticatedUser","startForOrg","startImport","unlockRepoForAuthenticatedUser","unlockRepoForOrg","updateImport","orgs","blockUser","checkBlockedUser","checkMembershipForUser","checkPublicMembershipForUser","convertMemberToOutsideCollaborator","createInvitation","createWebhook","deleteWebhook","getMembershipForAuthenticatedUser","getMembershipForUser","getWebhook","getWebhookConfigForOrg","listAppInstallations","listBlockedUsers","listInvitationTeams","listMembers","listMembershipsForAuthenticatedUser","listOutsideCollaborators","listPendingInvitations","listPublicMembers","listWebhooks","pingWebhook","removeMember","removeMembershipForUser","removeOutsideCollaborator","removePublicMembershipForAuthenticatedUser","setMembershipForUser","setPublicMembershipForAuthenticatedUser","unblockUser","updateMembershipForAuthenticatedUser","updateWebhook","updateWebhookConfigForOrg","projects","addCollaborator","createCard","createColumn","createForAuthenticatedUser","createForOrg","createForRepo","deleteCard","deleteColumn","getCard","getColumn","getPermissionForUser","listCards","listCollaborators","listColumns","moveCard","moveColumn","removeCollaborator","updateCard","updateColumn","pulls","checkIfMerged","createReplyForReviewComment","createReview","createReviewComment","deletePendingReview","deleteReviewComment","dismissReview","getReview","getReviewComment","listCommentsForReview","listFiles","listRequestedReviewers","listReviewComments","listReviewCommentsForRepo","listReviews","merge","removeRequestedReviewers","requestReviewers","submitReview","updateBranch","updateReview","updateReviewComment","rateLimit","reactions","createForCommitComment","createForIssue","createForIssueComment","createForPullRequestReviewComment","createForTeamDiscussionCommentInOrg","createForTeamDiscussionInOrg","deleteForCommitComment","deleteForIssue","deleteForIssueComment","deleteForPullRequestComment","deleteForTeamDiscussion","deleteForTeamDiscussionComment","deleteLegacy","deprecated","listForCommitComment","listForIssue","listForIssueComment","listForPullRequestReviewComment","listForTeamDiscussionCommentInOrg","listForTeamDiscussionInOrg","repos","acceptInvitation","addAppAccessRestrictions","mapToData","addStatusCheckContexts","addTeamAccessRestrictions","addUserAccessRestrictions","checkCollaborator","checkVulnerabilityAlerts","compareCommits","createCommitComment","createCommitSignatureProtection","createCommitStatus","createDeployKey","createDeployment","createDeploymentStatus","createDispatchEvent","createFork","createInOrg","createOrUpdateFileContents","createPagesSite","createRelease","createUsingTemplate","declineInvitation","deleteAccessRestrictions","deleteAdminBranchProtection","deleteBranchProtection","deleteCommitComment","deleteCommitSignatureProtection","deleteDeployKey","deleteDeployment","deleteFile","deleteInvitation","deletePagesSite","deletePullRequestReviewProtection","deleteRelease","deleteReleaseAsset","disableAutomatedSecurityFixes","disableVulnerabilityAlerts","downloadArchive","downloadTarballArchive","downloadZipballArchive","enableAutomatedSecurityFixes","enableVulnerabilityAlerts","getAccessRestrictions","getAdminBranchProtection","getAllStatusCheckContexts","getAllTopics","getAppsWithAccessToProtectedBranch","getBranch","getBranchProtection","getClones","getCodeFrequencyStats","getCollaboratorPermissionLevel","getCombinedStatusForRef","getCommitActivityStats","getCommitComment","getCommitSignatureProtection","getCommunityProfileMetrics","getContent","getContributorsStats","getDeployKey","getDeployment","getDeploymentStatus","getLatestPagesBuild","getLatestRelease","getPages","getPagesBuild","getParticipationStats","getPullRequestReviewProtection","getPunchCardStats","getReadme","getRelease","getReleaseAsset","getReleaseByTag","getStatusChecksProtection","getTeamsWithAccessToProtectedBranch","getTopPaths","getTopReferrers","getUsersWithAccessToProtectedBranch","getViews","getWebhookConfigForRepo","listBranches","listBranchesForHeadCommit","listCommentsForCommit","listCommitCommentsForRepo","listCommitStatusesForRef","listContributors","listDeployKeys","listDeploymentStatuses","listDeployments","listInvitations","listInvitationsForAuthenticatedUser","listLanguages","listPagesBuilds","listPullRequestsAssociatedWithCommit","listReleaseAssets","listReleases","listTags","listTeams","removeAppAccessRestrictions","removeStatusCheckContexts","removeStatusCheckProtection","removeTeamAccessRestrictions","removeUserAccessRestrictions","replaceAllTopics","requestPagesBuild","setAdminBranchProtection","setAppAccessRestrictions","setStatusCheckContexts","setTeamAccessRestrictions","setUserAccessRestrictions","testPushWebhook","transfer","updateBranchProtection","updateCommitComment","updateInformationAboutPagesSite","updateInvitation","updatePullRequestReviewProtection","updateRelease","updateReleaseAsset","updateStatusCheckPotection","updateStatusCheckProtection","updateWebhookConfigForRepo","uploadReleaseAsset","baseUrl","search","code","commits","issuesAndPullRequests","labels","topics","users","secretScanning","teams","addOrUpdateMembershipForUserInOrg","addOrUpdateProjectPermissionsInOrg","addOrUpdateRepoPermissionsInOrg","checkPermissionsForProjectInOrg","checkPermissionsForRepoInOrg","createDiscussionCommentInOrg","createDiscussionInOrg","deleteDiscussionCommentInOrg","deleteDiscussionInOrg","deleteInOrg","getByName","getDiscussionCommentInOrg","getDiscussionInOrg","getMembershipForUserInOrg","listChildInOrg","listDiscussionCommentsInOrg","listDiscussionsInOrg","listMembersInOrg","listPendingInvitationsInOrg","listProjectsInOrg","listReposInOrg","removeMembershipForUserInOrg","removeProjectInOrg","removeRepoInOrg","updateDiscussionCommentInOrg","updateDiscussionInOrg","updateInOrg","addEmailForAuthenticated","block","checkBlocked","checkFollowingForUser","checkPersonIsFollowedByAuthenticated","createGpgKeyForAuthenticated","createPublicSshKeyForAuthenticated","deleteEmailForAuthenticated","deleteGpgKeyForAuthenticated","deletePublicSshKeyForAuthenticated","follow","getByUsername","getContextForUser","getGpgKeyForAuthenticated","getPublicSshKeyForAuthenticated","listBlockedByAuthenticated","listEmailsForAuthenticated","listFollowedByAuthenticated","listFollowersForAuthenticatedUser","listFollowersForUser","listFollowingForUser","listGpgKeysForAuthenticated","listGpgKeysForUser","listPublicEmailsForAuthenticated","listPublicKeysForUser","listPublicSshKeysForAuthenticated","setPrimaryEmailVisibilityForAuthenticated","unblock","unfollow","updateAuthenticated","VERSION","endpointsToMethods","octokit","endpointsMap","newMethods","scope","endpoints","Object","entries","methodName","endpoint","route","defaults","decorations","method","url","split","endpointDefaults","assign","scopeMethods","decorate","request","requestWithDefaults","withDecorations","args","options","data","undefined","newScope","newMethodName","log","warn","name","alias","restEndpointMethods","ENDPOINTS"],"mappings":";;;;AAAA,MAAMA,SAAS,GAAG;AACdC,EAAAA,OAAO,EAAE;AACLC,IAAAA,0BAA0B,EAAE,CACxB,4EADwB,CADvB;AAILC,IAAAA,iBAAiB,EAAE,CACf,yDADe,CAJd;AAOLC,IAAAA,uBAAuB,EAAE,CAAC,+CAAD,CAPpB;AAQLC,IAAAA,wBAAwB,EAAE,CACtB,yDADsB,CARrB;AAWLC,IAAAA,6BAA6B,EAAE,CAC3B,qDAD2B,CAX1B;AAcLC,IAAAA,8BAA8B,EAAE,CAC5B,+DAD4B,CAd3B;AAiBLC,IAAAA,uBAAuB,EAAE,CAAC,+CAAD,CAjBpB;AAkBLC,IAAAA,wBAAwB,EAAE,CACtB,yDADsB,CAlBrB;AAqBLC,IAAAA,sBAAsB,EAAE,CACpB,uEADoB,CArBnB;AAwBLC,IAAAA,cAAc,EAAE,CACZ,8DADY,CAxBX;AA2BLC,IAAAA,eAAe,EAAE,CAAC,kDAAD,CA3BZ;AA4BLC,IAAAA,gBAAgB,EAAE,CACd,4DADc,CA5Bb;AA+BLC,IAAAA,6BAA6B,EAAE,CAC3B,gDAD2B,CA/B1B;AAkCLC,IAAAA,8BAA8B,EAAE,CAC5B,0DAD4B,CAlC3B;AAqCLC,IAAAA,iBAAiB,EAAE,CAAC,oDAAD,CArCd;AAsCLC,IAAAA,qBAAqB,EAAE,CACnB,yDADmB,CAtClB;AAyCLC,IAAAA,kDAAkD,EAAE,CAChD,qEADgD,CAzC/C;AA4CLC,IAAAA,eAAe,EAAE,CACb,mEADa,CA5CZ;AA+CLC,IAAAA,gBAAgB,EAAE,CACd,4EADc,CA/Cb;AAkDLC,IAAAA,6BAA6B,EAAE,CAC3B,sDAD2B,CAlD1B;AAqDLC,IAAAA,uBAAuB,EAAE,CACrB,sDADqB,CArDpB;AAwDLC,IAAAA,iDAAiD,EAAE,CAC/C,kEAD+C,CAxD9C;AA2DLC,IAAAA,cAAc,EAAE,CACZ,kEADY,CA3DX;AA8DLC,IAAAA,6BAA6B,EAAE,CAC3B,sDAD2B,CA9D1B;AAiELC,IAAAA,2BAA2B,EAAE,CACzB,gEADyB,CAjExB;AAoELC,IAAAA,WAAW,EAAE,CAAC,2DAAD,CApER;AAqELC,IAAAA,uCAAuC,EAAE,CACrC,qCADqC,CArEpC;AAwELC,IAAAA,qCAAqC,EAAE,CACnC,+CADmC,CAxElC;AA2ELC,IAAAA,oBAAoB,EAAE,CAAC,iDAAD,CA3EjB;AA4ELC,IAAAA,eAAe,EAAE,CAAC,4CAAD,CA5EZ;AA6ELC,IAAAA,YAAY,EAAE,CAAC,+CAAD,CA7ET;AA8ELC,IAAAA,kBAAkB,EAAE,CAChB,+CADgB,EAEhB,EAFgB,EAGhB;AAAEC,MAAAA,OAAO,EAAE,CAAC,SAAD,EAAY,uCAAZ;AAAX,KAHgB,CA9Ef;AAmFLC,IAAAA,gBAAgB,EAAE,CAAC,sDAAD,CAnFb;AAoFLC,IAAAA,aAAa,EAAE,CAAC,yDAAD,CApFV;AAqFLC,IAAAA,yBAAyB,EAAE,CAAC,6CAAD,CArFtB;AAsFLC,IAAAA,0BAA0B,EAAE,CACxB,uDADwB,CAtFvB;AAyFLC,IAAAA,WAAW,EAAE,CAAC,2DAAD,CAzFR;AA0FLC,IAAAA,cAAc,EAAE,CAAC,iDAAD,CA1FX;AA2FLC,IAAAA,mBAAmB,EAAE,CACjB,wDADiB,CA3FhB;AA8FLC,IAAAA,gBAAgB,EAAE,CACd,kEADc,CA9Fb;AAiGLC,IAAAA,oBAAoB,EAAE,CAAC,6CAAD,CAjGjB;AAkGLC,IAAAA,sBAAsB,EAAE,CACpB,sDADoB,CAlGnB;AAqGLC,IAAAA,cAAc,EAAE,CAAC,iCAAD,CArGX;AAsGLC,IAAAA,eAAe,EAAE,CAAC,2CAAD,CAtGZ;AAuGLC,IAAAA,iBAAiB,EAAE,CAAC,6CAAD,CAvGd;AAwGLC,IAAAA,4BAA4B,EAAE,CAAC,2CAAD,CAxGzB;AAyGLC,IAAAA,6BAA6B,EAAE,CAC3B,qDAD2B,CAzG1B;AA4GLC,IAAAA,6BAA6B,EAAE,CAC3B,4DAD2B,CA5G1B;AA+GLC,IAAAA,wDAAwD,EAAE,CACtD,kDADsD,CA/GrD;AAkHLC,IAAAA,2BAA2B,EAAE,CAAC,iCAAD,CAlHxB;AAmHLC,IAAAA,4BAA4B,EAAE,CAAC,2CAAD,CAnHzB;AAoHLC,IAAAA,wBAAwB,EAAE,CACtB,2DADsB,CApHrB;AAuHLC,IAAAA,gBAAgB,EAAE,CACd,gEADc,CAvHb;AA0HLC,IAAAA,uBAAuB,EAAE,CAAC,wCAAD,CA1HpB;AA2HLC,IAAAA,aAAa,EAAE,CAAC,wDAAD,CA3HV;AA4HLC,IAAAA,+BAA+B,EAAE,CAC7B,+EAD6B,CA5H5B;AA+HLC,IAAAA,6BAA6B,EAAE,CAC3B,sDAD2B,CA/H1B;AAkILC,IAAAA,2BAA2B,EAAE,CACzB,gEADyB,CAlIxB;AAqILC,IAAAA,uCAAuC,EAAE,CACrC,qCADqC,CArIpC;AAwILC,IAAAA,qCAAqC,EAAE,CACnC,+CADmC,CAxIlC;AA2ILC,IAAAA,4BAA4B,EAAE,CAC1B,4DAD0B,CA3IzB;AA8ILC,IAAAA,uDAAuD,EAAE,CACrD,kDADqD;AA9IpD,GADK;AAmJdC,EAAAA,QAAQ,EAAE;AACNC,IAAAA,qCAAqC,EAAE,CAAC,kCAAD,CADjC;AAENC,IAAAA,sBAAsB,EAAE,CAAC,2CAAD,CAFlB;AAGNC,IAAAA,wBAAwB,EAAE,CACtB,wDADsB,CAHpB;AAMNC,IAAAA,QAAQ,EAAE,CAAC,YAAD,CANJ;AAONC,IAAAA,mBAAmB,EAAE,CAAC,wCAAD,CAPf;AAQNC,IAAAA,SAAS,EAAE,CAAC,wCAAD,CARL;AASNC,IAAAA,yCAAyC,EAAE,CACvC,qDADuC,CATrC;AAYNC,IAAAA,8BAA8B,EAAE,CAAC,8BAAD,CAZ1B;AAaNC,IAAAA,qCAAqC,EAAE,CAAC,oBAAD,CAbjC;AAcNC,IAAAA,iCAAiC,EAAE,CAC/B,yCAD+B,CAd7B;AAiBNC,IAAAA,gBAAgB,EAAE,CAAC,aAAD,CAjBZ;AAkBNC,IAAAA,8BAA8B,EAAE,CAAC,qCAAD,CAlB1B;AAmBNC,IAAAA,uBAAuB,EAAE,CAAC,qCAAD,CAnBnB;AAoBNC,IAAAA,mBAAmB,EAAE,CAAC,wBAAD,CApBf;AAqBNC,IAAAA,yBAAyB,EAAE,CAAC,uCAAD,CArBrB;AAsBNC,IAAAA,+BAA+B,EAAE,CAC7B,8CAD6B,CAtB3B;AAyBNC,IAAAA,cAAc,EAAE,CAAC,kCAAD,CAzBV;AA0BNC,IAAAA,yCAAyC,EAAE,CACvC,yCADuC,CA1BrC;AA6BNC,IAAAA,mCAAmC,EAAE,CAAC,mBAAD,CA7B/B;AA8BNC,IAAAA,sBAAsB,EAAE,CAAC,+BAAD,CA9BlB;AA+BNC,IAAAA,sBAAsB,EAAE,CAAC,qCAAD,CA/BlB;AAgCNC,IAAAA,qBAAqB,EAAE,CAAC,sCAAD,CAhCjB;AAiCNC,IAAAA,oCAAoC,EAAE,CAAC,yBAAD,CAjChC;AAkCNC,IAAAA,mBAAmB,EAAE,CAAC,uCAAD,CAlCf;AAmCNC,IAAAA,uBAAuB,EAAE,CAAC,oBAAD,CAnCnB;AAoCNC,IAAAA,2BAA2B,EAAE,CAAC,yCAAD,CApCvB;AAqCNC,IAAAA,gBAAgB,EAAE,CAAC,0CAAD,CArCZ;AAsCNC,IAAAA,mBAAmB,EAAE,CAAC,wCAAD,CAtCf;AAuCNC,IAAAA,qBAAqB,EAAE,CACnB,qDADmB,CAvCjB;AA0CNC,IAAAA,4BAA4B,EAAE,CAAC,kCAAD,CA1CxB;AA2CNC,IAAAA,8BAA8B,EAAE,CAAC,qCAAD;AA3C1B,GAnJI;AAgMdC,EAAAA,IAAI,EAAE;AACFC,IAAAA,qBAAqB,EAAE,CACnB,wEADmB,CADrB;AAIFC,IAAAA,UAAU,EAAE,CAAC,sCAAD,CAJV;AAKFC,IAAAA,uBAAuB,EAAE,CACrB,6DADqB,EAErB;AAAEC,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFqB,CALvB;AASFC,IAAAA,kBAAkB,EAAE,CAAC,wCAAD,CATlB;AAUFC,IAAAA,6BAA6B,EAAE,CAC3B,yDAD2B,CAV7B;AAaFC,IAAAA,mBAAmB,EAAE,CAAC,wCAAD,CAbnB;AAcFC,IAAAA,kBAAkB,EAAE,CAAC,6CAAD,CAdlB;AAeFC,IAAAA,WAAW,EAAE,CAAC,wCAAD,CAfX;AAgBFC,IAAAA,gBAAgB,EAAE,CAAC,UAAD,CAhBhB;AAiBFC,IAAAA,SAAS,EAAE,CAAC,sBAAD,CAjBT;AAkBFC,IAAAA,eAAe,EAAE,CAAC,0CAAD,CAlBf;AAmBFC,IAAAA,kBAAkB,EAAE,CAAC,8BAAD,CAnBlB;AAoBFC,IAAAA,mBAAmB,EAAE,CAAC,wCAAD,CApBnB;AAqBFC,IAAAA,6BAA6B,EAAE,CAC3B,gDAD2B,CArB7B;AAwBFC,IAAAA,oCAAoC,EAAE,CAClC,wDADkC,CAxBpC;AA2BFC,IAAAA,mBAAmB,EAAE,CAAC,oCAAD,CA3BnB;AA4BFC,IAAAA,sBAAsB,EAAE,CAAC,sBAAD,CA5BtB;AA6BFC,IAAAA,mBAAmB,EAAE,CAAC,mDAAD,CA7BnB;AA8BFC,IAAAA,0BAA0B,EAAE,CACxB,2DADwB,CA9B1B;AAiCFC,IAAAA,yCAAyC,EAAE,CACvC,wDADuC,CAjCzC;AAoCFC,IAAAA,iBAAiB,EAAE,CAAC,wBAAD,CApCjB;AAqCFC,IAAAA,qCAAqC,EAAE,CAAC,yBAAD,CArCrC;AAsCFC,IAAAA,SAAS,EAAE,CAAC,gCAAD,CAtCT;AAuCFC,IAAAA,gBAAgB,EAAE,CAAC,wCAAD,CAvChB;AAwCFC,IAAAA,iCAAiC,EAAE,CAAC,gCAAD,CAxCjC;AAyCFC,IAAAA,qCAAqC,EAAE,CAAC,iCAAD,CAzCrC;AA0CFC,IAAAA,4CAA4C,EAAE,CAC1C,yCAD0C,CA1C5C;AA6CFC,IAAAA,0BAA0B,EAAE,CACxB,2EADwB,CA7C1B;AAgDFC,IAAAA,UAAU,EAAE,CAAC,uCAAD,CAhDV;AAiDFC,IAAAA,6BAA6B,EAAE,CAAC,4BAAD,CAjD7B;AAkDFC,IAAAA,UAAU,EAAE,CAAC,6CAAD,CAlDV;AAmDFC,IAAAA,mBAAmB,EAAE,CAAC,oDAAD,CAnDnB;AAoDFC,IAAAA,qBAAqB,EAAE,CACnB,uDADmB,CApDrB;AAuDFC,IAAAA,yBAAyB,EAAE,CAAC,wBAAD;AAvDzB,GAhMQ;AAyPdC,EAAAA,OAAO,EAAE;AACLC,IAAAA,0BAA0B,EAAE,CAAC,0CAAD,CADvB;AAELC,IAAAA,2BAA2B,EAAE,CACzB,gDADyB,CAFxB;AAKLC,IAAAA,2BAA2B,EAAE,CAAC,2CAAD,CALxB;AAMLC,IAAAA,4BAA4B,EAAE,CAC1B,iDAD0B,CANzB;AASLC,IAAAA,0BAA0B,EAAE,CACxB,iDADwB,CATvB;AAYLC,IAAAA,2BAA2B,EAAE,CACzB,uDADyB;AAZxB,GAzPK;AAyQdC,EAAAA,MAAM,EAAE;AACJC,IAAAA,MAAM,EAAE,CAAC,uCAAD,CADJ;AAEJC,IAAAA,WAAW,EAAE,CAAC,yCAAD,CAFT;AAGJC,IAAAA,GAAG,EAAE,CAAC,qDAAD,CAHD;AAIJC,IAAAA,QAAQ,EAAE,CAAC,yDAAD,CAJN;AAKJC,IAAAA,eAAe,EAAE,CACb,iEADa,CALb;AAQJC,IAAAA,UAAU,EAAE,CAAC,oDAAD,CARR;AASJC,IAAAA,YAAY,EAAE,CACV,oEADU,CATV;AAYJC,IAAAA,gBAAgB,EAAE,CAAC,sDAAD,CAZd;AAaJC,IAAAA,cAAc,EAAE,CACZ,oEADY,CAbZ;AAgBJC,IAAAA,oBAAoB,EAAE,CAClB,sDADkB,CAhBlB;AAmBJC,IAAAA,MAAM,EAAE,CAAC,uDAAD;AAnBJ,GAzQM;AA8RdC,EAAAA,YAAY,EAAE;AACVC,IAAAA,QAAQ,EAAE,CACN,+DADM,EAEN,EAFM,EAGN;AAAEC,MAAAA,iBAAiB,EAAE;AAAEC,QAAAA,QAAQ,EAAE;AAAZ;AAArB,KAHM,CADA;AAMVC,IAAAA,iBAAiB,EAAE,CAAC,gDAAD,CANT;AAOVC,IAAAA,kBAAkB,EAAE,CAAC,kDAAD,CAPV;AAQVC,IAAAA,WAAW,EAAE,CACT,iEADS,CARH;AAWVC,IAAAA,WAAW,EAAE,CAAC,iDAAD;AAXH,GA9RA;AA2SdC,EAAAA,cAAc,EAAE;AACZC,IAAAA,oBAAoB,EAAE,CAClB,uBADkB,EAElB;AAAE7D,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFkB,CADV;AAKZ6D,IAAAA,cAAc,EAAE,CACZ,6BADY,EAEZ;AAAE9D,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFY,CALJ;AASZ8D,IAAAA,UAAU,EAAE,CACR,qDADQ,EAER;AAAE/D,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFQ;AATA,GA3SF;AAyTd+D,EAAAA,MAAM,EAAE;AAAErB,IAAAA,GAAG,EAAE,CAAC,aAAD;AAAP,GAzTM;AA0TdsB,EAAAA,eAAe,EAAE;AACbC,IAAAA,kDAAkD,EAAE,CAChD,6EADgD,CADvC;AAIbC,IAAAA,iDAAiD,EAAE,CAC/C,0EAD+C,CAJtC;AAObC,IAAAA,2BAA2B,EAAE,CACzB,oEADyB,CAPhB;AAUbC,IAAAA,qCAAqC,EAAE,CACnC,mDADmC,CAV1B;AAabC,IAAAA,uDAAuD,EAAE,CACrD,iEADqD,CAb5C;AAgBbC,IAAAA,2BAA2B,EAAE,CACzB,oEADyB,CAhBhB;AAmBbC,IAAAA,qCAAqC,EAAE,CACnC,mDADmC,CAnB1B;AAsBbC,IAAAA,sDAAsD,EAAE,CACpD,iEADoD;AAtB3C,GA1TH;AAoVdC,EAAAA,KAAK,EAAE;AACHC,IAAAA,cAAc,EAAE,CAAC,2BAAD,CADb;AAEHlC,IAAAA,MAAM,EAAE,CAAC,aAAD,CAFL;AAGHmC,IAAAA,aAAa,EAAE,CAAC,gCAAD,CAHZ;AAIHC,IAAAA,MAAM,EAAE,CAAC,yBAAD,CAJL;AAKHC,IAAAA,aAAa,EAAE,CAAC,+CAAD,CALZ;AAMHC,IAAAA,IAAI,EAAE,CAAC,6BAAD,CANH;AAOHpC,IAAAA,GAAG,EAAE,CAAC,sBAAD,CAPF;AAQHqC,IAAAA,UAAU,EAAE,CAAC,4CAAD,CART;AASHC,IAAAA,WAAW,EAAE,CAAC,4BAAD,CATV;AAUHC,IAAAA,IAAI,EAAE,CAAC,YAAD,CAVH;AAWHC,IAAAA,YAAY,EAAE,CAAC,+BAAD,CAXX;AAYHC,IAAAA,WAAW,EAAE,CAAC,8BAAD,CAZV;AAaHC,IAAAA,WAAW,EAAE,CAAC,6BAAD,CAbV;AAcHC,IAAAA,SAAS,EAAE,CAAC,4BAAD,CAdR;AAeHC,IAAAA,UAAU,EAAE,CAAC,mBAAD,CAfT;AAgBHC,IAAAA,WAAW,EAAE,CAAC,oBAAD,CAhBV;AAiBHC,IAAAA,IAAI,EAAE,CAAC,2BAAD,CAjBH;AAkBHC,IAAAA,MAAM,EAAE,CAAC,8BAAD,CAlBL;AAmBHvC,IAAAA,MAAM,EAAE,CAAC,wBAAD,CAnBL;AAoBHwC,IAAAA,aAAa,EAAE,CAAC,8CAAD;AApBZ,GApVO;AA0WdC,EAAAA,GAAG,EAAE;AACDC,IAAAA,UAAU,EAAE,CAAC,sCAAD,CADX;AAEDC,IAAAA,YAAY,EAAE,CAAC,wCAAD,CAFb;AAGDC,IAAAA,SAAS,EAAE,CAAC,qCAAD,CAHV;AAIDC,IAAAA,SAAS,EAAE,CAAC,qCAAD,CAJV;AAKDC,IAAAA,UAAU,EAAE,CAAC,sCAAD,CALX;AAMDC,IAAAA,SAAS,EAAE,CAAC,6CAAD,CANV;AAODC,IAAAA,OAAO,EAAE,CAAC,gDAAD,CAPR;AAQDC,IAAAA,SAAS,EAAE,CAAC,oDAAD,CARV;AASDC,IAAAA,MAAM,EAAE,CAAC,yCAAD,CATP;AAUDC,IAAAA,MAAM,EAAE,CAAC,8CAAD,CAVP;AAWDC,IAAAA,OAAO,EAAE,CAAC,gDAAD,CAXR;AAYDC,IAAAA,gBAAgB,EAAE,CAAC,mDAAD,CAZjB;AAaDC,IAAAA,SAAS,EAAE,CAAC,4CAAD;AAbV,GA1WS;AAyXdC,EAAAA,SAAS,EAAE;AACPC,IAAAA,eAAe,EAAE,CAAC,0BAAD,CADV;AAEPC,IAAAA,WAAW,EAAE,CAAC,iCAAD;AAFN,GAzXG;AA6XdC,EAAAA,YAAY,EAAE;AACVC,IAAAA,qBAAqB,EAAE,CAAC,oCAAD,CADb;AAEVC,IAAAA,sBAAsB,EAAE,CAAC,8CAAD,CAFd;AAGVC,IAAAA,iCAAiC,EAAE,CAAC,8BAAD,CAHzB;AAIVC,IAAAA,wBAAwB,EAAE,CAAC,uCAAD,CAJhB;AAKVC,IAAAA,yBAAyB,EAAE,CACvB,iDADuB,CALjB;AAQVC,IAAAA,oCAAoC,EAAE,CAAC,iCAAD,CAR5B;AASVC,IAAAA,qBAAqB,EAAE,CAAC,oCAAD,CATb;AAUVC,IAAAA,sBAAsB,EAAE,CAAC,8CAAD,CAVd;AAWVC,IAAAA,iCAAiC,EAAE,CAAC,8BAAD;AAXzB,GA7XA;AA0YdC,EAAAA,MAAM,EAAE;AACJC,IAAAA,YAAY,EAAE,CACV,4DADU,CADV;AAIJC,IAAAA,SAAS,EAAE,CAAC,yDAAD,CAJP;AAKJC,IAAAA,sBAAsB,EAAE,CAAC,gDAAD,CALpB;AAMJjF,IAAAA,MAAM,EAAE,CAAC,mCAAD,CANJ;AAOJmC,IAAAA,aAAa,EAAE,CACX,2DADW,CAPX;AAUJ+C,IAAAA,WAAW,EAAE,CAAC,mCAAD,CAVT;AAWJC,IAAAA,eAAe,EAAE,CAAC,uCAAD,CAXb;AAYJ9C,IAAAA,aAAa,EAAE,CACX,2DADW,CAZX;AAeJ+C,IAAAA,WAAW,EAAE,CAAC,4CAAD,CAfT;AAgBJC,IAAAA,eAAe,EAAE,CACb,4DADa,CAhBb;AAmBJnF,IAAAA,GAAG,EAAE,CAAC,iDAAD,CAnBD;AAoBJqC,IAAAA,UAAU,EAAE,CAAC,wDAAD,CApBR;AAqBJ+C,IAAAA,QAAQ,EAAE,CAAC,oDAAD,CArBN;AAsBJC,IAAAA,QAAQ,EAAE,CAAC,yCAAD,CAtBN;AAuBJC,IAAAA,YAAY,EAAE,CAAC,yDAAD,CAvBV;AAwBJ/C,IAAAA,IAAI,EAAE,CAAC,aAAD,CAxBF;AAyBJgD,IAAAA,aAAa,EAAE,CAAC,qCAAD,CAzBX;AA0BJ/C,IAAAA,YAAY,EAAE,CAAC,0DAAD,CA1BV;AA2BJgD,IAAAA,mBAAmB,EAAE,CAAC,2CAAD,CA3BjB;AA4BJC,IAAAA,UAAU,EAAE,CAAC,wDAAD,CA5BR;AA6BJC,IAAAA,iBAAiB,EAAE,CAAC,yCAAD,CA7Bf;AA8BJC,IAAAA,qBAAqB,EAAE,CACnB,0DADmB,EAEnB;AAAEtI,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,aAAD;AAAZ;AAAb,KAFmB,CA9BnB;AAkCJsI,IAAAA,wBAAwB,EAAE,CAAC,kBAAD,CAlCtB;AAmCJC,IAAAA,UAAU,EAAE,CAAC,wBAAD,CAnCR;AAoCJC,IAAAA,WAAW,EAAE,CAAC,kCAAD,CApCT;AAqCJC,IAAAA,sBAAsB,EAAE,CACpB,gEADoB,CArCpB;AAwCJC,IAAAA,iBAAiB,EAAE,CAAC,kCAAD,CAxCf;AAyCJC,IAAAA,iBAAiB,EAAE,CACf,wDADe,CAzCf;AA4CJC,IAAAA,cAAc,EAAE,CAAC,sCAAD,CA5CZ;AA6CJC,IAAAA,IAAI,EAAE,CAAC,sDAAD,CA7CF;AA8CJC,IAAAA,eAAe,EAAE,CACb,2DADa,CA9Cb;AAiDJC,IAAAA,eAAe,EAAE,CACb,8DADa,CAjDb;AAoDJC,IAAAA,WAAW,EAAE,CACT,kEADS,CApDT;AAuDJC,IAAAA,SAAS,EAAE,CAAC,wDAAD,CAvDP;AAwDJC,IAAAA,MAAM,EAAE,CAAC,yDAAD,CAxDJ;AAyDJhG,IAAAA,MAAM,EAAE,CAAC,mDAAD,CAzDJ;AA0DJwC,IAAAA,aAAa,EAAE,CAAC,0DAAD,CA1DX;AA2DJyD,IAAAA,WAAW,EAAE,CAAC,2CAAD,CA3DT;AA4DJC,IAAAA,eAAe,EAAE,CACb,2DADa;AA5Db,GA1YM;AA0cdC,EAAAA,QAAQ,EAAE;AACN3G,IAAAA,GAAG,EAAE,CAAC,yBAAD,CADC;AAEN4G,IAAAA,kBAAkB,EAAE,CAAC,eAAD,CAFd;AAGNxF,IAAAA,UAAU,EAAE,CAAC,mCAAD;AAHN,GA1cI;AA+cdyF,EAAAA,QAAQ,EAAE;AACNC,IAAAA,MAAM,EAAE,CAAC,gBAAD,CADF;AAENC,IAAAA,SAAS,EAAE,CACP,oBADO,EAEP;AAAEC,MAAAA,OAAO,EAAE;AAAE,wBAAgB;AAAlB;AAAX,KAFO;AAFL,GA/cI;AAsddC,EAAAA,IAAI,EAAE;AACFjH,IAAAA,GAAG,EAAE,CAAC,WAAD,CADH;AAEFkH,IAAAA,UAAU,EAAE,CAAC,cAAD,CAFV;AAGFC,IAAAA,MAAM,EAAE,CAAC,UAAD,CAHN;AAIFC,IAAAA,IAAI,EAAE,CAAC,OAAD;AAJJ,GAtdQ;AA4ddC,EAAAA,UAAU,EAAE;AACRC,IAAAA,YAAY,EAAE,CAAC,qCAAD,CADN;AAERC,IAAAA,iCAAiC,EAAE,CAC/B,gDAD+B,EAE/B;AAAElK,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAF+B,CAF3B;AAMRkK,IAAAA,mBAAmB,EAAE,CACjB,sDADiB,EAEjB;AAAEnK,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFiB,CANb;AAURmK,IAAAA,qBAAqB,EAAE,CACnB,mDADmB,EAEnB;AAAEpK,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFmB,CAVf;AAcRoK,IAAAA,8BAA8B,EAAE,CAC5B,6CAD4B,EAE5B;AAAErK,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAF4B,CAdxB;AAkBRqK,IAAAA,gBAAgB,EAAE,CAAC,0CAAD,CAlBV;AAmBRC,IAAAA,eAAe,EAAE,CAAC,kCAAD,CAnBT;AAoBRC,IAAAA,aAAa,EAAE,CAAC,8CAAD,CApBP;AAqBRC,IAAAA,6BAA6B,EAAE,CAC3B,qCAD2B,EAE3B;AAAEzK,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAF2B,CArBvB;AAyBRyK,IAAAA,eAAe,EAAE,CACb,2CADa,EAEb;AAAE1K,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFa,CAzBT;AA6BRsI,IAAAA,wBAAwB,EAAE,CACtB,sBADsB,EAEtB;AAAEvI,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFsB,CA7BlB;AAiCRuI,IAAAA,UAAU,EAAE,CACR,4BADQ,EAER;AAAExI,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFQ,CAjCJ;AAqCR0K,IAAAA,eAAe,EAAE,CACb,wDADa,EAEb;AAAE3K,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFa,CArCT;AAyCR2K,IAAAA,gBAAgB,EAAE,CACd,kDADc,EAEd;AAAE5K,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFc,CAzCV;AA6CR4K,IAAAA,eAAe,EAAE,CAAC,wDAAD,CA7CT;AA8CRC,IAAAA,gBAAgB,EAAE,CAAC,wCAAD,CA9CV;AA+CRC,IAAAA,yBAAyB,EAAE,CAAC,uBAAD,CA/CnB;AAgDRC,IAAAA,WAAW,EAAE,CAAC,6BAAD,CAhDL;AAiDRC,IAAAA,WAAW,EAAE,CAAC,kCAAD,CAjDL;AAkDRC,IAAAA,8BAA8B,EAAE,CAC5B,+DAD4B,EAE5B;AAAElL,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAF4B,CAlDxB;AAsDRkL,IAAAA,gBAAgB,EAAE,CACd,qEADc,EAEd;AAAEnL,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFc,CAtDV;AA0DRmL,IAAAA,YAAY,EAAE,CAAC,oCAAD;AA1DN,GA5dE;AAwhBdC,EAAAA,IAAI,EAAE;AACFC,IAAAA,SAAS,EAAE,CAAC,mCAAD,CADT;AAEFC,IAAAA,gBAAgB,EAAE,CAAC,mCAAD,CAFhB;AAGFC,IAAAA,sBAAsB,EAAE,CAAC,oCAAD,CAHtB;AAIFC,IAAAA,4BAA4B,EAAE,CAAC,2CAAD,CAJ5B;AAKFC,IAAAA,kCAAkC,EAAE,CAChC,kDADgC,CALlC;AAQFC,IAAAA,gBAAgB,EAAE,CAAC,8BAAD,CARhB;AASFC,IAAAA,aAAa,EAAE,CAAC,wBAAD,CATb;AAUFC,IAAAA,aAAa,EAAE,CAAC,oCAAD,CAVb;AAWFlJ,IAAAA,GAAG,EAAE,CAAC,iBAAD,CAXH;AAYFmJ,IAAAA,iCAAiC,EAAE,CAAC,kCAAD,CAZjC;AAaFC,IAAAA,oBAAoB,EAAE,CAAC,wCAAD,CAbpB;AAcFC,IAAAA,UAAU,EAAE,CAAC,iCAAD,CAdV;AAeFC,IAAAA,sBAAsB,EAAE,CAAC,wCAAD,CAftB;AAgBF/G,IAAAA,IAAI,EAAE,CAAC,oBAAD,CAhBJ;AAiBFgH,IAAAA,oBAAoB,EAAE,CAAC,+BAAD,CAjBpB;AAkBFC,IAAAA,gBAAgB,EAAE,CAAC,wBAAD,CAlBhB;AAmBF5D,IAAAA,wBAAwB,EAAE,CAAC,gBAAD,CAnBxB;AAoBFlD,IAAAA,WAAW,EAAE,CAAC,4BAAD,CApBX;AAqBF+G,IAAAA,mBAAmB,EAAE,CAAC,mDAAD,CArBnB;AAsBFC,IAAAA,WAAW,EAAE,CAAC,yBAAD,CAtBX;AAuBFC,IAAAA,mCAAmC,EAAE,CAAC,4BAAD,CAvBnC;AAwBFC,IAAAA,wBAAwB,EAAE,CAAC,uCAAD,CAxBxB;AAyBFC,IAAAA,sBAAsB,EAAE,CAAC,6BAAD,CAzBtB;AA0BFC,IAAAA,iBAAiB,EAAE,CAAC,gCAAD,CA1BjB;AA2BFC,IAAAA,YAAY,EAAE,CAAC,uBAAD,CA3BZ;AA4BFC,IAAAA,WAAW,EAAE,CAAC,wCAAD,CA5BX;AA6BFC,IAAAA,YAAY,EAAE,CAAC,uCAAD,CA7BZ;AA8BFC,IAAAA,uBAAuB,EAAE,CAAC,2CAAD,CA9BvB;AA+BFC,IAAAA,yBAAyB,EAAE,CACvB,qDADuB,CA/BzB;AAkCFC,IAAAA,0CAA0C,EAAE,CACxC,8CADwC,CAlC1C;AAqCFC,IAAAA,oBAAoB,EAAE,CAAC,wCAAD,CArCpB;AAsCFC,IAAAA,uCAAuC,EAAE,CACrC,2CADqC,CAtCvC;AAyCFC,IAAAA,WAAW,EAAE,CAAC,sCAAD,CAzCX;AA0CF/J,IAAAA,MAAM,EAAE,CAAC,mBAAD,CA1CN;AA2CFgK,IAAAA,oCAAoC,EAAE,CAClC,oCADkC,CA3CpC;AA8CFC,IAAAA,aAAa,EAAE,CAAC,mCAAD,CA9Cb;AA+CFC,IAAAA,yBAAyB,EAAE,CAAC,0CAAD;AA/CzB,GAxhBQ;AAykBdC,EAAAA,QAAQ,EAAE;AACNC,IAAAA,eAAe,EAAE,CACb,qDADa,EAEb;AAAEvN,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFa,CADX;AAKNuN,IAAAA,UAAU,EAAE,CACR,0CADQ,EAER;AAAExN,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFQ,CALN;AASNwN,IAAAA,YAAY,EAAE,CACV,qCADU,EAEV;AAAEzN,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFU,CATR;AAaNyN,IAAAA,0BAA0B,EAAE,CACxB,qBADwB,EAExB;AAAE1N,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFwB,CAbtB;AAiBN0N,IAAAA,YAAY,EAAE,CACV,2BADU,EAEV;AAAE3N,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFU,CAjBR;AAqBN2N,IAAAA,aAAa,EAAE,CACX,qCADW,EAEX;AAAE5N,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFW,CArBT;AAyBN4E,IAAAA,MAAM,EAAE,CACJ,+BADI,EAEJ;AAAE7E,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFI,CAzBF;AA6BN4N,IAAAA,UAAU,EAAE,CACR,0CADQ,EAER;AAAE7N,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFQ,CA7BN;AAiCN6N,IAAAA,YAAY,EAAE,CACV,sCADU,EAEV;AAAE9N,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFU,CAjCR;AAqCN0C,IAAAA,GAAG,EAAE,CACD,4BADC,EAED;AAAE3C,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFC,CArCC;AAyCN8N,IAAAA,OAAO,EAAE,CACL,uCADK,EAEL;AAAE/N,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFK,CAzCH;AA6CN+N,IAAAA,SAAS,EAAE,CACP,mCADO,EAEP;AAAEhO,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFO,CA7CL;AAiDNgO,IAAAA,oBAAoB,EAAE,CAClB,gEADkB,EAElB;AAAEjO,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFkB,CAjDhB;AAqDNiO,IAAAA,SAAS,EAAE,CACP,yCADO,EAEP;AAAElO,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFO,CArDL;AAyDNkO,IAAAA,iBAAiB,EAAE,CACf,0CADe,EAEf;AAAEnO,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFe,CAzDb;AA6DNmO,IAAAA,WAAW,EAAE,CACT,oCADS,EAET;AAAEpO,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFS,CA7DP;AAiENuI,IAAAA,UAAU,EAAE,CACR,0BADQ,EAER;AAAExI,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFQ,CAjEN;AAqENwI,IAAAA,WAAW,EAAE,CACT,oCADS,EAET;AAAEzI,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFS,CArEP;AAyENoF,IAAAA,WAAW,EAAE,CACT,gCADS,EAET;AAAErF,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFS,CAzEP;AA6ENoO,IAAAA,QAAQ,EAAE,CACN,8CADM,EAEN;AAAErO,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFM,CA7EJ;AAiFNqO,IAAAA,UAAU,EAAE,CACR,0CADQ,EAER;AAAEtO,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFQ,CAjFN;AAqFNsO,IAAAA,kBAAkB,EAAE,CAChB,wDADgB,EAEhB;AAAEvO,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFgB,CArFd;AAyFNkD,IAAAA,MAAM,EAAE,CACJ,8BADI,EAEJ;AAAEnD,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFI,CAzFF;AA6FNuO,IAAAA,UAAU,EAAE,CACR,yCADQ,EAER;AAAExO,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFQ,CA7FN;AAiGNwO,IAAAA,YAAY,EAAE,CACV,qCADU,EAEV;AAAEzO,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFU;AAjGR,GAzkBI;AA+qBdyO,EAAAA,KAAK,EAAE;AACHC,IAAAA,aAAa,EAAE,CAAC,qDAAD,CADZ;AAEHlM,IAAAA,MAAM,EAAE,CAAC,kCAAD,CAFL;AAGHmM,IAAAA,2BAA2B,EAAE,CACzB,8EADyB,CAH1B;AAMHC,IAAAA,YAAY,EAAE,CAAC,wDAAD,CANX;AAOHC,IAAAA,mBAAmB,EAAE,CACjB,yDADiB,CAPlB;AAUHC,IAAAA,mBAAmB,EAAE,CACjB,sEADiB,CAVlB;AAaHC,IAAAA,mBAAmB,EAAE,CACjB,0DADiB,CAblB;AAgBHC,IAAAA,aAAa,EAAE,CACX,8EADW,CAhBZ;AAmBHtM,IAAAA,GAAG,EAAE,CAAC,+CAAD,CAnBF;AAoBHuM,IAAAA,SAAS,EAAE,CACP,mEADO,CApBR;AAuBHC,IAAAA,gBAAgB,EAAE,CAAC,uDAAD,CAvBf;AAwBHjK,IAAAA,IAAI,EAAE,CAAC,iCAAD,CAxBH;AAyBHkK,IAAAA,qBAAqB,EAAE,CACnB,4EADmB,CAzBpB;AA4BHhK,IAAAA,WAAW,EAAE,CAAC,uDAAD,CA5BV;AA6BHiK,IAAAA,SAAS,EAAE,CAAC,qDAAD,CA7BR;AA8BHC,IAAAA,sBAAsB,EAAE,CACpB,mEADoB,CA9BrB;AAiCHC,IAAAA,kBAAkB,EAAE,CAChB,wDADgB,CAjCjB;AAoCHC,IAAAA,yBAAyB,EAAE,CAAC,0CAAD,CApCxB;AAqCHC,IAAAA,WAAW,EAAE,CAAC,uDAAD,CArCV;AAsCHC,IAAAA,KAAK,EAAE,CAAC,qDAAD,CAtCJ;AAuCHC,IAAAA,wBAAwB,EAAE,CACtB,sEADsB,CAvCvB;AA0CHC,IAAAA,gBAAgB,EAAE,CACd,oEADc,CA1Cf;AA6CHC,IAAAA,YAAY,EAAE,CACV,2EADU,CA7CX;AAgDH1M,IAAAA,MAAM,EAAE,CAAC,iDAAD,CAhDL;AAiDH2M,IAAAA,YAAY,EAAE,CACV,6DADU,EAEV;AAAE9P,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,QAAD;AAAZ;AAAb,KAFU,CAjDX;AAqDH8P,IAAAA,YAAY,EAAE,CACV,mEADU,CArDX;AAwDHC,IAAAA,mBAAmB,EAAE,CACjB,yDADiB;AAxDlB,GA/qBO;AA2uBdC,EAAAA,SAAS,EAAE;AAAEtN,IAAAA,GAAG,EAAE,CAAC,iBAAD;AAAP,GA3uBG;AA4uBduN,EAAAA,SAAS,EAAE;AACPC,IAAAA,sBAAsB,EAAE,CACpB,4DADoB,EAEpB;AAAEnQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFoB,CADjB;AAKPmQ,IAAAA,cAAc,EAAE,CACZ,4DADY,EAEZ;AAAEpQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFY,CALT;AASPoQ,IAAAA,qBAAqB,EAAE,CACnB,mEADmB,EAEnB;AAAErQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFmB,CAThB;AAaPqQ,IAAAA,iCAAiC,EAAE,CAC/B,kEAD+B,EAE/B;AAAEtQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAF+B,CAb5B;AAiBPsQ,IAAAA,mCAAmC,EAAE,CACjC,wGADiC,EAEjC;AAAEvQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFiC,CAjB9B;AAqBPuQ,IAAAA,4BAA4B,EAAE,CAC1B,8EAD0B,EAE1B;AAAExQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAF0B,CArBvB;AAyBPwQ,IAAAA,sBAAsB,EAAE,CACpB,4EADoB,EAEpB;AAAEzQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFoB,CAzBjB;AA6BPyQ,IAAAA,cAAc,EAAE,CACZ,4EADY,EAEZ;AAAE1Q,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFY,CA7BT;AAiCP0Q,IAAAA,qBAAqB,EAAE,CACnB,mFADmB,EAEnB;AAAE3Q,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFmB,CAjChB;AAqCP2Q,IAAAA,2BAA2B,EAAE,CACzB,kFADyB,EAEzB;AAAE5Q,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFyB,CArCtB;AAyCP4Q,IAAAA,uBAAuB,EAAE,CACrB,8FADqB,EAErB;AAAE7Q,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFqB,CAzClB;AA6CP6Q,IAAAA,8BAA8B,EAAE,CAC5B,wHAD4B,EAE5B;AAAE9Q,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAF4B,CA7CzB;AAiDP8Q,IAAAA,YAAY,EAAE,CACV,iCADU,EAEV;AAAE/Q,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFU,EAGV;AACI+Q,MAAAA,UAAU,EAAE;AADhB,KAHU,CAjDP;AAwDPC,IAAAA,oBAAoB,EAAE,CAClB,2DADkB,EAElB;AAAEjR,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFkB,CAxDf;AA4DPiR,IAAAA,YAAY,EAAE,CACV,2DADU,EAEV;AAAElR,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFU,CA5DP;AAgEPkR,IAAAA,mBAAmB,EAAE,CACjB,kEADiB,EAEjB;AAAEnR,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFiB,CAhEd;AAoEPmR,IAAAA,+BAA+B,EAAE,CAC7B,iEAD6B,EAE7B;AAAEpR,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAF6B,CApE1B;AAwEPoR,IAAAA,iCAAiC,EAAE,CAC/B,uGAD+B,EAE/B;AAAErR,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAF+B,CAxE5B;AA4EPqR,IAAAA,0BAA0B,EAAE,CACxB,6EADwB,EAExB;AAAEtR,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFwB;AA5ErB,GA5uBG;AA6zBdsR,EAAAA,KAAK,EAAE;AACHC,IAAAA,gBAAgB,EAAE,CAAC,oDAAD,CADf;AAEHC,IAAAA,wBAAwB,EAAE,CACtB,2EADsB,EAEtB,EAFsB,EAGtB;AAAEC,MAAAA,SAAS,EAAE;AAAb,KAHsB,CAFvB;AAOHnE,IAAAA,eAAe,EAAE,CAAC,oDAAD,CAPd;AAQHoE,IAAAA,sBAAsB,EAAE,CACpB,yFADoB,EAEpB,EAFoB,EAGpB;AAAED,MAAAA,SAAS,EAAE;AAAb,KAHoB,CARrB;AAaHE,IAAAA,yBAAyB,EAAE,CACvB,4EADuB,EAEvB,EAFuB,EAGvB;AAAEF,MAAAA,SAAS,EAAE;AAAb,KAHuB,CAbxB;AAkBHG,IAAAA,yBAAyB,EAAE,CACvB,4EADuB,EAEvB,EAFuB,EAGvB;AAAEH,MAAAA,SAAS,EAAE;AAAb,KAHuB,CAlBxB;AAuBHI,IAAAA,iBAAiB,EAAE,CAAC,oDAAD,CAvBhB;AAwBHC,IAAAA,wBAAwB,EAAE,CACtB,gDADsB,EAEtB;AAAE/R,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,QAAD;AAAZ;AAAb,KAFsB,CAxBvB;AA4BH+R,IAAAA,cAAc,EAAE,CAAC,mDAAD,CA5Bb;AA6BHC,IAAAA,mBAAmB,EAAE,CACjB,0DADiB,CA7BlB;AAgCHC,IAAAA,+BAA+B,EAAE,CAC7B,6EAD6B,EAE7B;AAAElS,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAF6B,CAhC9B;AAoCHkS,IAAAA,kBAAkB,EAAE,CAAC,2CAAD,CApCjB;AAqCHC,IAAAA,eAAe,EAAE,CAAC,iCAAD,CArCd;AAsCHC,IAAAA,gBAAgB,EAAE,CAAC,wCAAD,CAtCf;AAuCHC,IAAAA,sBAAsB,EAAE,CACpB,iEADoB,CAvCrB;AA0CHC,IAAAA,mBAAmB,EAAE,CAAC,uCAAD,CA1ClB;AA2CH7E,IAAAA,0BAA0B,EAAE,CAAC,kBAAD,CA3CzB;AA4CH8E,IAAAA,UAAU,EAAE,CAAC,kCAAD,CA5CT;AA6CHC,IAAAA,WAAW,EAAE,CAAC,wBAAD,CA7CV;AA8CHC,IAAAA,0BAA0B,EAAE,CAAC,2CAAD,CA9CzB;AA+CHC,IAAAA,eAAe,EAAE,CACb,kCADa,EAEb;AAAE3S,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,YAAD;AAAZ;AAAb,KAFa,CA/Cd;AAmDH2S,IAAAA,aAAa,EAAE,CAAC,qCAAD,CAnDZ;AAoDHC,IAAAA,mBAAmB,EAAE,CACjB,uDADiB,EAEjB;AAAE7S,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,UAAD;AAAZ;AAAb,KAFiB,CApDlB;AAwDH2L,IAAAA,aAAa,EAAE,CAAC,kCAAD,CAxDZ;AAyDHkH,IAAAA,iBAAiB,EAAE,CAAC,qDAAD,CAzDhB;AA0DHjO,IAAAA,MAAM,EAAE,CAAC,8BAAD,CA1DL;AA2DHkO,IAAAA,wBAAwB,EAAE,CACtB,wEADsB,CA3DvB;AA8DHC,IAAAA,2BAA2B,EAAE,CACzB,0EADyB,CA9D1B;AAiEHC,IAAAA,sBAAsB,EAAE,CACpB,2DADoB,CAjErB;AAoEHC,IAAAA,mBAAmB,EAAE,CAAC,oDAAD,CApElB;AAqEHC,IAAAA,+BAA+B,EAAE,CAC7B,+EAD6B,EAE7B;AAAEnT,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAF6B,CArE9B;AAyEHmT,IAAAA,eAAe,EAAE,CAAC,4CAAD,CAzEd;AA0EHC,IAAAA,gBAAgB,EAAE,CACd,0DADc,CA1Ef;AA6EHC,IAAAA,UAAU,EAAE,CAAC,8CAAD,CA7ET;AA8EHC,IAAAA,gBAAgB,EAAE,CACd,0DADc,CA9Ef;AAiFHC,IAAAA,eAAe,EAAE,CACb,oCADa,EAEb;AAAExT,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,YAAD;AAAZ;AAAb,KAFa,CAjFd;AAqFHwT,IAAAA,iCAAiC,EAAE,CAC/B,yFAD+B,CArFhC;AAwFHC,IAAAA,aAAa,EAAE,CAAC,oDAAD,CAxFZ;AAyFHC,IAAAA,kBAAkB,EAAE,CAChB,yDADgB,CAzFjB;AA4FH9H,IAAAA,aAAa,EAAE,CAAC,8CAAD,CA5FZ;AA6FH+H,IAAAA,6BAA6B,EAAE,CAC3B,uDAD2B,EAE3B;AAAE5T,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,QAAD;AAAZ;AAAb,KAF2B,CA7F5B;AAiGH4T,IAAAA,0BAA0B,EAAE,CACxB,mDADwB,EAExB;AAAE7T,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,QAAD;AAAZ;AAAb,KAFwB,CAjGzB;AAqGH6T,IAAAA,eAAe,EAAE,CACb,yCADa,EAEb,EAFa,EAGb;AAAEjY,MAAAA,OAAO,EAAE,CAAC,OAAD,EAAU,wBAAV;AAAX,KAHa,CArGd;AA0GHkY,IAAAA,sBAAsB,EAAE,CAAC,yCAAD,CA1GrB;AA2GHC,IAAAA,sBAAsB,EAAE,CAAC,yCAAD,CA3GrB;AA4GHC,IAAAA,4BAA4B,EAAE,CAC1B,oDAD0B,EAE1B;AAAEjU,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,QAAD;AAAZ;AAAb,KAF0B,CA5G3B;AAgHHiU,IAAAA,yBAAyB,EAAE,CACvB,gDADuB,EAEvB;AAAElU,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,QAAD;AAAZ;AAAb,KAFuB,CAhHxB;AAoHH0C,IAAAA,GAAG,EAAE,CAAC,2BAAD,CApHF;AAqHHwR,IAAAA,qBAAqB,EAAE,CACnB,qEADmB,CArHpB;AAwHHC,IAAAA,wBAAwB,EAAE,CACtB,uEADsB,CAxHvB;AA2HHC,IAAAA,yBAAyB,EAAE,CACvB,wFADuB,CA3HxB;AA8HHC,IAAAA,YAAY,EAAE,CACV,kCADU,EAEV;AAAEtU,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAFU,CA9HX;AAkIHsU,IAAAA,kCAAkC,EAAE,CAChC,0EADgC,CAlIjC;AAqIHC,IAAAA,SAAS,EAAE,CAAC,6CAAD,CArIR;AAsIHC,IAAAA,mBAAmB,EAAE,CACjB,wDADiB,CAtIlB;AAyIHC,IAAAA,SAAS,EAAE,CAAC,0CAAD,CAzIR;AA0IHC,IAAAA,qBAAqB,EAAE,CAAC,gDAAD,CA1IpB;AA2IHC,IAAAA,8BAA8B,EAAE,CAC5B,+DAD4B,CA3I7B;AA8IHC,IAAAA,uBAAuB,EAAE,CAAC,gDAAD,CA9ItB;AA+IHzO,IAAAA,SAAS,EAAE,CAAC,yCAAD,CA/IR;AAgJH0O,IAAAA,sBAAsB,EAAE,CAAC,iDAAD,CAhJrB;AAiJHC,IAAAA,gBAAgB,EAAE,CAAC,iDAAD,CAjJf;AAkJHC,IAAAA,4BAA4B,EAAE,CAC1B,4EAD0B,EAE1B;AAAEhV,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAF0B,CAlJ3B;AAsJHgV,IAAAA,0BAA0B,EAAE,CAAC,6CAAD,CAtJzB;AAuJHC,IAAAA,UAAU,EAAE,CAAC,2CAAD,CAvJT;AAwJHC,IAAAA,oBAAoB,EAAE,CAAC,8CAAD,CAxJnB;AAyJHC,IAAAA,YAAY,EAAE,CAAC,yCAAD,CAzJX;AA0JHC,IAAAA,aAAa,EAAE,CAAC,uDAAD,CA1JZ;AA2JHC,IAAAA,mBAAmB,EAAE,CACjB,4EADiB,CA3JlB;AA8JHC,IAAAA,mBAAmB,EAAE,CAAC,+CAAD,CA9JlB;AA+JHC,IAAAA,gBAAgB,EAAE,CAAC,2CAAD,CA/Jf;AAgKHC,IAAAA,QAAQ,EAAE,CAAC,iCAAD,CAhKP;AAiKHC,IAAAA,aAAa,EAAE,CAAC,mDAAD,CAjKZ;AAkKHC,IAAAA,qBAAqB,EAAE,CAAC,+CAAD,CAlKpB;AAmKHC,IAAAA,8BAA8B,EAAE,CAC5B,sFAD4B,CAnK7B;AAsKHC,IAAAA,iBAAiB,EAAE,CAAC,4CAAD,CAtKhB;AAuKHC,IAAAA,SAAS,EAAE,CAAC,kCAAD,CAvKR;AAwKHC,IAAAA,UAAU,EAAE,CAAC,iDAAD,CAxKT;AAyKHC,IAAAA,eAAe,EAAE,CAAC,sDAAD,CAzKd;AA0KHC,IAAAA,eAAe,EAAE,CAAC,+CAAD,CA1Kd;AA2KHC,IAAAA,yBAAyB,EAAE,CACvB,+EADuB,CA3KxB;AA8KHC,IAAAA,mCAAmC,EAAE,CACjC,2EADiC,CA9KlC;AAiLHC,IAAAA,WAAW,EAAE,CAAC,iDAAD,CAjLV;AAkLHC,IAAAA,eAAe,EAAE,CAAC,qDAAD,CAlLd;AAmLHC,IAAAA,mCAAmC,EAAE,CACjC,2EADiC,CAnLlC;AAsLHC,IAAAA,QAAQ,EAAE,CAAC,yCAAD,CAtLP;AAuLHvK,IAAAA,UAAU,EAAE,CAAC,2CAAD,CAvLT;AAwLHwK,IAAAA,uBAAuB,EAAE,CACrB,kDADqB,CAxLtB;AA2LHC,IAAAA,YAAY,EAAE,CAAC,oCAAD,CA3LX;AA4LHC,IAAAA,yBAAyB,EAAE,CACvB,oEADuB,EAEvB;AAAE1W,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAFuB,CA5LxB;AAgMHkO,IAAAA,iBAAiB,EAAE,CAAC,yCAAD,CAhMhB;AAiMHwI,IAAAA,qBAAqB,EAAE,CACnB,yDADmB,CAjMpB;AAoMHC,IAAAA,yBAAyB,EAAE,CAAC,oCAAD,CApMxB;AAqMHC,IAAAA,wBAAwB,EAAE,CACtB,kDADsB,CArMvB;AAwMHzR,IAAAA,WAAW,EAAE,CAAC,mCAAD,CAxMV;AAyMH0R,IAAAA,gBAAgB,EAAE,CAAC,wCAAD,CAzMf;AA0MHC,IAAAA,cAAc,EAAE,CAAC,gCAAD,CA1Mb;AA2MHC,IAAAA,sBAAsB,EAAE,CACpB,gEADoB,CA3MrB;AA8MHC,IAAAA,eAAe,EAAE,CAAC,uCAAD,CA9Md;AA+MH1O,IAAAA,wBAAwB,EAAE,CAAC,iBAAD,CA/MvB;AAgNHC,IAAAA,UAAU,EAAE,CAAC,uBAAD,CAhNT;AAiNHnD,IAAAA,WAAW,EAAE,CAAC,6BAAD,CAjNV;AAkNHC,IAAAA,SAAS,EAAE,CAAC,iCAAD,CAlNR;AAmNH4R,IAAAA,eAAe,EAAE,CAAC,uCAAD,CAnNd;AAoNHC,IAAAA,mCAAmC,EAAE,CAAC,kCAAD,CApNlC;AAqNHC,IAAAA,aAAa,EAAE,CAAC,qCAAD,CArNZ;AAsNHC,IAAAA,eAAe,EAAE,CAAC,wCAAD,CAtNd;AAuNH9R,IAAAA,UAAU,EAAE,CAAC,mBAAD,CAvNT;AAwNH+R,IAAAA,oCAAoC,EAAE,CAClC,sDADkC,EAElC;AAAEtX,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAFkC,CAxNnC;AA4NHsX,IAAAA,iBAAiB,EAAE,CACf,wDADe,CA5NhB;AA+NHC,IAAAA,YAAY,EAAE,CAAC,oCAAD,CA/NX;AAgOHC,IAAAA,QAAQ,EAAE,CAAC,gCAAD,CAhOP;AAiOHC,IAAAA,SAAS,EAAE,CAAC,iCAAD,CAjOR;AAkOHhL,IAAAA,YAAY,EAAE,CAAC,iCAAD,CAlOX;AAmOHgD,IAAAA,KAAK,EAAE,CAAC,mCAAD,CAnOJ;AAoOH/C,IAAAA,WAAW,EAAE,CAAC,kDAAD,CApOV;AAqOHgL,IAAAA,2BAA2B,EAAE,CACzB,6EADyB,EAEzB,EAFyB,EAGzB;AAAEjG,MAAAA,SAAS,EAAE;AAAb,KAHyB,CArO1B;AA0OHnD,IAAAA,kBAAkB,EAAE,CAChB,uDADgB,CA1OjB;AA6OHqJ,IAAAA,yBAAyB,EAAE,CACvB,2FADuB,EAEvB,EAFuB,EAGvB;AAAElG,MAAAA,SAAS,EAAE;AAAb,KAHuB,CA7OxB;AAkPHmG,IAAAA,2BAA2B,EAAE,CACzB,kFADyB,CAlP1B;AAqPHC,IAAAA,4BAA4B,EAAE,CAC1B,8EAD0B,EAE1B,EAF0B,EAG1B;AAAEpG,MAAAA,SAAS,EAAE;AAAb,KAH0B,CArP3B;AA0PHqG,IAAAA,4BAA4B,EAAE,CAC1B,8EAD0B,EAE1B,EAF0B,EAG1B;AAAErG,MAAAA,SAAS,EAAE;AAAb,KAH0B,CA1P3B;AA+PHsG,IAAAA,gBAAgB,EAAE,CACd,kCADc,EAEd;AAAEhY,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAFc,CA/Pf;AAmQHgY,IAAAA,iBAAiB,EAAE,CAAC,yCAAD,CAnQhB;AAoQHC,IAAAA,wBAAwB,EAAE,CACtB,wEADsB,CApQvB;AAuQHC,IAAAA,wBAAwB,EAAE,CACtB,0EADsB,EAEtB,EAFsB,EAGtB;AAAEzG,MAAAA,SAAS,EAAE;AAAb,KAHsB,CAvQvB;AA4QH0G,IAAAA,sBAAsB,EAAE,CACpB,wFADoB,EAEpB,EAFoB,EAGpB;AAAE1G,MAAAA,SAAS,EAAE;AAAb,KAHoB,CA5QrB;AAiRH2G,IAAAA,yBAAyB,EAAE,CACvB,2EADuB,EAEvB,EAFuB,EAGvB;AAAE3G,MAAAA,SAAS,EAAE;AAAb,KAHuB,CAjRxB;AAsRH4G,IAAAA,yBAAyB,EAAE,CACvB,2EADuB,EAEvB,EAFuB,EAGvB;AAAE5G,MAAAA,SAAS,EAAE;AAAb,KAHuB,CAtRxB;AA2RH6G,IAAAA,eAAe,EAAE,CAAC,kDAAD,CA3Rd;AA4RHC,IAAAA,QAAQ,EAAE,CAAC,qCAAD,CA5RP;AA6RHrV,IAAAA,MAAM,EAAE,CAAC,6BAAD,CA7RL;AA8RHsV,IAAAA,sBAAsB,EAAE,CACpB,wDADoB,CA9RrB;AAiSHC,IAAAA,mBAAmB,EAAE,CAAC,mDAAD,CAjSlB;AAkSHC,IAAAA,+BAA+B,EAAE,CAAC,iCAAD,CAlS9B;AAmSHC,IAAAA,gBAAgB,EAAE,CACd,yDADc,CAnSf;AAsSHC,IAAAA,iCAAiC,EAAE,CAC/B,wFAD+B,CAtShC;AAySHC,IAAAA,aAAa,EAAE,CAAC,mDAAD,CAzSZ;AA0SHC,IAAAA,kBAAkB,EAAE,CAChB,wDADgB,CA1SjB;AA6SHC,IAAAA,0BAA0B,EAAE,CACxB,iFADwB,EAExB,EAFwB,EAGxB;AAAEnd,MAAAA,OAAO,EAAE,CAAC,OAAD,EAAU,6BAAV;AAAX,KAHwB,CA7SzB;AAkTHod,IAAAA,2BAA2B,EAAE,CACzB,iFADyB,CAlT1B;AAqTH7L,IAAAA,aAAa,EAAE,CAAC,6CAAD,CArTZ;AAsTH8L,IAAAA,0BAA0B,EAAE,CACxB,oDADwB,CAtTzB;AAyTHC,IAAAA,kBAAkB,EAAE,CAChB,sEADgB,EAEhB;AAAEC,MAAAA,OAAO,EAAE;AAAX,KAFgB;AAzTjB,GA7zBO;AA2nCdC,EAAAA,MAAM,EAAE;AACJC,IAAAA,IAAI,EAAE,CAAC,kBAAD,CADF;AAEJC,IAAAA,OAAO,EAAE,CAAC,qBAAD,EAAwB;AAAEvZ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAAxB,CAFL;AAGJuZ,IAAAA,qBAAqB,EAAE,CAAC,oBAAD,CAHnB;AAIJC,IAAAA,MAAM,EAAE,CAAC,oBAAD,CAJJ;AAKJlI,IAAAA,KAAK,EAAE,CAAC,0BAAD,CALH;AAMJmI,IAAAA,MAAM,EAAE,CAAC,oBAAD,EAAuB;AAAE1Z,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAAvB,CANJ;AAOJ0Z,IAAAA,KAAK,EAAE,CAAC,mBAAD;AAPH,GA3nCM;AAooCdC,EAAAA,cAAc,EAAE;AACZvW,IAAAA,QAAQ,EAAE,CACN,iEADM,CADE;AAIZG,IAAAA,iBAAiB,EAAE,CAAC,kDAAD,CAJP;AAKZE,IAAAA,WAAW,EAAE,CACT,mEADS;AALD,GApoCF;AA6oCdmW,EAAAA,KAAK,EAAE;AACHC,IAAAA,iCAAiC,EAAE,CAC/B,0DAD+B,CADhC;AAIHC,IAAAA,kCAAkC,EAAE,CAChC,yDADgC,EAEhC;AAAE/Z,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFgC,CAJjC;AAQH+Z,IAAAA,+BAA+B,EAAE,CAC7B,wDAD6B,CAR9B;AAWHC,IAAAA,+BAA+B,EAAE,CAC7B,yDAD6B,EAE7B;AAAEja,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAF6B,CAX9B;AAeHia,IAAAA,4BAA4B,EAAE,CAC1B,wDAD0B,CAf3B;AAkBHzX,IAAAA,MAAM,EAAE,CAAC,wBAAD,CAlBL;AAmBH0X,IAAAA,4BAA4B,EAAE,CAC1B,6EAD0B,CAnB3B;AAsBHC,IAAAA,qBAAqB,EAAE,CAAC,gDAAD,CAtBpB;AAuBHC,IAAAA,4BAA4B,EAAE,CAC1B,gGAD0B,CAvB3B;AA0BHC,IAAAA,qBAAqB,EAAE,CACnB,sEADmB,CA1BpB;AA6BHC,IAAAA,WAAW,EAAE,CAAC,sCAAD,CA7BV;AA8BHC,IAAAA,SAAS,EAAE,CAAC,mCAAD,CA9BR;AA+BHC,IAAAA,yBAAyB,EAAE,CACvB,6FADuB,CA/BxB;AAkCHC,IAAAA,kBAAkB,EAAE,CAChB,mEADgB,CAlCjB;AAqCHC,IAAAA,yBAAyB,EAAE,CACvB,0DADuB,CArCxB;AAwCHzV,IAAAA,IAAI,EAAE,CAAC,uBAAD,CAxCH;AAyCH0V,IAAAA,cAAc,EAAE,CAAC,yCAAD,CAzCb;AA0CHC,IAAAA,2BAA2B,EAAE,CACzB,4EADyB,CA1C1B;AA6CHC,IAAAA,oBAAoB,EAAE,CAAC,+CAAD,CA7CnB;AA8CHvS,IAAAA,wBAAwB,EAAE,CAAC,iBAAD,CA9CvB;AA+CHwS,IAAAA,gBAAgB,EAAE,CAAC,2CAAD,CA/Cf;AAgDHC,IAAAA,2BAA2B,EAAE,CACzB,+CADyB,CAhD1B;AAmDHC,IAAAA,iBAAiB,EAAE,CACf,4CADe,EAEf;AAAEjb,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFe,CAnDhB;AAuDHib,IAAAA,cAAc,EAAE,CAAC,yCAAD,CAvDb;AAwDHC,IAAAA,4BAA4B,EAAE,CAC1B,6DAD0B,CAxD3B;AA2DHC,IAAAA,kBAAkB,EAAE,CAChB,4DADgB,CA3DjB;AA8DHC,IAAAA,eAAe,EAAE,CACb,2DADa,CA9Dd;AAiEHC,IAAAA,4BAA4B,EAAE,CAC1B,+FAD0B,CAjE3B;AAoEHC,IAAAA,qBAAqB,EAAE,CACnB,qEADmB,CApEpB;AAuEHC,IAAAA,WAAW,EAAE,CAAC,qCAAD;AAvEV,GA7oCO;AAstCd7B,EAAAA,KAAK,EAAE;AACH8B,IAAAA,wBAAwB,EAAE,CAAC,mBAAD,CADvB;AAEHC,IAAAA,KAAK,EAAE,CAAC,6BAAD,CAFJ;AAGHC,IAAAA,YAAY,EAAE,CAAC,6BAAD,CAHX;AAIHC,IAAAA,qBAAqB,EAAE,CAAC,+CAAD,CAJpB;AAKHC,IAAAA,oCAAoC,EAAE,CAAC,gCAAD,CALnC;AAMHC,IAAAA,4BAA4B,EAAE,CAAC,qBAAD,CAN3B;AAOHC,IAAAA,kCAAkC,EAAE,CAAC,iBAAD,CAPjC;AAQHC,IAAAA,2BAA2B,EAAE,CAAC,qBAAD,CAR1B;AASHC,IAAAA,4BAA4B,EAAE,CAAC,oCAAD,CAT3B;AAUHC,IAAAA,kCAAkC,EAAE,CAAC,4BAAD,CAVjC;AAWHC,IAAAA,MAAM,EAAE,CAAC,gCAAD,CAXL;AAYH5b,IAAAA,gBAAgB,EAAE,CAAC,WAAD,CAZf;AAaH6b,IAAAA,aAAa,EAAE,CAAC,uBAAD,CAbZ;AAcHC,IAAAA,iBAAiB,EAAE,CAAC,iCAAD,CAdhB;AAeHC,IAAAA,yBAAyB,EAAE,CAAC,iCAAD,CAfxB;AAgBHC,IAAAA,+BAA+B,EAAE,CAAC,yBAAD,CAhB9B;AAiBHrX,IAAAA,IAAI,EAAE,CAAC,YAAD,CAjBH;AAkBHsX,IAAAA,0BAA0B,EAAE,CAAC,kBAAD,CAlBzB;AAmBHC,IAAAA,0BAA0B,EAAE,CAAC,kBAAD,CAnBzB;AAoBHC,IAAAA,2BAA2B,EAAE,CAAC,qBAAD,CApB1B;AAqBHC,IAAAA,iCAAiC,EAAE,CAAC,qBAAD,CArBhC;AAsBHC,IAAAA,oBAAoB,EAAE,CAAC,iCAAD,CAtBnB;AAuBHC,IAAAA,oBAAoB,EAAE,CAAC,iCAAD,CAvBnB;AAwBHC,IAAAA,2BAA2B,EAAE,CAAC,oBAAD,CAxB1B;AAyBHC,IAAAA,kBAAkB,EAAE,CAAC,gCAAD,CAzBjB;AA0BHC,IAAAA,gCAAgC,EAAE,CAAC,yBAAD,CA1B/B;AA2BHC,IAAAA,qBAAqB,EAAE,CAAC,4BAAD,CA3BpB;AA4BHC,IAAAA,iCAAiC,EAAE,CAAC,gBAAD,CA5BhC;AA6BHC,IAAAA,yCAAyC,EAAE,CAAC,8BAAD,CA7BxC;AA8BHC,IAAAA,OAAO,EAAE,CAAC,gCAAD,CA9BN;AA+BHC,IAAAA,QAAQ,EAAE,CAAC,mCAAD,CA/BP;AAgCHC,IAAAA,mBAAmB,EAAE,CAAC,aAAD;AAhClB;AAttCO,CAAlB;;ACAO,MAAMC,OAAO,GAAG,mBAAhB;;ACAA,SAASC,kBAAT,CAA4BC,OAA5B,EAAqCC,YAArC,EAAmD;AACtD,QAAMC,UAAU,GAAG,EAAnB;;AACA,OAAK,MAAM,CAACC,KAAD,EAAQC,SAAR,CAAX,IAAiCC,MAAM,CAACC,OAAP,CAAeL,YAAf,CAAjC,EAA+D;AAC3D,SAAK,MAAM,CAACM,UAAD,EAAaC,QAAb,CAAX,IAAqCH,MAAM,CAACC,OAAP,CAAeF,SAAf,CAArC,EAAgE;AAC5D,YAAM,CAACK,KAAD,EAAQC,QAAR,EAAkBC,WAAlB,IAAiCH,QAAvC;AACA,YAAM,CAACI,MAAD,EAASC,GAAT,IAAgBJ,KAAK,CAACK,KAAN,CAAY,GAAZ,CAAtB;AACA,YAAMC,gBAAgB,GAAGV,MAAM,CAACW,MAAP,CAAc;AAAEJ,QAAAA,MAAF;AAAUC,QAAAA;AAAV,OAAd,EAA+BH,QAA/B,CAAzB;;AACA,UAAI,CAACR,UAAU,CAACC,KAAD,CAAf,EAAwB;AACpBD,QAAAA,UAAU,CAACC,KAAD,CAAV,GAAoB,EAApB;AACH;;AACD,YAAMc,YAAY,GAAGf,UAAU,CAACC,KAAD,CAA/B;;AACA,UAAIQ,WAAJ,EAAiB;AACbM,QAAAA,YAAY,CAACV,UAAD,CAAZ,GAA2BW,QAAQ,CAAClB,OAAD,EAAUG,KAAV,EAAiBI,UAAjB,EAA6BQ,gBAA7B,EAA+CJ,WAA/C,CAAnC;AACA;AACH;;AACDM,MAAAA,YAAY,CAACV,UAAD,CAAZ,GAA2BP,OAAO,CAACmB,OAAR,CAAgBT,QAAhB,CAAyBK,gBAAzB,CAA3B;AACH;AACJ;;AACD,SAAOb,UAAP;AACH;;AACD,SAASgB,QAAT,CAAkBlB,OAAlB,EAA2BG,KAA3B,EAAkCI,UAAlC,EAA8CG,QAA9C,EAAwDC,WAAxD,EAAqE;AACjE,QAAMS,mBAAmB,GAAGpB,OAAO,CAACmB,OAAR,CAAgBT,QAAhB,CAAyBA,QAAzB,CAA5B;AACA;;AACA,WAASW,eAAT,CAAyB,GAAGC,IAA5B,EAAkC;AAC9B;AACA,QAAIC,OAAO,GAAGH,mBAAmB,CAACZ,QAApB,CAA6BvO,KAA7B,CAAmC,GAAGqP,IAAtC,CAAd,CAF8B;;AAI9B,QAAIX,WAAW,CAAC1M,SAAhB,EAA2B;AACvBsN,MAAAA,OAAO,GAAGlB,MAAM,CAACW,MAAP,CAAc,EAAd,EAAkBO,OAAlB,EAA2B;AACjCC,QAAAA,IAAI,EAAED,OAAO,CAACZ,WAAW,CAAC1M,SAAb,CADoB;AAEjC,SAAC0M,WAAW,CAAC1M,SAAb,GAAyBwN;AAFQ,OAA3B,CAAV;AAIA,aAAOL,mBAAmB,CAACG,OAAD,CAA1B;AACH;;AACD,QAAIZ,WAAW,CAACviB,OAAhB,EAAyB;AACrB,YAAM,CAACsjB,QAAD,EAAWC,aAAX,IAA4BhB,WAAW,CAACviB,OAA9C;AACA4hB,MAAAA,OAAO,CAAC4B,GAAR,CAAYC,IAAZ,CAAkB,WAAU1B,KAAM,IAAGI,UAAW,kCAAiCmB,QAAS,IAAGC,aAAc,IAA3G;AACH;;AACD,QAAIhB,WAAW,CAACpN,UAAhB,EAA4B;AACxByM,MAAAA,OAAO,CAAC4B,GAAR,CAAYC,IAAZ,CAAiBlB,WAAW,CAACpN,UAA7B;AACH;;AACD,QAAIoN,WAAW,CAAC9a,iBAAhB,EAAmC;AAC/B;AACA,YAAM0b,OAAO,GAAGH,mBAAmB,CAACZ,QAApB,CAA6BvO,KAA7B,CAAmC,GAAGqP,IAAtC,CAAhB;;AACA,WAAK,MAAM,CAACQ,IAAD,EAAOC,KAAP,CAAX,IAA4B1B,MAAM,CAACC,OAAP,CAAeK,WAAW,CAAC9a,iBAA3B,CAA5B,EAA2E;AACvE,YAAIic,IAAI,IAAIP,OAAZ,EAAqB;AACjBvB,UAAAA,OAAO,CAAC4B,GAAR,CAAYC,IAAZ,CAAkB,IAAGC,IAAK,0CAAyC3B,KAAM,IAAGI,UAAW,aAAYwB,KAAM,WAAzG;;AACA,cAAI,EAAEA,KAAK,IAAIR,OAAX,CAAJ,EAAyB;AACrBA,YAAAA,OAAO,CAACQ,KAAD,CAAP,GAAiBR,OAAO,CAACO,IAAD,CAAxB;AACH;;AACD,iBAAOP,OAAO,CAACO,IAAD,CAAd;AACH;AACJ;;AACD,aAAOV,mBAAmB,CAACG,OAAD,CAA1B;AACH,KA/B6B;;;AAiC9B,WAAOH,mBAAmB,CAAC,GAAGE,IAAJ,CAA1B;AACH;;AACD,SAAOjB,MAAM,CAACW,MAAP,CAAcK,eAAd,EAA+BD,mBAA/B,CAAP;AACH;;ACxDD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA,AAAO,SAASY,mBAAT,CAA6BhC,OAA7B,EAAsC;AACzC,SAAOD,kBAAkB,CAACC,OAAD,EAAUiC,SAAV,CAAzB;AACH;AACDD,mBAAmB,CAAClC,OAApB,GAA8BA,OAA9B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/endpoints-to-methods.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/endpoints-to-methods.js new file mode 100644 index 0000000..32c2f39 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/endpoints-to-methods.js @@ -0,0 +1,60 @@ +export function endpointsToMethods(octokit, endpointsMap) { + const newMethods = {}; + for (const [scope, endpoints] of Object.entries(endpointsMap)) { + for (const [methodName, endpoint] of Object.entries(endpoints)) { + const [route, defaults, decorations] = endpoint; + const [method, url] = route.split(/ /); + const endpointDefaults = Object.assign({ method, url }, defaults); + if (!newMethods[scope]) { + newMethods[scope] = {}; + } + const scopeMethods = newMethods[scope]; + if (decorations) { + scopeMethods[methodName] = decorate(octokit, scope, methodName, endpointDefaults, decorations); + continue; + } + scopeMethods[methodName] = octokit.request.defaults(endpointDefaults); + } + } + return newMethods; +} +function decorate(octokit, scope, methodName, defaults, decorations) { + const requestWithDefaults = octokit.request.defaults(defaults); + /* istanbul ignore next */ + function withDecorations(...args) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + let options = requestWithDefaults.endpoint.merge(...args); + // There are currently no other decorations than `.mapToData` + if (decorations.mapToData) { + options = Object.assign({}, options, { + data: options[decorations.mapToData], + [decorations.mapToData]: undefined, + }); + return requestWithDefaults(options); + } + if (decorations.renamed) { + const [newScope, newMethodName] = decorations.renamed; + octokit.log.warn(`octokit.${scope}.${methodName}() has been renamed to octokit.${newScope}.${newMethodName}()`); + } + if (decorations.deprecated) { + octokit.log.warn(decorations.deprecated); + } + if (decorations.renamedParameters) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + const options = requestWithDefaults.endpoint.merge(...args); + for (const [name, alias] of Object.entries(decorations.renamedParameters)) { + if (name in options) { + octokit.log.warn(`"${name}" parameter is deprecated for "octokit.${scope}.${methodName}()". Use "${alias}" instead`); + if (!(alias in options)) { + options[alias] = options[name]; + } + delete options[name]; + } + } + return requestWithDefaults(options); + } + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + return requestWithDefaults(...args); + } + return Object.assign(withDecorations, requestWithDefaults); +} diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/endpoints.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/endpoints.js new file mode 100644 index 0000000..4eaf395 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/endpoints.js @@ -0,0 +1,1274 @@ +const Endpoints = { + actions: { + addSelectedRepoToOrgSecret: [ + "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + ], + cancelWorkflowRun: [ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel", + ], + createOrUpdateOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}"], + createOrUpdateRepoSecret: [ + "PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}", + ], + createRegistrationTokenForOrg: [ + "POST /orgs/{org}/actions/runners/registration-token", + ], + createRegistrationTokenForRepo: [ + "POST /repos/{owner}/{repo}/actions/runners/registration-token", + ], + createRemoveTokenForOrg: ["POST /orgs/{org}/actions/runners/remove-token"], + createRemoveTokenForRepo: [ + "POST /repos/{owner}/{repo}/actions/runners/remove-token", + ], + createWorkflowDispatch: [ + "POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", + ], + deleteArtifact: [ + "DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}", + ], + deleteOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}"], + deleteRepoSecret: [ + "DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}", + ], + deleteSelfHostedRunnerFromOrg: [ + "DELETE /orgs/{org}/actions/runners/{runner_id}", + ], + deleteSelfHostedRunnerFromRepo: [ + "DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}", + ], + deleteWorkflowRun: ["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}"], + deleteWorkflowRunLogs: [ + "DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs", + ], + disableSelectedRepositoryGithubActionsOrganization: [ + "DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}", + ], + disableWorkflow: [ + "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", + ], + downloadArtifact: [ + "GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", + ], + downloadJobLogsForWorkflowRun: [ + "GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs", + ], + downloadWorkflowRunLogs: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs", + ], + enableSelectedRepositoryGithubActionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/repositories/{repository_id}", + ], + enableWorkflow: [ + "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", + ], + getAllowedActionsOrganization: [ + "GET /orgs/{org}/actions/permissions/selected-actions", + ], + getAllowedActionsRepository: [ + "GET /repos/{owner}/{repo}/actions/permissions/selected-actions", + ], + getArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"], + getGithubActionsPermissionsOrganization: [ + "GET /orgs/{org}/actions/permissions", + ], + getGithubActionsPermissionsRepository: [ + "GET /repos/{owner}/{repo}/actions/permissions", + ], + getJobForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"], + getOrgPublicKey: ["GET /orgs/{org}/actions/secrets/public-key"], + getOrgSecret: ["GET /orgs/{org}/actions/secrets/{secret_name}"], + getRepoPermissions: [ + "GET /repos/{owner}/{repo}/actions/permissions", + {}, + { renamed: ["actions", "getGithubActionsPermissionsRepository"] }, + ], + getRepoPublicKey: ["GET /repos/{owner}/{repo}/actions/secrets/public-key"], + getRepoSecret: ["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"], + getSelfHostedRunnerForOrg: ["GET /orgs/{org}/actions/runners/{runner_id}"], + getSelfHostedRunnerForRepo: [ + "GET /repos/{owner}/{repo}/actions/runners/{runner_id}", + ], + getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], + getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], + getWorkflowRunUsage: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing", + ], + getWorkflowUsage: [ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", + ], + listArtifactsForRepo: ["GET /repos/{owner}/{repo}/actions/artifacts"], + listJobsForWorkflowRun: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", + ], + listOrgSecrets: ["GET /orgs/{org}/actions/secrets"], + listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], + listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], + listRunnerApplicationsForOrg: ["GET /orgs/{org}/actions/runners/downloads"], + listRunnerApplicationsForRepo: [ + "GET /repos/{owner}/{repo}/actions/runners/downloads", + ], + listSelectedReposForOrgSecret: [ + "GET /orgs/{org}/actions/secrets/{secret_name}/repositories", + ], + listSelectedRepositoriesEnabledGithubActionsOrganization: [ + "GET /orgs/{org}/actions/permissions/repositories", + ], + listSelfHostedRunnersForOrg: ["GET /orgs/{org}/actions/runners"], + listSelfHostedRunnersForRepo: ["GET /repos/{owner}/{repo}/actions/runners"], + listWorkflowRunArtifacts: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", + ], + listWorkflowRuns: [ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", + ], + listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"], + reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"], + removeSelectedRepoFromOrgSecret: [ + "DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + ], + setAllowedActionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/selected-actions", + ], + setAllowedActionsRepository: [ + "PUT /repos/{owner}/{repo}/actions/permissions/selected-actions", + ], + setGithubActionsPermissionsOrganization: [ + "PUT /orgs/{org}/actions/permissions", + ], + setGithubActionsPermissionsRepository: [ + "PUT /repos/{owner}/{repo}/actions/permissions", + ], + setSelectedReposForOrgSecret: [ + "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories", + ], + setSelectedRepositoriesEnabledGithubActionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/repositories", + ], + }, + activity: { + checkRepoIsStarredByAuthenticatedUser: ["GET /user/starred/{owner}/{repo}"], + deleteRepoSubscription: ["DELETE /repos/{owner}/{repo}/subscription"], + deleteThreadSubscription: [ + "DELETE /notifications/threads/{thread_id}/subscription", + ], + getFeeds: ["GET /feeds"], + getRepoSubscription: ["GET /repos/{owner}/{repo}/subscription"], + getThread: ["GET /notifications/threads/{thread_id}"], + getThreadSubscriptionForAuthenticatedUser: [ + "GET /notifications/threads/{thread_id}/subscription", + ], + listEventsForAuthenticatedUser: ["GET /users/{username}/events"], + listNotificationsForAuthenticatedUser: ["GET /notifications"], + listOrgEventsForAuthenticatedUser: [ + "GET /users/{username}/events/orgs/{org}", + ], + listPublicEvents: ["GET /events"], + listPublicEventsForRepoNetwork: ["GET /networks/{owner}/{repo}/events"], + listPublicEventsForUser: ["GET /users/{username}/events/public"], + listPublicOrgEvents: ["GET /orgs/{org}/events"], + listReceivedEventsForUser: ["GET /users/{username}/received_events"], + listReceivedPublicEventsForUser: [ + "GET /users/{username}/received_events/public", + ], + listRepoEvents: ["GET /repos/{owner}/{repo}/events"], + listRepoNotificationsForAuthenticatedUser: [ + "GET /repos/{owner}/{repo}/notifications", + ], + listReposStarredByAuthenticatedUser: ["GET /user/starred"], + listReposStarredByUser: ["GET /users/{username}/starred"], + listReposWatchedByUser: ["GET /users/{username}/subscriptions"], + listStargazersForRepo: ["GET /repos/{owner}/{repo}/stargazers"], + listWatchedReposForAuthenticatedUser: ["GET /user/subscriptions"], + listWatchersForRepo: ["GET /repos/{owner}/{repo}/subscribers"], + markNotificationsAsRead: ["PUT /notifications"], + markRepoNotificationsAsRead: ["PUT /repos/{owner}/{repo}/notifications"], + markThreadAsRead: ["PATCH /notifications/threads/{thread_id}"], + setRepoSubscription: ["PUT /repos/{owner}/{repo}/subscription"], + setThreadSubscription: [ + "PUT /notifications/threads/{thread_id}/subscription", + ], + starRepoForAuthenticatedUser: ["PUT /user/starred/{owner}/{repo}"], + unstarRepoForAuthenticatedUser: ["DELETE /user/starred/{owner}/{repo}"], + }, + apps: { + addRepoToInstallation: [ + "PUT /user/installations/{installation_id}/repositories/{repository_id}", + ], + checkToken: ["POST /applications/{client_id}/token"], + createContentAttachment: [ + "POST /content_references/{content_reference_id}/attachments", + { mediaType: { previews: ["corsair"] } }, + ], + createFromManifest: ["POST /app-manifests/{code}/conversions"], + createInstallationAccessToken: [ + "POST /app/installations/{installation_id}/access_tokens", + ], + deleteAuthorization: ["DELETE /applications/{client_id}/grant"], + deleteInstallation: ["DELETE /app/installations/{installation_id}"], + deleteToken: ["DELETE /applications/{client_id}/token"], + getAuthenticated: ["GET /app"], + getBySlug: ["GET /apps/{app_slug}"], + getInstallation: ["GET /app/installations/{installation_id}"], + getOrgInstallation: ["GET /orgs/{org}/installation"], + getRepoInstallation: ["GET /repos/{owner}/{repo}/installation"], + getSubscriptionPlanForAccount: [ + "GET /marketplace_listing/accounts/{account_id}", + ], + getSubscriptionPlanForAccountStubbed: [ + "GET /marketplace_listing/stubbed/accounts/{account_id}", + ], + getUserInstallation: ["GET /users/{username}/installation"], + getWebhookConfigForApp: ["GET /app/hook/config"], + listAccountsForPlan: ["GET /marketplace_listing/plans/{plan_id}/accounts"], + listAccountsForPlanStubbed: [ + "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts", + ], + listInstallationReposForAuthenticatedUser: [ + "GET /user/installations/{installation_id}/repositories", + ], + listInstallations: ["GET /app/installations"], + listInstallationsForAuthenticatedUser: ["GET /user/installations"], + listPlans: ["GET /marketplace_listing/plans"], + listPlansStubbed: ["GET /marketplace_listing/stubbed/plans"], + listReposAccessibleToInstallation: ["GET /installation/repositories"], + listSubscriptionsForAuthenticatedUser: ["GET /user/marketplace_purchases"], + listSubscriptionsForAuthenticatedUserStubbed: [ + "GET /user/marketplace_purchases/stubbed", + ], + removeRepoFromInstallation: [ + "DELETE /user/installations/{installation_id}/repositories/{repository_id}", + ], + resetToken: ["PATCH /applications/{client_id}/token"], + revokeInstallationAccessToken: ["DELETE /installation/token"], + scopeToken: ["POST /applications/{client_id}/token/scoped"], + suspendInstallation: ["PUT /app/installations/{installation_id}/suspended"], + unsuspendInstallation: [ + "DELETE /app/installations/{installation_id}/suspended", + ], + updateWebhookConfigForApp: ["PATCH /app/hook/config"], + }, + billing: { + getGithubActionsBillingOrg: ["GET /orgs/{org}/settings/billing/actions"], + getGithubActionsBillingUser: [ + "GET /users/{username}/settings/billing/actions", + ], + getGithubPackagesBillingOrg: ["GET /orgs/{org}/settings/billing/packages"], + getGithubPackagesBillingUser: [ + "GET /users/{username}/settings/billing/packages", + ], + getSharedStorageBillingOrg: [ + "GET /orgs/{org}/settings/billing/shared-storage", + ], + getSharedStorageBillingUser: [ + "GET /users/{username}/settings/billing/shared-storage", + ], + }, + checks: { + create: ["POST /repos/{owner}/{repo}/check-runs"], + createSuite: ["POST /repos/{owner}/{repo}/check-suites"], + get: ["GET /repos/{owner}/{repo}/check-runs/{check_run_id}"], + getSuite: ["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}"], + listAnnotations: [ + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + ], + listForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"], + listForSuite: [ + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + ], + listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"], + rerequestSuite: [ + "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", + ], + setSuitesPreferences: [ + "PATCH /repos/{owner}/{repo}/check-suites/preferences", + ], + update: ["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"], + }, + codeScanning: { + getAlert: [ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + {}, + { renamedParameters: { alert_id: "alert_number" } }, + ], + listAlertsForRepo: ["GET /repos/{owner}/{repo}/code-scanning/alerts"], + listRecentAnalyses: ["GET /repos/{owner}/{repo}/code-scanning/analyses"], + updateAlert: [ + "PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + ], + uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"], + }, + codesOfConduct: { + getAllCodesOfConduct: [ + "GET /codes_of_conduct", + { mediaType: { previews: ["scarlet-witch"] } }, + ], + getConductCode: [ + "GET /codes_of_conduct/{key}", + { mediaType: { previews: ["scarlet-witch"] } }, + ], + getForRepo: [ + "GET /repos/{owner}/{repo}/community/code_of_conduct", + { mediaType: { previews: ["scarlet-witch"] } }, + ], + }, + emojis: { get: ["GET /emojis"] }, + enterpriseAdmin: { + disableSelectedOrganizationGithubActionsEnterprise: [ + "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + ], + enableSelectedOrganizationGithubActionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + ], + getAllowedActionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions/selected-actions", + ], + getGithubActionsPermissionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions", + ], + listSelectedOrganizationsEnabledGithubActionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions/organizations", + ], + setAllowedActionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/selected-actions", + ], + setGithubActionsPermissionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions", + ], + setSelectedOrganizationsEnabledGithubActionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/organizations", + ], + }, + gists: { + checkIsStarred: ["GET /gists/{gist_id}/star"], + create: ["POST /gists"], + createComment: ["POST /gists/{gist_id}/comments"], + delete: ["DELETE /gists/{gist_id}"], + deleteComment: ["DELETE /gists/{gist_id}/comments/{comment_id}"], + fork: ["POST /gists/{gist_id}/forks"], + get: ["GET /gists/{gist_id}"], + getComment: ["GET /gists/{gist_id}/comments/{comment_id}"], + getRevision: ["GET /gists/{gist_id}/{sha}"], + list: ["GET /gists"], + listComments: ["GET /gists/{gist_id}/comments"], + listCommits: ["GET /gists/{gist_id}/commits"], + listForUser: ["GET /users/{username}/gists"], + listForks: ["GET /gists/{gist_id}/forks"], + listPublic: ["GET /gists/public"], + listStarred: ["GET /gists/starred"], + star: ["PUT /gists/{gist_id}/star"], + unstar: ["DELETE /gists/{gist_id}/star"], + update: ["PATCH /gists/{gist_id}"], + updateComment: ["PATCH /gists/{gist_id}/comments/{comment_id}"], + }, + git: { + createBlob: ["POST /repos/{owner}/{repo}/git/blobs"], + createCommit: ["POST /repos/{owner}/{repo}/git/commits"], + createRef: ["POST /repos/{owner}/{repo}/git/refs"], + createTag: ["POST /repos/{owner}/{repo}/git/tags"], + createTree: ["POST /repos/{owner}/{repo}/git/trees"], + deleteRef: ["DELETE /repos/{owner}/{repo}/git/refs/{ref}"], + getBlob: ["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"], + getCommit: ["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"], + getRef: ["GET /repos/{owner}/{repo}/git/ref/{ref}"], + getTag: ["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"], + getTree: ["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"], + listMatchingRefs: ["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"], + updateRef: ["PATCH /repos/{owner}/{repo}/git/refs/{ref}"], + }, + gitignore: { + getAllTemplates: ["GET /gitignore/templates"], + getTemplate: ["GET /gitignore/templates/{name}"], + }, + interactions: { + getRestrictionsForOrg: ["GET /orgs/{org}/interaction-limits"], + getRestrictionsForRepo: ["GET /repos/{owner}/{repo}/interaction-limits"], + getRestrictionsForYourPublicRepos: ["GET /user/interaction-limits"], + removeRestrictionsForOrg: ["DELETE /orgs/{org}/interaction-limits"], + removeRestrictionsForRepo: [ + "DELETE /repos/{owner}/{repo}/interaction-limits", + ], + removeRestrictionsForYourPublicRepos: ["DELETE /user/interaction-limits"], + setRestrictionsForOrg: ["PUT /orgs/{org}/interaction-limits"], + setRestrictionsForRepo: ["PUT /repos/{owner}/{repo}/interaction-limits"], + setRestrictionsForYourPublicRepos: ["PUT /user/interaction-limits"], + }, + issues: { + addAssignees: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/assignees", + ], + addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"], + checkUserCanBeAssigned: ["GET /repos/{owner}/{repo}/assignees/{assignee}"], + create: ["POST /repos/{owner}/{repo}/issues"], + createComment: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/comments", + ], + createLabel: ["POST /repos/{owner}/{repo}/labels"], + createMilestone: ["POST /repos/{owner}/{repo}/milestones"], + deleteComment: [ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}", + ], + deleteLabel: ["DELETE /repos/{owner}/{repo}/labels/{name}"], + deleteMilestone: [ + "DELETE /repos/{owner}/{repo}/milestones/{milestone_number}", + ], + get: ["GET /repos/{owner}/{repo}/issues/{issue_number}"], + getComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"], + getEvent: ["GET /repos/{owner}/{repo}/issues/events/{event_id}"], + getLabel: ["GET /repos/{owner}/{repo}/labels/{name}"], + getMilestone: ["GET /repos/{owner}/{repo}/milestones/{milestone_number}"], + list: ["GET /issues"], + listAssignees: ["GET /repos/{owner}/{repo}/assignees"], + listComments: ["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"], + listCommentsForRepo: ["GET /repos/{owner}/{repo}/issues/comments"], + listEvents: ["GET /repos/{owner}/{repo}/issues/{issue_number}/events"], + listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"], + listEventsForTimeline: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", + { mediaType: { previews: ["mockingbird"] } }, + ], + listForAuthenticatedUser: ["GET /user/issues"], + listForOrg: ["GET /orgs/{org}/issues"], + listForRepo: ["GET /repos/{owner}/{repo}/issues"], + listLabelsForMilestone: [ + "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels", + ], + listLabelsForRepo: ["GET /repos/{owner}/{repo}/labels"], + listLabelsOnIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/labels", + ], + listMilestones: ["GET /repos/{owner}/{repo}/milestones"], + lock: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"], + removeAllLabels: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels", + ], + removeAssignees: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees", + ], + removeLabel: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", + ], + setLabels: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"], + unlock: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"], + update: ["PATCH /repos/{owner}/{repo}/issues/{issue_number}"], + updateComment: ["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"], + updateLabel: ["PATCH /repos/{owner}/{repo}/labels/{name}"], + updateMilestone: [ + "PATCH /repos/{owner}/{repo}/milestones/{milestone_number}", + ], + }, + licenses: { + get: ["GET /licenses/{license}"], + getAllCommonlyUsed: ["GET /licenses"], + getForRepo: ["GET /repos/{owner}/{repo}/license"], + }, + markdown: { + render: ["POST /markdown"], + renderRaw: [ + "POST /markdown/raw", + { headers: { "content-type": "text/plain; charset=utf-8" } }, + ], + }, + meta: { + get: ["GET /meta"], + getOctocat: ["GET /octocat"], + getZen: ["GET /zen"], + root: ["GET /"], + }, + migrations: { + cancelImport: ["DELETE /repos/{owner}/{repo}/import"], + deleteArchiveForAuthenticatedUser: [ + "DELETE /user/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + deleteArchiveForOrg: [ + "DELETE /orgs/{org}/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + downloadArchiveForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + getArchiveForAuthenticatedUser: [ + "GET /user/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"], + getImportStatus: ["GET /repos/{owner}/{repo}/import"], + getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"], + getStatusForAuthenticatedUser: [ + "GET /user/migrations/{migration_id}", + { mediaType: { previews: ["wyandotte"] } }, + ], + getStatusForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}", + { mediaType: { previews: ["wyandotte"] } }, + ], + listForAuthenticatedUser: [ + "GET /user/migrations", + { mediaType: { previews: ["wyandotte"] } }, + ], + listForOrg: [ + "GET /orgs/{org}/migrations", + { mediaType: { previews: ["wyandotte"] } }, + ], + listReposForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}/repositories", + { mediaType: { previews: ["wyandotte"] } }, + ], + listReposForUser: [ + "GET /user/migrations/{migration_id}/repositories", + { mediaType: { previews: ["wyandotte"] } }, + ], + mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"], + setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"], + startForAuthenticatedUser: ["POST /user/migrations"], + startForOrg: ["POST /orgs/{org}/migrations"], + startImport: ["PUT /repos/{owner}/{repo}/import"], + unlockRepoForAuthenticatedUser: [ + "DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock", + { mediaType: { previews: ["wyandotte"] } }, + ], + unlockRepoForOrg: [ + "DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", + { mediaType: { previews: ["wyandotte"] } }, + ], + updateImport: ["PATCH /repos/{owner}/{repo}/import"], + }, + orgs: { + blockUser: ["PUT /orgs/{org}/blocks/{username}"], + checkBlockedUser: ["GET /orgs/{org}/blocks/{username}"], + checkMembershipForUser: ["GET /orgs/{org}/members/{username}"], + checkPublicMembershipForUser: ["GET /orgs/{org}/public_members/{username}"], + convertMemberToOutsideCollaborator: [ + "PUT /orgs/{org}/outside_collaborators/{username}", + ], + createInvitation: ["POST /orgs/{org}/invitations"], + createWebhook: ["POST /orgs/{org}/hooks"], + deleteWebhook: ["DELETE /orgs/{org}/hooks/{hook_id}"], + get: ["GET /orgs/{org}"], + getMembershipForAuthenticatedUser: ["GET /user/memberships/orgs/{org}"], + getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], + getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], + getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"], + list: ["GET /organizations"], + listAppInstallations: ["GET /orgs/{org}/installations"], + listBlockedUsers: ["GET /orgs/{org}/blocks"], + listForAuthenticatedUser: ["GET /user/orgs"], + listForUser: ["GET /users/{username}/orgs"], + listInvitationTeams: ["GET /orgs/{org}/invitations/{invitation_id}/teams"], + listMembers: ["GET /orgs/{org}/members"], + listMembershipsForAuthenticatedUser: ["GET /user/memberships/orgs"], + listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], + listPendingInvitations: ["GET /orgs/{org}/invitations"], + listPublicMembers: ["GET /orgs/{org}/public_members"], + listWebhooks: ["GET /orgs/{org}/hooks"], + pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], + removeMember: ["DELETE /orgs/{org}/members/{username}"], + removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"], + removeOutsideCollaborator: [ + "DELETE /orgs/{org}/outside_collaborators/{username}", + ], + removePublicMembershipForAuthenticatedUser: [ + "DELETE /orgs/{org}/public_members/{username}", + ], + setMembershipForUser: ["PUT /orgs/{org}/memberships/{username}"], + setPublicMembershipForAuthenticatedUser: [ + "PUT /orgs/{org}/public_members/{username}", + ], + unblockUser: ["DELETE /orgs/{org}/blocks/{username}"], + update: ["PATCH /orgs/{org}"], + updateMembershipForAuthenticatedUser: [ + "PATCH /user/memberships/orgs/{org}", + ], + updateWebhook: ["PATCH /orgs/{org}/hooks/{hook_id}"], + updateWebhookConfigForOrg: ["PATCH /orgs/{org}/hooks/{hook_id}/config"], + }, + projects: { + addCollaborator: [ + "PUT /projects/{project_id}/collaborators/{username}", + { mediaType: { previews: ["inertia"] } }, + ], + createCard: [ + "POST /projects/columns/{column_id}/cards", + { mediaType: { previews: ["inertia"] } }, + ], + createColumn: [ + "POST /projects/{project_id}/columns", + { mediaType: { previews: ["inertia"] } }, + ], + createForAuthenticatedUser: [ + "POST /user/projects", + { mediaType: { previews: ["inertia"] } }, + ], + createForOrg: [ + "POST /orgs/{org}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + createForRepo: [ + "POST /repos/{owner}/{repo}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + delete: [ + "DELETE /projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + deleteCard: [ + "DELETE /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } }, + ], + deleteColumn: [ + "DELETE /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } }, + ], + get: [ + "GET /projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + getCard: [ + "GET /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } }, + ], + getColumn: [ + "GET /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } }, + ], + getPermissionForUser: [ + "GET /projects/{project_id}/collaborators/{username}/permission", + { mediaType: { previews: ["inertia"] } }, + ], + listCards: [ + "GET /projects/columns/{column_id}/cards", + { mediaType: { previews: ["inertia"] } }, + ], + listCollaborators: [ + "GET /projects/{project_id}/collaborators", + { mediaType: { previews: ["inertia"] } }, + ], + listColumns: [ + "GET /projects/{project_id}/columns", + { mediaType: { previews: ["inertia"] } }, + ], + listForOrg: [ + "GET /orgs/{org}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + listForRepo: [ + "GET /repos/{owner}/{repo}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + listForUser: [ + "GET /users/{username}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + moveCard: [ + "POST /projects/columns/cards/{card_id}/moves", + { mediaType: { previews: ["inertia"] } }, + ], + moveColumn: [ + "POST /projects/columns/{column_id}/moves", + { mediaType: { previews: ["inertia"] } }, + ], + removeCollaborator: [ + "DELETE /projects/{project_id}/collaborators/{username}", + { mediaType: { previews: ["inertia"] } }, + ], + update: [ + "PATCH /projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + updateCard: [ + "PATCH /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } }, + ], + updateColumn: [ + "PATCH /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } }, + ], + }, + pulls: { + checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + create: ["POST /repos/{owner}/{repo}/pulls"], + createReplyForReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", + ], + createReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + createReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments", + ], + deletePendingReview: [ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + ], + deleteReviewComment: [ + "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}", + ], + dismissReview: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", + ], + get: ["GET /repos/{owner}/{repo}/pulls/{pull_number}"], + getReview: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + ], + getReviewComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"], + list: ["GET /repos/{owner}/{repo}/pulls"], + listCommentsForReview: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", + ], + listCommits: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"], + listFiles: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"], + listRequestedReviewers: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + ], + listReviewComments: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments", + ], + listReviewCommentsForRepo: ["GET /repos/{owner}/{repo}/pulls/comments"], + listReviews: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + merge: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + removeRequestedReviewers: [ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + ], + requestReviewers: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + ], + submitReview: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", + ], + update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"], + updateBranch: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch", + { mediaType: { previews: ["lydian"] } }, + ], + updateReview: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + ], + updateReviewComment: [ + "PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}", + ], + }, + rateLimit: { get: ["GET /rate_limit"] }, + reactions: { + createForCommitComment: [ + "POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForIssue: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForIssueComment: [ + "POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForPullRequestReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForTeamDiscussionCommentInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForTeamDiscussionInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForCommitComment: [ + "DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForIssue: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForIssueComment: [ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForPullRequestComment: [ + "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForTeamDiscussion: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForTeamDiscussionComment: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteLegacy: [ + "DELETE /reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + { + deprecated: "octokit.reactions.deleteLegacy() is deprecated, see https://docs.github.com/v3/reactions/#delete-a-reaction-legacy", + }, + ], + listForCommitComment: [ + "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForIssueComment: [ + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForPullRequestReviewComment: [ + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForTeamDiscussionCommentInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForTeamDiscussionInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + }, + repos: { + acceptInvitation: ["PATCH /user/repository_invitations/{invitation_id}"], + addAppAccessRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" }, + ], + addCollaborator: ["PUT /repos/{owner}/{repo}/collaborators/{username}"], + addStatusCheckContexts: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" }, + ], + addTeamAccessRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" }, + ], + addUserAccessRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" }, + ], + checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], + checkVulnerabilityAlerts: [ + "GET /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } }, + ], + compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], + createCommitComment: [ + "POST /repos/{owner}/{repo}/commits/{commit_sha}/comments", + ], + createCommitSignatureProtection: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } }, + ], + createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"], + createDeployKey: ["POST /repos/{owner}/{repo}/keys"], + createDeployment: ["POST /repos/{owner}/{repo}/deployments"], + createDeploymentStatus: [ + "POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + ], + createDispatchEvent: ["POST /repos/{owner}/{repo}/dispatches"], + createForAuthenticatedUser: ["POST /user/repos"], + createFork: ["POST /repos/{owner}/{repo}/forks"], + createInOrg: ["POST /orgs/{org}/repos"], + createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], + createPagesSite: [ + "POST /repos/{owner}/{repo}/pages", + { mediaType: { previews: ["switcheroo"] } }, + ], + createRelease: ["POST /repos/{owner}/{repo}/releases"], + createUsingTemplate: [ + "POST /repos/{template_owner}/{template_repo}/generate", + { mediaType: { previews: ["baptiste"] } }, + ], + createWebhook: ["POST /repos/{owner}/{repo}/hooks"], + declineInvitation: ["DELETE /user/repository_invitations/{invitation_id}"], + delete: ["DELETE /repos/{owner}/{repo}"], + deleteAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + ], + deleteAdminBranchProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + ], + deleteBranchProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection", + ], + deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"], + deleteCommitSignatureProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } }, + ], + deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"], + deleteDeployment: [ + "DELETE /repos/{owner}/{repo}/deployments/{deployment_id}", + ], + deleteFile: ["DELETE /repos/{owner}/{repo}/contents/{path}"], + deleteInvitation: [ + "DELETE /repos/{owner}/{repo}/invitations/{invitation_id}", + ], + deletePagesSite: [ + "DELETE /repos/{owner}/{repo}/pages", + { mediaType: { previews: ["switcheroo"] } }, + ], + deletePullRequestReviewProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + ], + deleteRelease: ["DELETE /repos/{owner}/{repo}/releases/{release_id}"], + deleteReleaseAsset: [ + "DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}", + ], + deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], + disableAutomatedSecurityFixes: [ + "DELETE /repos/{owner}/{repo}/automated-security-fixes", + { mediaType: { previews: ["london"] } }, + ], + disableVulnerabilityAlerts: [ + "DELETE /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } }, + ], + downloadArchive: [ + "GET /repos/{owner}/{repo}/zipball/{ref}", + {}, + { renamed: ["repos", "downloadZipballArchive"] }, + ], + downloadTarballArchive: ["GET /repos/{owner}/{repo}/tarball/{ref}"], + downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"], + enableAutomatedSecurityFixes: [ + "PUT /repos/{owner}/{repo}/automated-security-fixes", + { mediaType: { previews: ["london"] } }, + ], + enableVulnerabilityAlerts: [ + "PUT /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } }, + ], + get: ["GET /repos/{owner}/{repo}"], + getAccessRestrictions: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + ], + getAdminBranchProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + ], + getAllStatusCheckContexts: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + ], + getAllTopics: [ + "GET /repos/{owner}/{repo}/topics", + { mediaType: { previews: ["mercy"] } }, + ], + getAppsWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + ], + getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"], + getBranchProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection", + ], + getClones: ["GET /repos/{owner}/{repo}/traffic/clones"], + getCodeFrequencyStats: ["GET /repos/{owner}/{repo}/stats/code_frequency"], + getCollaboratorPermissionLevel: [ + "GET /repos/{owner}/{repo}/collaborators/{username}/permission", + ], + getCombinedStatusForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/status"], + getCommit: ["GET /repos/{owner}/{repo}/commits/{ref}"], + getCommitActivityStats: ["GET /repos/{owner}/{repo}/stats/commit_activity"], + getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"], + getCommitSignatureProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } }, + ], + getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"], + getContent: ["GET /repos/{owner}/{repo}/contents/{path}"], + getContributorsStats: ["GET /repos/{owner}/{repo}/stats/contributors"], + getDeployKey: ["GET /repos/{owner}/{repo}/keys/{key_id}"], + getDeployment: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}"], + getDeploymentStatus: [ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", + ], + getLatestPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/latest"], + getLatestRelease: ["GET /repos/{owner}/{repo}/releases/latest"], + getPages: ["GET /repos/{owner}/{repo}/pages"], + getPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/{build_id}"], + getParticipationStats: ["GET /repos/{owner}/{repo}/stats/participation"], + getPullRequestReviewProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + ], + getPunchCardStats: ["GET /repos/{owner}/{repo}/stats/punch_card"], + getReadme: ["GET /repos/{owner}/{repo}/readme"], + getRelease: ["GET /repos/{owner}/{repo}/releases/{release_id}"], + getReleaseAsset: ["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"], + getReleaseByTag: ["GET /repos/{owner}/{repo}/releases/tags/{tag}"], + getStatusChecksProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + ], + getTeamsWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + ], + getTopPaths: ["GET /repos/{owner}/{repo}/traffic/popular/paths"], + getTopReferrers: ["GET /repos/{owner}/{repo}/traffic/popular/referrers"], + getUsersWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + ], + getViews: ["GET /repos/{owner}/{repo}/traffic/views"], + getWebhook: ["GET /repos/{owner}/{repo}/hooks/{hook_id}"], + getWebhookConfigForRepo: [ + "GET /repos/{owner}/{repo}/hooks/{hook_id}/config", + ], + listBranches: ["GET /repos/{owner}/{repo}/branches"], + listBranchesForHeadCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", + { mediaType: { previews: ["groot"] } }, + ], + listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"], + listCommentsForCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments", + ], + listCommitCommentsForRepo: ["GET /repos/{owner}/{repo}/comments"], + listCommitStatusesForRef: [ + "GET /repos/{owner}/{repo}/commits/{ref}/statuses", + ], + listCommits: ["GET /repos/{owner}/{repo}/commits"], + listContributors: ["GET /repos/{owner}/{repo}/contributors"], + listDeployKeys: ["GET /repos/{owner}/{repo}/keys"], + listDeploymentStatuses: [ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + ], + listDeployments: ["GET /repos/{owner}/{repo}/deployments"], + listForAuthenticatedUser: ["GET /user/repos"], + listForOrg: ["GET /orgs/{org}/repos"], + listForUser: ["GET /users/{username}/repos"], + listForks: ["GET /repos/{owner}/{repo}/forks"], + listInvitations: ["GET /repos/{owner}/{repo}/invitations"], + listInvitationsForAuthenticatedUser: ["GET /user/repository_invitations"], + listLanguages: ["GET /repos/{owner}/{repo}/languages"], + listPagesBuilds: ["GET /repos/{owner}/{repo}/pages/builds"], + listPublic: ["GET /repositories"], + listPullRequestsAssociatedWithCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", + { mediaType: { previews: ["groot"] } }, + ], + listReleaseAssets: [ + "GET /repos/{owner}/{repo}/releases/{release_id}/assets", + ], + listReleases: ["GET /repos/{owner}/{repo}/releases"], + listTags: ["GET /repos/{owner}/{repo}/tags"], + listTeams: ["GET /repos/{owner}/{repo}/teams"], + listWebhooks: ["GET /repos/{owner}/{repo}/hooks"], + merge: ["POST /repos/{owner}/{repo}/merges"], + pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"], + removeAppAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" }, + ], + removeCollaborator: [ + "DELETE /repos/{owner}/{repo}/collaborators/{username}", + ], + removeStatusCheckContexts: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" }, + ], + removeStatusCheckProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + ], + removeTeamAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" }, + ], + removeUserAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" }, + ], + replaceAllTopics: [ + "PUT /repos/{owner}/{repo}/topics", + { mediaType: { previews: ["mercy"] } }, + ], + requestPagesBuild: ["POST /repos/{owner}/{repo}/pages/builds"], + setAdminBranchProtection: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + ], + setAppAccessRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" }, + ], + setStatusCheckContexts: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" }, + ], + setTeamAccessRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" }, + ], + setUserAccessRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" }, + ], + testPushWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"], + transfer: ["POST /repos/{owner}/{repo}/transfer"], + update: ["PATCH /repos/{owner}/{repo}"], + updateBranchProtection: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection", + ], + updateCommitComment: ["PATCH /repos/{owner}/{repo}/comments/{comment_id}"], + updateInformationAboutPagesSite: ["PUT /repos/{owner}/{repo}/pages"], + updateInvitation: [ + "PATCH /repos/{owner}/{repo}/invitations/{invitation_id}", + ], + updatePullRequestReviewProtection: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + ], + updateRelease: ["PATCH /repos/{owner}/{repo}/releases/{release_id}"], + updateReleaseAsset: [ + "PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}", + ], + updateStatusCheckPotection: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + {}, + { renamed: ["repos", "updateStatusCheckProtection"] }, + ], + updateStatusCheckProtection: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + ], + updateWebhook: ["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"], + updateWebhookConfigForRepo: [ + "PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config", + ], + uploadReleaseAsset: [ + "POST /repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", + { baseUrl: "https://uploads.github.com" }, + ], + }, + search: { + code: ["GET /search/code"], + commits: ["GET /search/commits", { mediaType: { previews: ["cloak"] } }], + issuesAndPullRequests: ["GET /search/issues"], + labels: ["GET /search/labels"], + repos: ["GET /search/repositories"], + topics: ["GET /search/topics", { mediaType: { previews: ["mercy"] } }], + users: ["GET /search/users"], + }, + secretScanning: { + getAlert: [ + "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", + ], + listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], + updateAlert: [ + "PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", + ], + }, + teams: { + addOrUpdateMembershipForUserInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/memberships/{username}", + ], + addOrUpdateProjectPermissionsInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + addOrUpdateRepoPermissionsInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + ], + checkPermissionsForProjectInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + checkPermissionsForRepoInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + ], + create: ["POST /orgs/{org}/teams"], + createDiscussionCommentInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + ], + createDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions"], + deleteDiscussionCommentInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + ], + deleteDiscussionInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + ], + deleteInOrg: ["DELETE /orgs/{org}/teams/{team_slug}"], + getByName: ["GET /orgs/{org}/teams/{team_slug}"], + getDiscussionCommentInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + ], + getDiscussionInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + ], + getMembershipForUserInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/memberships/{username}", + ], + list: ["GET /orgs/{org}/teams"], + listChildInOrg: ["GET /orgs/{org}/teams/{team_slug}/teams"], + listDiscussionCommentsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + ], + listDiscussionsInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions"], + listForAuthenticatedUser: ["GET /user/teams"], + listMembersInOrg: ["GET /orgs/{org}/teams/{team_slug}/members"], + listPendingInvitationsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/invitations", + ], + listProjectsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], + removeMembershipForUserInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}", + ], + removeProjectInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}", + ], + removeRepoInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + ], + updateDiscussionCommentInOrg: [ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + ], + updateDiscussionInOrg: [ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + ], + updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"], + }, + users: { + addEmailForAuthenticated: ["POST /user/emails"], + block: ["PUT /user/blocks/{username}"], + checkBlocked: ["GET /user/blocks/{username}"], + checkFollowingForUser: ["GET /users/{username}/following/{target_user}"], + checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"], + createGpgKeyForAuthenticated: ["POST /user/gpg_keys"], + createPublicSshKeyForAuthenticated: ["POST /user/keys"], + deleteEmailForAuthenticated: ["DELETE /user/emails"], + deleteGpgKeyForAuthenticated: ["DELETE /user/gpg_keys/{gpg_key_id}"], + deletePublicSshKeyForAuthenticated: ["DELETE /user/keys/{key_id}"], + follow: ["PUT /user/following/{username}"], + getAuthenticated: ["GET /user"], + getByUsername: ["GET /users/{username}"], + getContextForUser: ["GET /users/{username}/hovercard"], + getGpgKeyForAuthenticated: ["GET /user/gpg_keys/{gpg_key_id}"], + getPublicSshKeyForAuthenticated: ["GET /user/keys/{key_id}"], + list: ["GET /users"], + listBlockedByAuthenticated: ["GET /user/blocks"], + listEmailsForAuthenticated: ["GET /user/emails"], + listFollowedByAuthenticated: ["GET /user/following"], + listFollowersForAuthenticatedUser: ["GET /user/followers"], + listFollowersForUser: ["GET /users/{username}/followers"], + listFollowingForUser: ["GET /users/{username}/following"], + listGpgKeysForAuthenticated: ["GET /user/gpg_keys"], + listGpgKeysForUser: ["GET /users/{username}/gpg_keys"], + listPublicEmailsForAuthenticated: ["GET /user/public_emails"], + listPublicKeysForUser: ["GET /users/{username}/keys"], + listPublicSshKeysForAuthenticated: ["GET /user/keys"], + setPrimaryEmailVisibilityForAuthenticated: ["PATCH /user/email/visibility"], + unblock: ["DELETE /user/blocks/{username}"], + unfollow: ["DELETE /user/following/{username}"], + updateAuthenticated: ["PATCH /user"], + }, +}; +export default Endpoints; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/method-types.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/method-types.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/method-types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/parameters-and-response-types.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/parameters-and-response-types.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/parameters-and-response-types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/index.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/index.js new file mode 100644 index 0000000..0535b19 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/index.js @@ -0,0 +1,17 @@ +import ENDPOINTS from "./generated/endpoints"; +import { VERSION } from "./version"; +import { endpointsToMethods } from "./endpoints-to-methods"; +/** + * This plugin is a 1:1 copy of internal @octokit/rest plugins. The primary + * goal is to rebuild @octokit/rest on top of @octokit/core. Once that is + * done, we will remove the registerEndpoints methods and return the methods + * directly as with the other plugins. At that point we will also remove the + * legacy workarounds and deprecations. + * + * See the plan at + * https://github.com/octokit/plugin-rest-endpoint-methods.js/pull/1 + */ +export function restEndpointMethods(octokit) { + return endpointsToMethods(octokit, ENDPOINTS); +} +restEndpointMethods.VERSION = VERSION; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/types.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/types.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/version.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/version.js new file mode 100644 index 0000000..4efcb01 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "4.5.2"; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/endpoints-to-methods.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/endpoints-to-methods.d.ts new file mode 100644 index 0000000..2a97a4b --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/endpoints-to-methods.d.ts @@ -0,0 +1,4 @@ +import { Octokit } from "@octokit/core"; +import { EndpointsDefaultsAndDecorations } from "./types"; +import { RestEndpointMethods } from "./generated/method-types"; +export declare function endpointsToMethods(octokit: Octokit, endpointsMap: EndpointsDefaultsAndDecorations): RestEndpointMethods; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/endpoints.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/endpoints.d.ts new file mode 100644 index 0000000..a3c1d92 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/endpoints.d.ts @@ -0,0 +1,3 @@ +import { EndpointsDefaultsAndDecorations } from "../types"; +declare const Endpoints: EndpointsDefaultsAndDecorations; +export default Endpoints; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types.d.ts new file mode 100644 index 0000000..2c62e8d --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types.d.ts @@ -0,0 +1,7093 @@ +import { EndpointInterface, RequestInterface } from "@octokit/types"; +import { RestEndpointMethodTypes } from "./parameters-and-response-types"; +export declare type RestEndpointMethods = { + actions: { + /** + * Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + addSelectedRepoToOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["addSelectedRepoToOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + cancelWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["cancelWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates or updates an organization secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to + * use this endpoint. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + createOrUpdateOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["createOrUpdateOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates or updates a repository secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use + * this endpoint. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + createOrUpdateRepoSecret: { + (params?: RestEndpointMethodTypes["actions"]["createOrUpdateRepoSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` + */ + createRegistrationTokenForOrg: { + (params?: RestEndpointMethodTypes["actions"]["createRegistrationTokenForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate + * using an access token with the `repo` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN + * ``` + */ + createRegistrationTokenForRepo: { + (params?: RestEndpointMethodTypes["actions"]["createRegistrationTokenForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this + * endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + createRemoveTokenForOrg: { + (params?: RestEndpointMethodTypes["actions"]["createRemoveTokenForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + createRemoveTokenForRepo: { + (params?: RestEndpointMethodTypes["actions"]["createRemoveTokenForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + */ + createWorkflowDispatch: { + (params?: RestEndpointMethodTypes["actions"]["createWorkflowDispatch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + deleteArtifact: { + (params?: RestEndpointMethodTypes["actions"]["deleteArtifact"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + deleteOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["deleteOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. + */ + deleteRepoSecret: { + (params?: RestEndpointMethodTypes["actions"]["deleteRepoSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + deleteSelfHostedRunnerFromOrg: { + (params?: RestEndpointMethodTypes["actions"]["deleteSelfHostedRunnerFromOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + * + * You must authenticate using an access token with the `repo` + * scope to use this endpoint. + */ + deleteSelfHostedRunnerFromRepo: { + (params?: RestEndpointMethodTypes["actions"]["deleteSelfHostedRunnerFromRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is + * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use + * this endpoint. + */ + deleteWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["deleteWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + deleteWorkflowRunLogs: { + (params?: RestEndpointMethodTypes["actions"]["deleteWorkflowRunLogs"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + disableSelectedRepositoryGithubActionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["disableSelectedRepositoryGithubActionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + disableWorkflow: { + (params?: RestEndpointMethodTypes["actions"]["disableWorkflow"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in + * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to + * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + * GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + downloadArtifact: { + (params?: RestEndpointMethodTypes["actions"]["downloadArtifact"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look + * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can + * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must + * have the `actions:read` permission to use this endpoint. + */ + downloadJobLogsForWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["downloadJobLogsForWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for + * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use + * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have + * the `actions:read` permission to use this endpoint. + */ + downloadWorkflowRunLogs: { + (params?: RestEndpointMethodTypes["actions"]["downloadWorkflowRunLogs"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + enableSelectedRepositoryGithubActionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["enableSelectedRepositoryGithubActionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + enableWorkflow: { + (params?: RestEndpointMethodTypes["actions"]["enableWorkflow"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + getAllowedActionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["getAllowedActionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + */ + getAllowedActionsRepository: { + (params?: RestEndpointMethodTypes["actions"]["getAllowedActionsRepository"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + getArtifact: { + (params?: RestEndpointMethodTypes["actions"]["getArtifact"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + getGithubActionsPermissionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["getGithubActionsPermissionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. GitHub Apps must have the `administration` repository permission to use this API. + */ + getGithubActionsPermissionsRepository: { + (params?: RestEndpointMethodTypes["actions"]["getGithubActionsPermissionsRepository"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + getJobForWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["getJobForWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + getOrgPublicKey: { + (params?: RestEndpointMethodTypes["actions"]["getOrgPublicKey"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + getOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["getOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * @deprecated octokit.actions.getRepoPermissions() has been renamed to octokit.actions.getGithubActionsPermissionsRepository() (2020-11-10) + */ + getRepoPermissions: { + (params?: RestEndpointMethodTypes["actions"]["getRepoPermissions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint. + */ + getRepoPublicKey: { + (params?: RestEndpointMethodTypes["actions"]["getRepoPublicKey"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. + */ + getRepoSecret: { + (params?: RestEndpointMethodTypes["actions"]["getRepoSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific self-hosted runner configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + getSelfHostedRunnerForOrg: { + (params?: RestEndpointMethodTypes["actions"]["getSelfHostedRunnerForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific self-hosted runner configured in a repository. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. + */ + getSelfHostedRunnerForRepo: { + (params?: RestEndpointMethodTypes["actions"]["getSelfHostedRunnerForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + getWorkflow: { + (params?: RestEndpointMethodTypes["actions"]["getWorkflow"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + getWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["getWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + getWorkflowRunUsage: { + (params?: RestEndpointMethodTypes["actions"]["getWorkflowRunUsage"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + getWorkflowUsage: { + (params?: RestEndpointMethodTypes["actions"]["getWorkflowUsage"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + listArtifactsForRepo: { + (params?: RestEndpointMethodTypes["actions"]["listArtifactsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + */ + listJobsForWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["listJobsForWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + listOrgSecrets: { + (params?: RestEndpointMethodTypes["actions"]["listOrgSecrets"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint. + */ + listRepoSecrets: { + (params?: RestEndpointMethodTypes["actions"]["listRepoSecrets"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + listRepoWorkflows: { + (params?: RestEndpointMethodTypes["actions"]["listRepoWorkflows"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + listRunnerApplicationsForOrg: { + (params?: RestEndpointMethodTypes["actions"]["listRunnerApplicationsForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + */ + listRunnerApplicationsForRepo: { + (params?: RestEndpointMethodTypes["actions"]["listRunnerApplicationsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + listSelectedReposForOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["listSelectedReposForOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + listSelectedRepositoriesEnabledGithubActionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["listSelectedRepositoriesEnabledGithubActionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all self-hosted runners configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + listSelfHostedRunnersForOrg: { + (params?: RestEndpointMethodTypes["actions"]["listSelfHostedRunnersForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. + */ + listSelfHostedRunnersForRepo: { + (params?: RestEndpointMethodTypes["actions"]["listSelfHostedRunnersForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + listWorkflowRunArtifacts: { + (params?: RestEndpointMethodTypes["actions"]["listWorkflowRunArtifacts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * + * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + */ + listWorkflowRuns: { + (params?: RestEndpointMethodTypes["actions"]["listWorkflowRuns"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * + * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + */ + listWorkflowRunsForRepo: { + (params?: RestEndpointMethodTypes["actions"]["listWorkflowRunsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + reRunWorkflow: { + (params?: RestEndpointMethodTypes["actions"]["reRunWorkflow"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + removeSelectedRepoFromOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["removeSelectedRepoFromOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + * + * To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + setAllowedActionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["setAllowedActionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + * + * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + * + * To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + */ + setAllowedActionsRepository: { + (params?: RestEndpointMethodTypes["actions"]["setAllowedActionsRepository"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + * + * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + setGithubActionsPermissionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["setGithubActionsPermissionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. + * + * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + */ + setGithubActionsPermissionsRepository: { + (params?: RestEndpointMethodTypes["actions"]["setGithubActionsPermissionsRepository"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint. + */ + setSelectedReposForOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["setSelectedReposForOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + */ + setSelectedRepositoriesEnabledGithubActionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["setSelectedRepositoriesEnabledGithubActionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + activity: { + checkRepoIsStarredByAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["checkRepoIsStarredByAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). + */ + deleteRepoSubscription: { + (params?: RestEndpointMethodTypes["activity"]["deleteRepoSubscription"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. + */ + deleteThreadSubscription: { + (params?: RestEndpointMethodTypes["activity"]["deleteThreadSubscription"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + * + * * **Timeline**: The GitHub global public timeline + * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + * * **Current user public**: The public timeline for the authenticated user + * * **Current user**: The private timeline for the authenticated user + * * **Current user actor**: The private timeline for activity created by the authenticated user + * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. + * + * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + */ + getFeeds: { + (params?: RestEndpointMethodTypes["activity"]["getFeeds"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getRepoSubscription: { + (params?: RestEndpointMethodTypes["activity"]["getRepoSubscription"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getThread: { + (params?: RestEndpointMethodTypes["activity"]["getThread"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). + * + * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + */ + getThreadSubscriptionForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["getThreadSubscriptionForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + */ + listEventsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["listEventsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all notifications for the current user, sorted by most recently updated. + */ + listNotificationsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["listNotificationsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This is the user's organization dashboard. You must be authenticated as the user to view this. + */ + listOrgEventsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["listOrgEventsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + */ + listPublicEvents: { + (params?: RestEndpointMethodTypes["activity"]["listPublicEvents"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listPublicEventsForRepoNetwork: { + (params?: RestEndpointMethodTypes["activity"]["listPublicEventsForRepoNetwork"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listPublicEventsForUser: { + (params?: RestEndpointMethodTypes["activity"]["listPublicEventsForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listPublicOrgEvents: { + (params?: RestEndpointMethodTypes["activity"]["listPublicOrgEvents"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + */ + listReceivedEventsForUser: { + (params?: RestEndpointMethodTypes["activity"]["listReceivedEventsForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listReceivedPublicEventsForUser: { + (params?: RestEndpointMethodTypes["activity"]["listReceivedPublicEventsForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listRepoEvents: { + (params?: RestEndpointMethodTypes["activity"]["listRepoEvents"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all notifications for the current user. + */ + listRepoNotificationsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["listRepoNotificationsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists repositories the authenticated user has starred. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + listReposStarredByAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["listReposStarredByAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists repositories a user has starred. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + listReposStarredByUser: { + (params?: RestEndpointMethodTypes["activity"]["listReposStarredByUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists repositories a user is watching. + */ + listReposWatchedByUser: { + (params?: RestEndpointMethodTypes["activity"]["listReposWatchedByUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the people that have starred the repository. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + listStargazersForRepo: { + (params?: RestEndpointMethodTypes["activity"]["listStargazersForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists repositories the authenticated user is watching. + */ + listWatchedReposForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["listWatchedReposForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the people watching the specified repository. + */ + listWatchersForRepo: { + (params?: RestEndpointMethodTypes["activity"]["listWatchersForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + */ + markNotificationsAsRead: { + (params?: RestEndpointMethodTypes["activity"]["markNotificationsAsRead"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + */ + markRepoNotificationsAsRead: { + (params?: RestEndpointMethodTypes["activity"]["markRepoNotificationsAsRead"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + markThreadAsRead: { + (params?: RestEndpointMethodTypes["activity"]["markThreadAsRead"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. + */ + setRepoSubscription: { + (params?: RestEndpointMethodTypes["activity"]["setRepoSubscription"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. + * + * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. + * + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. + */ + setThreadSubscription: { + (params?: RestEndpointMethodTypes["activity"]["setThreadSubscription"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + starRepoForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["starRepoForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + unstarRepoForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["unstarRepoForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + apps: { + /** + * Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + */ + addRepoToInstallation: { + (params?: RestEndpointMethodTypes["apps"]["addRepoToInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + */ + checkToken: { + (params?: RestEndpointMethodTypes["apps"]["checkToken"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. + * + * The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + createContentAttachment: { + (params?: RestEndpointMethodTypes["apps"]["createContentAttachment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. + */ + createFromManifest: { + (params?: RestEndpointMethodTypes["apps"]["createFromManifest"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + createInstallationAccessToken: { + (params?: RestEndpointMethodTypes["apps"]["createInstallationAccessToken"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + */ + deleteAuthorization: { + (params?: RestEndpointMethodTypes["apps"]["deleteAuthorization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/v3/apps/#suspend-an-app-installation)" endpoint. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + deleteInstallation: { + (params?: RestEndpointMethodTypes["apps"]["deleteInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. + */ + deleteToken: { + (params?: RestEndpointMethodTypes["apps"]["deleteToken"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + getAuthenticated: { + (params?: RestEndpointMethodTypes["apps"]["getAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * + * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + getBySlug: { + (params?: RestEndpointMethodTypes["apps"]["getBySlug"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + getInstallation: { + (params?: RestEndpointMethodTypes["apps"]["getInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables an authenticated GitHub App to find the organization's installation information. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + getOrgInstallation: { + (params?: RestEndpointMethodTypes["apps"]["getOrgInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + getRepoInstallation: { + (params?: RestEndpointMethodTypes["apps"]["getRepoInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + getSubscriptionPlanForAccount: { + (params?: RestEndpointMethodTypes["apps"]["getSubscriptionPlanForAccount"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + getSubscriptionPlanForAccountStubbed: { + (params?: RestEndpointMethodTypes["apps"]["getSubscriptionPlanForAccountStubbed"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables an authenticated GitHub App to find the user’s installation information. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + getUserInstallation: { + (params?: RestEndpointMethodTypes["apps"]["getUserInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + getWebhookConfigForApp: { + (params?: RestEndpointMethodTypes["apps"]["getWebhookConfigForApp"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + listAccountsForPlan: { + (params?: RestEndpointMethodTypes["apps"]["listAccountsForPlan"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + listAccountsForPlanStubbed: { + (params?: RestEndpointMethodTypes["apps"]["listAccountsForPlanStubbed"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * + * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. + * + * The access the user has to each repository is included in the hash under the `permissions` key. + */ + listInstallationReposForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["apps"]["listInstallationReposForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * + * The permissions the installation has are included under the `permissions` key. + */ + listInstallations: { + (params?: RestEndpointMethodTypes["apps"]["listInstallations"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. + * + * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * + * You can find the permissions for the installation under the `permissions` key. + */ + listInstallationsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["apps"]["listInstallationsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all plans that are part of your GitHub Marketplace listing. + * + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + listPlans: { + (params?: RestEndpointMethodTypes["apps"]["listPlans"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all plans that are part of your GitHub Marketplace listing. + * + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + listPlansStubbed: { + (params?: RestEndpointMethodTypes["apps"]["listPlansStubbed"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List repositories that an app installation can access. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + listReposAccessibleToInstallation: { + (params?: RestEndpointMethodTypes["apps"]["listReposAccessibleToInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). + */ + listSubscriptionsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["apps"]["listSubscriptionsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). + */ + listSubscriptionsForAuthenticatedUserStubbed: { + (params?: RestEndpointMethodTypes["apps"]["listSubscriptionsForAuthenticatedUserStubbed"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Remove a single repository from an installation. The authenticated user must have admin access to the repository. + * + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + */ + removeRepoFromInstallation: { + (params?: RestEndpointMethodTypes["apps"]["removeRepoFromInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + */ + resetToken: { + (params?: RestEndpointMethodTypes["apps"]["resetToken"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Revokes the installation token you're using to authenticate as an installation and access this endpoint. + * + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + revokeInstallationAccessToken: { + (params?: RestEndpointMethodTypes["apps"]["revokeInstallationAccessToken"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Exchanges a non-repository scoped user-to-server OAuth access token for a repository scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + */ + scopeToken: { + (params?: RestEndpointMethodTypes["apps"]["scopeToken"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see "[Suspending a GitHub App installation](https://docs.github.com/apps/managing-github-apps/suspending-a-github-app-installation/)." + * + * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + suspendInstallation: { + (params?: RestEndpointMethodTypes["apps"]["suspendInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta. For more information, see "[Suspending a GitHub App installation](https://docs.github.com/apps/managing-github-apps/suspending-a-github-app-installation/)." + * + * Removes a GitHub App installation suspension. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + unsuspendInstallation: { + (params?: RestEndpointMethodTypes["apps"]["unsuspendInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + updateWebhookConfigForApp: { + (params?: RestEndpointMethodTypes["apps"]["updateWebhookConfigForApp"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + billing: { + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + getGithubActionsBillingOrg: { + (params?: RestEndpointMethodTypes["billing"]["getGithubActionsBillingOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * Access tokens must have the `user` scope. + */ + getGithubActionsBillingUser: { + (params?: RestEndpointMethodTypes["billing"]["getGithubActionsBillingUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the free and paid storage usued for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + getGithubPackagesBillingOrg: { + (params?: RestEndpointMethodTypes["billing"]["getGithubPackagesBillingOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the free and paid storage used for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `user` scope. + */ + getGithubPackagesBillingUser: { + (params?: RestEndpointMethodTypes["billing"]["getGithubPackagesBillingUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + getSharedStorageBillingOrg: { + (params?: RestEndpointMethodTypes["billing"]["getSharedStorageBillingOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `user` scope. + */ + getSharedStorageBillingUser: { + (params?: RestEndpointMethodTypes["billing"]["getSharedStorageBillingUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + checks: { + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * + * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + */ + create: { + (params?: RestEndpointMethodTypes["checks"]["create"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + */ + createSuite: { + (params?: RestEndpointMethodTypes["checks"]["createSuite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + get: { + (params?: RestEndpointMethodTypes["checks"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. + */ + getSuite: { + (params?: RestEndpointMethodTypes["checks"]["getSuite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. + */ + listAnnotations: { + (params?: RestEndpointMethodTypes["checks"]["listAnnotations"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + listForRef: { + (params?: RestEndpointMethodTypes["checks"]["listForRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + listForSuite: { + (params?: RestEndpointMethodTypes["checks"]["listForSuite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. + */ + listSuitesForRef: { + (params?: RestEndpointMethodTypes["checks"]["listSuitesForRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * + * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. + */ + rerequestSuite: { + (params?: RestEndpointMethodTypes["checks"]["rerequestSuite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. + */ + setSuitesPreferences: { + (params?: RestEndpointMethodTypes["checks"]["setSuitesPreferences"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + */ + update: { + (params?: RestEndpointMethodTypes["checks"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + codeScanning: { + /** + * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * The security `alert_number` is found at the end of the security alert's URL. For example, the security alert ID for `https://github.com/Octo-org/octo-repo/security/code-scanning/88` is `88`. + */ + getAlert: { + (params?: RestEndpointMethodTypes["codeScanning"]["getAlert"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all open code scanning alerts for the default branch (usually `main` or `master`). You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + */ + listAlertsForRepo: { + (params?: RestEndpointMethodTypes["codeScanning"]["listAlertsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the details of recent code scanning analyses for a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + */ + listRecentAnalyses: { + (params?: RestEndpointMethodTypes["codeScanning"]["listRecentAnalyses"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + */ + updateAlert: { + (params?: RestEndpointMethodTypes["codeScanning"]["updateAlert"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Upload a SARIF file containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + */ + uploadSarif: { + (params?: RestEndpointMethodTypes["codeScanning"]["uploadSarif"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + codesOfConduct: { + getAllCodesOfConduct: { + (params?: RestEndpointMethodTypes["codesOfConduct"]["getAllCodesOfConduct"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getConductCode: { + (params?: RestEndpointMethodTypes["codesOfConduct"]["getConductCode"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the contents of the repository's code of conduct file, if one is detected. + * + * A code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching. + */ + getForRepo: { + (params?: RestEndpointMethodTypes["codesOfConduct"]["getForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + emojis: { + /** + * Lists all the emojis available to use on GitHub. + */ + get: { + (params?: RestEndpointMethodTypes["emojis"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + enterpriseAdmin: { + /** + * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + disableSelectedOrganizationGithubActionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["disableSelectedOrganizationGithubActionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + enableSelectedOrganizationGithubActionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["enableSelectedOrganizationGithubActionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + getAllowedActionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["getAllowedActionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + getGithubActionsPermissionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["getGithubActionsPermissionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + listSelectedOrganizationsEnabledGithubActionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["listSelectedOrganizationsEnabledGithubActionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + setAllowedActionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["setAllowedActionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + setGithubActionsPermissionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["setGithubActionsPermissionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + setSelectedOrganizationsEnabledGithubActionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["setSelectedOrganizationsEnabledGithubActionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + gists: { + checkIsStarred: { + (params?: RestEndpointMethodTypes["gists"]["checkIsStarred"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Allows you to add a new gist with one or more files. + * + * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + */ + create: { + (params?: RestEndpointMethodTypes["gists"]["create"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + createComment: { + (params?: RestEndpointMethodTypes["gists"]["createComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + delete: { + (params?: RestEndpointMethodTypes["gists"]["delete"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteComment: { + (params?: RestEndpointMethodTypes["gists"]["deleteComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note**: This was previously `/gists/:gist_id/fork`. + */ + fork: { + (params?: RestEndpointMethodTypes["gists"]["fork"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + get: { + (params?: RestEndpointMethodTypes["gists"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getComment: { + (params?: RestEndpointMethodTypes["gists"]["getComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getRevision: { + (params?: RestEndpointMethodTypes["gists"]["getRevision"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: + */ + list: { + (params?: RestEndpointMethodTypes["gists"]["list"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listComments: { + (params?: RestEndpointMethodTypes["gists"]["listComments"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listCommits: { + (params?: RestEndpointMethodTypes["gists"]["listCommits"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists public gists for the specified user: + */ + listForUser: { + (params?: RestEndpointMethodTypes["gists"]["listForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listForks: { + (params?: RestEndpointMethodTypes["gists"]["listForks"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List public gists sorted by most recently updated to least recently updated. + * + * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + */ + listPublic: { + (params?: RestEndpointMethodTypes["gists"]["listPublic"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the authenticated user's starred gists: + */ + listStarred: { + (params?: RestEndpointMethodTypes["gists"]["listStarred"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + star: { + (params?: RestEndpointMethodTypes["gists"]["star"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + unstar: { + (params?: RestEndpointMethodTypes["gists"]["unstar"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. + */ + update: { + (params?: RestEndpointMethodTypes["gists"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateComment: { + (params?: RestEndpointMethodTypes["gists"]["updateComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + git: { + createBlob: { + (params?: RestEndpointMethodTypes["git"]["createBlob"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + createCommit: { + (params?: RestEndpointMethodTypes["git"]["createCommit"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. + */ + createRef: { + (params?: RestEndpointMethodTypes["git"]["createRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + createTag: { + (params?: RestEndpointMethodTypes["git"]["createTag"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. + * + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." + */ + createTree: { + (params?: RestEndpointMethodTypes["git"]["createTree"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteRef: { + (params?: RestEndpointMethodTypes["git"]["deleteRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The `content` in the response will always be Base64 encoded. + * + * _Note_: This API supports blobs up to 100 megabytes in size. + */ + getBlob: { + (params?: RestEndpointMethodTypes["git"]["getBlob"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + getCommit: { + (params?: RestEndpointMethodTypes["git"]["getCommit"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. + * + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + */ + getRef: { + (params?: RestEndpointMethodTypes["git"]["getRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + getTag: { + (params?: RestEndpointMethodTypes["git"]["getTag"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a single tree using the SHA1 value for that tree. + * + * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. + */ + getTree: { + (params?: RestEndpointMethodTypes["git"]["getTree"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. + * + * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. + * + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * + * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + */ + listMatchingRefs: { + (params?: RestEndpointMethodTypes["git"]["listMatchingRefs"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateRef: { + (params?: RestEndpointMethodTypes["git"]["updateRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + gitignore: { + /** + * List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). + */ + getAllTemplates: { + (params?: RestEndpointMethodTypes["gitignore"]["getAllTemplates"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The API also allows fetching the source of a single template. + * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. + */ + getTemplate: { + (params?: RestEndpointMethodTypes["gitignore"]["getTemplate"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + interactions: { + /** + * Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. + */ + getRestrictionsForOrg: { + (params?: RestEndpointMethodTypes["interactions"]["getRestrictionsForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. + */ + getRestrictionsForRepo: { + (params?: RestEndpointMethodTypes["interactions"]["getRestrictionsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Shows which type of GitHub user can interact with your public repositories and when the restriction expires. If there are no restrictions, you will see an empty response. + */ + getRestrictionsForYourPublicRepos: { + (params?: RestEndpointMethodTypes["interactions"]["getRestrictionsForYourPublicRepos"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. + */ + removeRestrictionsForOrg: { + (params?: RestEndpointMethodTypes["interactions"]["removeRestrictionsForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. + */ + removeRestrictionsForRepo: { + (params?: RestEndpointMethodTypes["interactions"]["removeRestrictionsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes any interaction restrictions from your public repositories. + */ + removeRestrictionsForYourPublicRepos: { + (params?: RestEndpointMethodTypes["interactions"]["removeRestrictionsForYourPublicRepos"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. + */ + setRestrictionsForOrg: { + (params?: RestEndpointMethodTypes["interactions"]["setRestrictionsForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. + */ + setRestrictionsForRepo: { + (params?: RestEndpointMethodTypes["interactions"]["setRestrictionsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. + */ + setRestrictionsForYourPublicRepos: { + (params?: RestEndpointMethodTypes["interactions"]["setRestrictionsForYourPublicRepos"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + issues: { + /** + * Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. + */ + addAssignees: { + (params?: RestEndpointMethodTypes["issues"]["addAssignees"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + addLabels: { + (params?: RestEndpointMethodTypes["issues"]["addLabels"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Checks if a user has permission to be assigned to an issue in this repository. + * + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + * + * Otherwise a `404` status code is returned. + */ + checkUserCanBeAssigned: { + (params?: RestEndpointMethodTypes["issues"]["checkUserCanBeAssigned"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + create: { + (params?: RestEndpointMethodTypes["issues"]["create"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + createComment: { + (params?: RestEndpointMethodTypes["issues"]["createComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + createLabel: { + (params?: RestEndpointMethodTypes["issues"]["createLabel"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + createMilestone: { + (params?: RestEndpointMethodTypes["issues"]["createMilestone"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteComment: { + (params?: RestEndpointMethodTypes["issues"]["deleteComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteLabel: { + (params?: RestEndpointMethodTypes["issues"]["deleteLabel"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteMilestone: { + (params?: RestEndpointMethodTypes["issues"]["deleteMilestone"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was + * [transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If + * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe + * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + get: { + (params?: RestEndpointMethodTypes["issues"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getComment: { + (params?: RestEndpointMethodTypes["issues"]["getComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getEvent: { + (params?: RestEndpointMethodTypes["issues"]["getEvent"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getLabel: { + (params?: RestEndpointMethodTypes["issues"]["getLabel"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getMilestone: { + (params?: RestEndpointMethodTypes["issues"]["getMilestone"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List issues assigned to the authenticated user across all visible repositories including owned repositories, member + * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + * necessarily assigned to you. + * + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + list: { + (params?: RestEndpointMethodTypes["issues"]["list"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + */ + listAssignees: { + (params?: RestEndpointMethodTypes["issues"]["listAssignees"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Issue Comments are ordered by ascending ID. + */ + listComments: { + (params?: RestEndpointMethodTypes["issues"]["listComments"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * By default, Issue Comments are ordered by ascending ID. + */ + listCommentsForRepo: { + (params?: RestEndpointMethodTypes["issues"]["listCommentsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listEvents: { + (params?: RestEndpointMethodTypes["issues"]["listEvents"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listEventsForRepo: { + (params?: RestEndpointMethodTypes["issues"]["listEventsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listEventsForTimeline: { + (params?: RestEndpointMethodTypes["issues"]["listEventsForTimeline"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List issues across owned and member repositories assigned to the authenticated user. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + listForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["issues"]["listForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List issues in an organization assigned to the authenticated user. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + listForOrg: { + (params?: RestEndpointMethodTypes["issues"]["listForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List issues in a repository. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + listForRepo: { + (params?: RestEndpointMethodTypes["issues"]["listForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listLabelsForMilestone: { + (params?: RestEndpointMethodTypes["issues"]["listLabelsForMilestone"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listLabelsForRepo: { + (params?: RestEndpointMethodTypes["issues"]["listLabelsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listLabelsOnIssue: { + (params?: RestEndpointMethodTypes["issues"]["listLabelsOnIssue"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listMilestones: { + (params?: RestEndpointMethodTypes["issues"]["listMilestones"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access can lock an issue or pull request's conversation. + * + * 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://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + lock: { + (params?: RestEndpointMethodTypes["issues"]["lock"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + removeAllLabels: { + (params?: RestEndpointMethodTypes["issues"]["removeAllLabels"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes one or more assignees from an issue. + */ + removeAssignees: { + (params?: RestEndpointMethodTypes["issues"]["removeAssignees"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. + */ + removeLabel: { + (params?: RestEndpointMethodTypes["issues"]["removeLabel"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes any previous labels and sets the new labels for an issue. + */ + setLabels: { + (params?: RestEndpointMethodTypes["issues"]["setLabels"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access can unlock an issue's conversation. + */ + unlock: { + (params?: RestEndpointMethodTypes["issues"]["unlock"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Issue owners and users with push access can edit an issue. + */ + update: { + (params?: RestEndpointMethodTypes["issues"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateComment: { + (params?: RestEndpointMethodTypes["issues"]["updateComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateLabel: { + (params?: RestEndpointMethodTypes["issues"]["updateLabel"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateMilestone: { + (params?: RestEndpointMethodTypes["issues"]["updateMilestone"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + licenses: { + get: { + (params?: RestEndpointMethodTypes["licenses"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getAllCommonlyUsed: { + (params?: RestEndpointMethodTypes["licenses"]["getAllCommonlyUsed"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This method returns the contents of the repository's license file, if one is detected. + * + * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. + */ + getForRepo: { + (params?: RestEndpointMethodTypes["licenses"]["getForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + markdown: { + render: { + (params?: RestEndpointMethodTypes["markdown"]["render"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. + */ + renderRaw: { + (params?: RestEndpointMethodTypes["markdown"]["renderRaw"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + meta: { + /** + * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)." + * + * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. + */ + get: { + (params?: RestEndpointMethodTypes["meta"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get the octocat as ASCII art + */ + getOctocat: { + (params?: RestEndpointMethodTypes["meta"]["getOctocat"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get a random sentence from the Zen of GitHub + */ + getZen: { + (params?: RestEndpointMethodTypes["meta"]["getZen"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get Hypermedia links to resources accessible in GitHub's REST API + */ + root: { + (params?: RestEndpointMethodTypes["meta"]["root"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + migrations: { + /** + * Stop an import for a repository. + */ + cancelImport: { + (params?: RestEndpointMethodTypes["migrations"]["cancelImport"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. + */ + deleteArchiveForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["migrations"]["deleteArchiveForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a previous migration archive. Migration archives are automatically deleted after seven days. + */ + deleteArchiveForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["deleteArchiveForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Fetches the URL to a migration archive. + */ + downloadArchiveForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["downloadArchiveForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: + * + * * attachments + * * bases + * * commit\_comments + * * issue\_comments + * * issue\_events + * * issues + * * milestones + * * organizations + * * projects + * * protected\_branches + * * pull\_request\_reviews + * * pull\_requests + * * releases + * * repositories + * * review\_comments + * * schema + * * users + * + * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. + */ + getArchiveForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["migrations"]["getArchiveForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. + * + * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. + */ + getCommitAuthors: { + (params?: RestEndpointMethodTypes["migrations"]["getCommitAuthors"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * View the progress of an import. + * + * **Import status** + * + * This section includes details about the possible values of the `status` field of the Import Progress response. + * + * An import that does not have errors will progress through these steps: + * + * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. + * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). + * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. + * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". + * * `complete` - the import is complete, and the repository is ready on GitHub. + * + * If there are problems, you will see one of these in the `status` field: + * + * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information. + * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL. + * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * + * **The project_choices field** + * + * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. + * + * **Git LFS related fields** + * + * This section includes details about Git LFS related fields that may be present in the Import Progress response. + * + * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. + * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. + * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. + * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. + */ + getImportStatus: { + (params?: RestEndpointMethodTypes["migrations"]["getImportStatus"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List files larger than 100MB found during the import + */ + getLargeFiles: { + (params?: RestEndpointMethodTypes["migrations"]["getLargeFiles"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: + * + * * `pending` - the migration hasn't started yet. + * * `exporting` - the migration is in progress. + * * `exported` - the migration finished successfully. + * * `failed` - the migration failed. + * + * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). + */ + getStatusForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["migrations"]["getStatusForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Fetches the status of a migration. + * + * The `state` of a migration can be one of the following values: + * + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. + */ + getStatusForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["getStatusForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all migrations a user has started. + */ + listForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["migrations"]["listForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the most recent migrations. + */ + listForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["listForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all the repositories for this organization migration. + */ + listReposForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["listReposForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all the repositories for this user migration. + */ + listReposForUser: { + (params?: RestEndpointMethodTypes["migrations"]["listReposForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. + */ + mapCommitAuthor: { + (params?: RestEndpointMethodTypes["migrations"]["mapCommitAuthor"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/). + */ + setLfsPreference: { + (params?: RestEndpointMethodTypes["migrations"]["setLfsPreference"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Initiates the generation of a user migration archive. + */ + startForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["migrations"]["startForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Initiates the generation of a migration archive. + */ + startForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["startForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Start a source import to a GitHub repository using GitHub Importer. + */ + startImport: { + (params?: RestEndpointMethodTypes["migrations"]["startImport"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. + */ + unlockRepoForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["migrations"]["unlockRepoForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. + */ + unlockRepoForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["unlockRepoForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API + * request. If no parameters are provided, the import will be restarted. + */ + updateImport: { + (params?: RestEndpointMethodTypes["migrations"]["updateImport"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + orgs: { + blockUser: { + (params?: RestEndpointMethodTypes["orgs"]["blockUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + checkBlockedUser: { + (params?: RestEndpointMethodTypes["orgs"]["checkBlockedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Check if a user is, publicly or privately, a member of the organization. + */ + checkMembershipForUser: { + (params?: RestEndpointMethodTypes["orgs"]["checkMembershipForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + checkPublicMembershipForUser: { + (params?: RestEndpointMethodTypes["orgs"]["checkPublicMembershipForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". + */ + convertMemberToOutsideCollaborator: { + (params?: RestEndpointMethodTypes["orgs"]["convertMemberToOutsideCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + createInvitation: { + (params?: RestEndpointMethodTypes["orgs"]["createInvitation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Here's how you can create a hook that posts payloads in JSON format: + */ + createWebhook: { + (params?: RestEndpointMethodTypes["orgs"]["createWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteWebhook: { + (params?: RestEndpointMethodTypes["orgs"]["deleteWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * + * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + */ + get: { + (params?: RestEndpointMethodTypes["orgs"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getMembershipForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["orgs"]["getMembershipForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * In order to get a user's membership with an organization, the authenticated user must be an organization member. + */ + getMembershipForUser: { + (params?: RestEndpointMethodTypes["orgs"]["getMembershipForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." + */ + getWebhook: { + (params?: RestEndpointMethodTypes["orgs"]["getWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." + * + * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + */ + getWebhookConfigForOrg: { + (params?: RestEndpointMethodTypes["orgs"]["getWebhookConfigForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all organizations, in the order that they were created on GitHub. + * + * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. + */ + list: { + (params?: RestEndpointMethodTypes["orgs"]["list"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. + */ + listAppInstallations: { + (params?: RestEndpointMethodTypes["orgs"]["listAppInstallations"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the users blocked by an organization. + */ + listBlockedUsers: { + (params?: RestEndpointMethodTypes["orgs"]["listBlockedUsers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List organizations for the authenticated user. + * + * **OAuth scope requirements** + * + * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + */ + listForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["orgs"]["listForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. + * + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. + */ + listForUser: { + (params?: RestEndpointMethodTypes["orgs"]["listForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. + */ + listInvitationTeams: { + (params?: RestEndpointMethodTypes["orgs"]["listInvitationTeams"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. + */ + listMembers: { + (params?: RestEndpointMethodTypes["orgs"]["listMembers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listMembershipsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["orgs"]["listMembershipsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all users who are outside collaborators of an organization. + */ + listOutsideCollaborators: { + (params?: RestEndpointMethodTypes["orgs"]["listOutsideCollaborators"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + */ + listPendingInvitations: { + (params?: RestEndpointMethodTypes["orgs"]["listPendingInvitations"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Members of an organization can choose to have their membership publicized or not. + */ + listPublicMembers: { + (params?: RestEndpointMethodTypes["orgs"]["listPublicMembers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listWebhooks: { + (params?: RestEndpointMethodTypes["orgs"]["listWebhooks"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + */ + pingWebhook: { + (params?: RestEndpointMethodTypes["orgs"]["pingWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. + */ + removeMember: { + (params?: RestEndpointMethodTypes["orgs"]["removeMember"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. + * + * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + */ + removeMembershipForUser: { + (params?: RestEndpointMethodTypes["orgs"]["removeMembershipForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removing a user from this list will remove them from all the organization's repositories. + */ + removeOutsideCollaborator: { + (params?: RestEndpointMethodTypes["orgs"]["removeOutsideCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + removePublicMembershipForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["orgs"]["removePublicMembershipForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Only authenticated organization owners can add a member to the organization or update the member's role. + * + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * + * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. + * + * **Rate limits** + * + * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + */ + setMembershipForUser: { + (params?: RestEndpointMethodTypes["orgs"]["setMembershipForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The user can publicize their own membership. (A user cannot publicize the membership for another user.) + * + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + setPublicMembershipForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["orgs"]["setPublicMembershipForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + unblockUser: { + (params?: RestEndpointMethodTypes["orgs"]["unblockUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * + * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. + */ + update: { + (params?: RestEndpointMethodTypes["orgs"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateMembershipForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["orgs"]["updateMembershipForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." + */ + updateWebhook: { + (params?: RestEndpointMethodTypes["orgs"]["updateWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." + * + * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + */ + updateWebhookConfigForOrg: { + (params?: RestEndpointMethodTypes["orgs"]["updateWebhookConfigForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + projects: { + /** + * Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. + */ + addCollaborator: { + (params?: RestEndpointMethodTypes["projects"]["addCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. + * + * Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + createCard: { + (params?: RestEndpointMethodTypes["projects"]["createCard"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + createColumn: { + (params?: RestEndpointMethodTypes["projects"]["createColumn"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + createForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["projects"]["createForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + createForOrg: { + (params?: RestEndpointMethodTypes["projects"]["createForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + createForRepo: { + (params?: RestEndpointMethodTypes["projects"]["createForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a project board. Returns a `404 Not Found` status if projects are disabled. + */ + delete: { + (params?: RestEndpointMethodTypes["projects"]["delete"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteCard: { + (params?: RestEndpointMethodTypes["projects"]["deleteCard"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteColumn: { + (params?: RestEndpointMethodTypes["projects"]["deleteColumn"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + get: { + (params?: RestEndpointMethodTypes["projects"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getCard: { + (params?: RestEndpointMethodTypes["projects"]["getCard"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getColumn: { + (params?: RestEndpointMethodTypes["projects"]["getColumn"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. + */ + getPermissionForUser: { + (params?: RestEndpointMethodTypes["projects"]["getPermissionForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listCards: { + (params?: RestEndpointMethodTypes["projects"]["listCards"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. + */ + listCollaborators: { + (params?: RestEndpointMethodTypes["projects"]["listCollaborators"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listColumns: { + (params?: RestEndpointMethodTypes["projects"]["listColumns"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + listForOrg: { + (params?: RestEndpointMethodTypes["projects"]["listForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + listForRepo: { + (params?: RestEndpointMethodTypes["projects"]["listForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listForUser: { + (params?: RestEndpointMethodTypes["projects"]["listForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + moveCard: { + (params?: RestEndpointMethodTypes["projects"]["moveCard"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + moveColumn: { + (params?: RestEndpointMethodTypes["projects"]["moveColumn"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. + */ + removeCollaborator: { + (params?: RestEndpointMethodTypes["projects"]["removeCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + update: { + (params?: RestEndpointMethodTypes["projects"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateCard: { + (params?: RestEndpointMethodTypes["projects"]["updateCard"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateColumn: { + (params?: RestEndpointMethodTypes["projects"]["updateColumn"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + pulls: { + checkIfMerged: { + (params?: RestEndpointMethodTypes["pulls"]["checkIfMerged"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + * + * You can create a new pull request. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + create: { + (params?: RestEndpointMethodTypes["pulls"]["create"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + createReplyForReviewComment: { + (params?: RestEndpointMethodTypes["pulls"]["createReplyForReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * Pull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response. + * + * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint. + * + * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + */ + createReview: { + (params?: RestEndpointMethodTypes["pulls"]["createReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. + * + * You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices). + * + * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + createReviewComment: { + (params?: RestEndpointMethodTypes["pulls"]["createReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deletePendingReview: { + (params?: RestEndpointMethodTypes["pulls"]["deletePendingReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a review comment. + */ + deleteReviewComment: { + (params?: RestEndpointMethodTypes["pulls"]["deleteReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + */ + dismissReview: { + (params?: RestEndpointMethodTypes["pulls"]["dismissReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists details of a pull request by providing its number. + * + * When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * + * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. + * + * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: + * + * * If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * + * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + */ + get: { + (params?: RestEndpointMethodTypes["pulls"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getReview: { + (params?: RestEndpointMethodTypes["pulls"]["getReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Provides details for a review comment. + */ + getReviewComment: { + (params?: RestEndpointMethodTypes["pulls"]["getReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + list: { + (params?: RestEndpointMethodTypes["pulls"]["list"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List comments for a specific pull request review. + */ + listCommentsForReview: { + (params?: RestEndpointMethodTypes["pulls"]["listCommentsForReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. + */ + listCommits: { + (params?: RestEndpointMethodTypes["pulls"]["listCommits"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. + */ + listFiles: { + (params?: RestEndpointMethodTypes["pulls"]["listFiles"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listRequestedReviewers: { + (params?: RestEndpointMethodTypes["pulls"]["listRequestedReviewers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all review comments for a pull request. By default, review comments are in ascending order by ID. + */ + listReviewComments: { + (params?: RestEndpointMethodTypes["pulls"]["listReviewComments"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. + */ + listReviewCommentsForRepo: { + (params?: RestEndpointMethodTypes["pulls"]["listReviewCommentsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The list of reviews returns in chronological order. + */ + listReviews: { + (params?: RestEndpointMethodTypes["pulls"]["listReviews"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + merge: { + (params?: RestEndpointMethodTypes["pulls"]["merge"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + removeRequestedReviewers: { + (params?: RestEndpointMethodTypes["pulls"]["removeRequestedReviewers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + requestReviewers: { + (params?: RestEndpointMethodTypes["pulls"]["requestReviewers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + submitReview: { + (params?: RestEndpointMethodTypes["pulls"]["submitReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + */ + update: { + (params?: RestEndpointMethodTypes["pulls"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + */ + updateBranch: { + (params?: RestEndpointMethodTypes["pulls"]["updateBranch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Update the review summary comment with new text. + */ + updateReview: { + (params?: RestEndpointMethodTypes["pulls"]["updateReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables you to edit a review comment. + */ + updateReviewComment: { + (params?: RestEndpointMethodTypes["pulls"]["updateReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + rateLimit: { + /** + * **Note:** Accessing this endpoint does not count against your REST API rate limit. + * + * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + */ + get: { + (params?: RestEndpointMethodTypes["rateLimit"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + reactions: { + /** + * Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment. + */ + createForCommitComment: { + (params?: RestEndpointMethodTypes["reactions"]["createForCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue. + */ + createForIssue: { + (params?: RestEndpointMethodTypes["reactions"]["createForIssue"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment. + */ + createForIssueComment: { + (params?: RestEndpointMethodTypes["reactions"]["createForIssueComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment. + */ + createForPullRequestReviewComment: { + (params?: RestEndpointMethodTypes["reactions"]["createForPullRequestReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + */ + createForTeamDiscussionCommentInOrg: { + (params?: RestEndpointMethodTypes["reactions"]["createForTeamDiscussionCommentInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + */ + createForTeamDiscussionInOrg: { + (params?: RestEndpointMethodTypes["reactions"]["createForTeamDiscussionInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * + * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + */ + deleteForCommitComment: { + (params?: RestEndpointMethodTypes["reactions"]["deleteForCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * + * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + */ + deleteForIssue: { + (params?: RestEndpointMethodTypes["reactions"]["deleteForIssue"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * + * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + */ + deleteForIssueComment: { + (params?: RestEndpointMethodTypes["reactions"]["deleteForIssueComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * + * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + */ + deleteForPullRequestComment: { + (params?: RestEndpointMethodTypes["reactions"]["deleteForPullRequestComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * + * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + deleteForTeamDiscussion: { + (params?: RestEndpointMethodTypes["reactions"]["deleteForTeamDiscussion"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + deleteForTeamDiscussionComment: { + (params?: RestEndpointMethodTypes["reactions"]["deleteForTeamDiscussionComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). + * + * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). + * @deprecated octokit.reactions.deleteLegacy() is deprecated, see https://docs.github.com/v3/reactions/#delete-a-reaction-legacy + */ + deleteLegacy: { + (params?: RestEndpointMethodTypes["reactions"]["deleteLegacy"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + */ + listForCommitComment: { + (params?: RestEndpointMethodTypes["reactions"]["listForCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the reactions to an [issue](https://docs.github.com/rest/reference/issues). + */ + listForIssue: { + (params?: RestEndpointMethodTypes["reactions"]["listForIssue"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + */ + listForIssueComment: { + (params?: RestEndpointMethodTypes["reactions"]["listForIssueComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + */ + listForPullRequestReviewComment: { + (params?: RestEndpointMethodTypes["reactions"]["listForPullRequestReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + */ + listForTeamDiscussionCommentInOrg: { + (params?: RestEndpointMethodTypes["reactions"]["listForTeamDiscussionCommentInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + */ + listForTeamDiscussionInOrg: { + (params?: RestEndpointMethodTypes["reactions"]["listForTeamDiscussionInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + repos: { + acceptInvitation: { + (params?: RestEndpointMethodTypes["repos"]["acceptInvitation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + addAppAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["addAppAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * For more information the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). + * + * **Rate limits** + * + * To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. + */ + addCollaborator: { + (params?: RestEndpointMethodTypes["repos"]["addCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + addStatusCheckContexts: { + (params?: RestEndpointMethodTypes["repos"]["addStatusCheckContexts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified teams push access for this branch. You can also give push access to child teams. + * + * | Type | Description | + * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | + * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + addTeamAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["addTeamAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified people push access for this branch. + * + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + addUserAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["addUserAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + * + * Team members will include the members of child teams. + */ + checkCollaborator: { + (params?: RestEndpointMethodTypes["repos"]["checkCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + */ + checkVulnerabilityAlerts: { + (params?: RestEndpointMethodTypes["repos"]["checkVulnerabilityAlerts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. + * + * The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * + * The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. + * + * **Working with large comparisons** + * + * The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) to enumerate all commits in the range. + * + * For comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long + * to generate. You can typically resolve this error by using a smaller commit range. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + compareCommits: { + (params?: RestEndpointMethodTypes["repos"]["compareCommits"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a comment for a commit using its `:commit_sha`. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + createCommitComment: { + (params?: RestEndpointMethodTypes["repos"]["createCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. + */ + createCommitSignatureProtection: { + (params?: RestEndpointMethodTypes["repos"]["createCommitSignatureProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access in a repository can create commit statuses for a given SHA. + * + * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + */ + createCommitStatus: { + (params?: RestEndpointMethodTypes["repos"]["createCommitStatus"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You can create a read-only deploy key. + */ + createDeployKey: { + (params?: RestEndpointMethodTypes["repos"]["createDeployKey"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deployments offer a few configurable parameters with certain defaults. + * + * The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them + * before we merge a pull request. + * + * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have + * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter + * makes it easier to track which environments have requested deployments. The default environment is `production`. + * + * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If + * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, + * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will + * return a failure response. + * + * By default, [commit statuses](https://docs.github.com/rest/reference/repos#statuses) for every submitted context must be in a `success` + * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to + * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do + * not require any contexts or create any commit statuses, the deployment will always succeed. + * + * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text + * field that will be passed on when a deployment event is dispatched. + * + * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might + * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an + * application with debugging enabled. + * + * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. + * + * #### Merged branch response + * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating + * a deployment. This auto-merge happens when: + * * Auto-merge option is enabled in the repository + * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example + * * There are no merge conflicts + * + * If there are no new commits in the base branch, a new request to create a deployment should give a successful + * response. + * + * #### Merge conflict response + * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + * + * #### Failed commit status checks + * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` + * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + */ + createDeployment: { + (params?: RestEndpointMethodTypes["repos"]["createDeployment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with `push` access can create deployment statuses for a given deployment. + * + * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. + */ + createDeploymentStatus: { + (params?: RestEndpointMethodTypes["repos"]["createDeploymentStatus"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." + * + * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. + * + * To give you write access to the repository, you must use a personal access token with the `repo` scope. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. + * + * This input example shows how you can use the `client_payload` as a test to debug your workflow. + */ + createDispatchEvent: { + (params?: RestEndpointMethodTypes["repos"]["createDispatchEvent"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a new repository for the authenticated user. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository + * * `repo` scope to create a private repository + */ + createForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["repos"]["createForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a fork for the authenticated user. + * + * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com). + */ + createFork: { + (params?: RestEndpointMethodTypes["repos"]["createFork"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository + * * `repo` scope to create a private repository + */ + createInOrg: { + (params?: RestEndpointMethodTypes["repos"]["createInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a new file or replaces an existing file in a repository. + */ + createOrUpdateFileContents: { + (params?: RestEndpointMethodTypes["repos"]["createOrUpdateFileContents"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." + */ + createPagesSite: { + (params?: RestEndpointMethodTypes["repos"]["createPagesSite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access to the repository can create a release. + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + createRelease: { + (params?: RestEndpointMethodTypes["repos"]["createRelease"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository + * * `repo` scope to create a private repository + */ + createUsingTemplate: { + (params?: RestEndpointMethodTypes["repos"]["createUsingTemplate"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can + * share the same `config` as long as those webhooks do not have any `events` that overlap. + */ + createWebhook: { + (params?: RestEndpointMethodTypes["repos"]["createWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + declineInvitation: { + (params?: RestEndpointMethodTypes["repos"]["declineInvitation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + * + * If an organization owner has configured the organization to prevent members from deleting organization-owned + * repositories, you will get a `403 Forbidden` response. + */ + delete: { + (params?: RestEndpointMethodTypes["repos"]["delete"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Disables the ability to restrict who can push to this branch. + */ + deleteAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["deleteAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + */ + deleteAdminBranchProtection: { + (params?: RestEndpointMethodTypes["repos"]["deleteAdminBranchProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + deleteBranchProtection: { + (params?: RestEndpointMethodTypes["repos"]["deleteBranchProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteCommitComment: { + (params?: RestEndpointMethodTypes["repos"]["deleteCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. + */ + deleteCommitSignatureProtection: { + (params?: RestEndpointMethodTypes["repos"]["deleteCommitSignatureProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. + */ + deleteDeployKey: { + (params?: RestEndpointMethodTypes["repos"]["deleteDeployKey"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment. + * + * To set a deployment as inactive, you must: + * + * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. + * * Mark the active deployment as inactive by adding any non-successful deployment status. + * + * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." + */ + deleteDeployment: { + (params?: RestEndpointMethodTypes["repos"]["deleteDeployment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a file in a repository. + * + * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. + * + * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. + * + * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + */ + deleteFile: { + (params?: RestEndpointMethodTypes["repos"]["deleteFile"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteInvitation: { + (params?: RestEndpointMethodTypes["repos"]["deleteInvitation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deletePagesSite: { + (params?: RestEndpointMethodTypes["repos"]["deletePagesSite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + deletePullRequestReviewProtection: { + (params?: RestEndpointMethodTypes["repos"]["deletePullRequestReviewProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access to the repository can delete a release. + */ + deleteRelease: { + (params?: RestEndpointMethodTypes["repos"]["deleteRelease"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteReleaseAsset: { + (params?: RestEndpointMethodTypes["repos"]["deleteReleaseAsset"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteWebhook: { + (params?: RestEndpointMethodTypes["repos"]["deleteWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)". + */ + disableAutomatedSecurityFixes: { + (params?: RestEndpointMethodTypes["repos"]["disableAutomatedSecurityFixes"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + */ + disableVulnerabilityAlerts: { + (params?: RestEndpointMethodTypes["repos"]["disableVulnerabilityAlerts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually + * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + * the `Location` header to make a second `GET` request. + * **Note**: For private repositories, these links are temporary and expire after five minutes. + * @deprecated octokit.repos.downloadArchive() has been renamed to octokit.repos.downloadZipballArchive() (2020-09-17) + */ + downloadArchive: { + (params?: RestEndpointMethodTypes["repos"]["downloadArchive"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually + * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + * the `Location` header to make a second `GET` request. + * **Note**: For private repositories, these links are temporary and expire after five minutes. + */ + downloadTarballArchive: { + (params?: RestEndpointMethodTypes["repos"]["downloadTarballArchive"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually + * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + * the `Location` header to make a second `GET` request. + * **Note**: For private repositories, these links are temporary and expire after five minutes. + */ + downloadZipballArchive: { + (params?: RestEndpointMethodTypes["repos"]["downloadZipballArchive"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)". + */ + enableAutomatedSecurityFixes: { + (params?: RestEndpointMethodTypes["repos"]["enableAutomatedSecurityFixes"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + */ + enableVulnerabilityAlerts: { + (params?: RestEndpointMethodTypes["repos"]["enableVulnerabilityAlerts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file. + * + * The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. + */ + get: { + (params?: RestEndpointMethodTypes["repos"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists who has access to this protected branch. + * + * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + */ + getAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["getAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + getAdminBranchProtection: { + (params?: RestEndpointMethodTypes["repos"]["getAdminBranchProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + getAllStatusCheckContexts: { + (params?: RestEndpointMethodTypes["repos"]["getAllStatusCheckContexts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getAllTopics: { + (params?: RestEndpointMethodTypes["repos"]["getAllTopics"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + */ + getAppsWithAccessToProtectedBranch: { + (params?: RestEndpointMethodTypes["repos"]["getAppsWithAccessToProtectedBranch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getBranch: { + (params?: RestEndpointMethodTypes["repos"]["getBranch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + getBranchProtection: { + (params?: RestEndpointMethodTypes["repos"]["getBranchProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. + */ + getClones: { + (params?: RestEndpointMethodTypes["repos"]["getClones"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + */ + getCodeFrequencyStats: { + (params?: RestEndpointMethodTypes["repos"]["getCodeFrequencyStats"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. + */ + getCollaboratorPermissionLevel: { + (params?: RestEndpointMethodTypes["repos"]["getCollaboratorPermissionLevel"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. + * + * The most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts. + * + * Additionally, a combined `state` is returned. The `state` is one of: + * + * * **failure** if any of the contexts report as `error` or `failure` + * * **pending** if there are no statuses or a context is `pending` + * * **success** if the latest status for all contexts is `success` + */ + getCombinedStatusForRef: { + (params?: RestEndpointMethodTypes["repos"]["getCombinedStatusForRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. + * + * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * + * You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. + * + * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + getCommit: { + (params?: RestEndpointMethodTypes["repos"]["getCommit"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. + */ + getCommitActivityStats: { + (params?: RestEndpointMethodTypes["repos"]["getCommitActivityStats"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getCommitComment: { + (params?: RestEndpointMethodTypes["repos"]["getCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help. + * + * **Note**: You must enable branch protection to require signed commits. + */ + getCommitSignatureProtection: { + (params?: RestEndpointMethodTypes["repos"]["getCommitSignatureProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint will return all community profile metrics, including an + * overall health score, repository description, the presence of documentation, detected + * code of conduct, detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE, + * README, and CONTRIBUTING files. + * + * The `health_percentage` score is defined as a percentage of how many of + * these four documents are present: README, CONTRIBUTING, LICENSE, and + * CODE_OF_CONDUCT. For example, if all four documents are present, then + * the `health_percentage` is `100`. If only one is present, then the + * `health_percentage` is `25`. + * + * `content_reports_enabled` is only returned for organization-owned repositories. + */ + getCommunityProfileMetrics: { + (params?: RestEndpointMethodTypes["repos"]["getCommunityProfileMetrics"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit + * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. + * + * Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for + * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media + * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent + * object format. + * + * **Note**: + * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). + * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees + * API](https://docs.github.com/rest/reference/git#get-a-tree). + * * This API supports files up to 1 megabyte in size. + * + * #### If the content is a directory + * The response will be an array of objects, one object for each item in the directory. + * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value + * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). + * In the next major version of the API, the type will be returned as "submodule". + * + * #### If the content is a symlink + * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the + * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object + * describing the symlink itself. + * + * #### If the content is a submodule + * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific + * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out + * the submodule at that specific commit. + * + * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the + * github.com URLs (`html_url` and `_links["html"]`) will have null values. + */ + getContent: { + (params?: RestEndpointMethodTypes["repos"]["getContent"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: + * + * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits + */ + getContributorsStats: { + (params?: RestEndpointMethodTypes["repos"]["getContributorsStats"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getDeployKey: { + (params?: RestEndpointMethodTypes["repos"]["getDeployKey"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getDeployment: { + (params?: RestEndpointMethodTypes["repos"]["getDeployment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with pull access can view a deployment status for a deployment: + */ + getDeploymentStatus: { + (params?: RestEndpointMethodTypes["repos"]["getDeploymentStatus"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getLatestPagesBuild: { + (params?: RestEndpointMethodTypes["repos"]["getLatestPagesBuild"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * View the latest published full release for the repository. + * + * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + */ + getLatestRelease: { + (params?: RestEndpointMethodTypes["repos"]["getLatestRelease"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getPages: { + (params?: RestEndpointMethodTypes["repos"]["getPages"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getPagesBuild: { + (params?: RestEndpointMethodTypes["repos"]["getPagesBuild"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. + * + * The array order is oldest week (index 0) to most recent week. + */ + getParticipationStats: { + (params?: RestEndpointMethodTypes["repos"]["getParticipationStats"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + getPullRequestReviewProtection: { + (params?: RestEndpointMethodTypes["repos"]["getPullRequestReviewProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Each array contains the day number, hour number, and number of commits: + * + * * `0-6`: Sunday - Saturday + * * `0-23`: Hour of day + * * Number of commits + * + * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + */ + getPunchCardStats: { + (params?: RestEndpointMethodTypes["repos"]["getPunchCardStats"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the preferred README for a repository. + * + * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + */ + getReadme: { + (params?: RestEndpointMethodTypes["repos"]["getReadme"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). + */ + getRelease: { + (params?: RestEndpointMethodTypes["repos"]["getRelease"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + */ + getReleaseAsset: { + (params?: RestEndpointMethodTypes["repos"]["getReleaseAsset"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get a published release with the specified tag. + */ + getReleaseByTag: { + (params?: RestEndpointMethodTypes["repos"]["getReleaseByTag"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + getStatusChecksProtection: { + (params?: RestEndpointMethodTypes["repos"]["getStatusChecksProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the teams who have push access to this branch. The list includes child teams. + */ + getTeamsWithAccessToProtectedBranch: { + (params?: RestEndpointMethodTypes["repos"]["getTeamsWithAccessToProtectedBranch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get the top 10 popular contents over the last 14 days. + */ + getTopPaths: { + (params?: RestEndpointMethodTypes["repos"]["getTopPaths"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get the top 10 referrers over the last 14 days. + */ + getTopReferrers: { + (params?: RestEndpointMethodTypes["repos"]["getTopReferrers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the people who have push access to this branch. + */ + getUsersWithAccessToProtectedBranch: { + (params?: RestEndpointMethodTypes["repos"]["getUsersWithAccessToProtectedBranch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. + */ + getViews: { + (params?: RestEndpointMethodTypes["repos"]["getViews"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." + */ + getWebhook: { + (params?: RestEndpointMethodTypes["repos"]["getWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." + * + * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + */ + getWebhookConfigForRepo: { + (params?: RestEndpointMethodTypes["repos"]["getWebhookConfigForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listBranches: { + (params?: RestEndpointMethodTypes["repos"]["listBranches"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + */ + listBranchesForHeadCommit: { + (params?: RestEndpointMethodTypes["repos"]["listBranchesForHeadCommit"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + * + * Team members will include the members of child teams. + */ + listCollaborators: { + (params?: RestEndpointMethodTypes["repos"]["listCollaborators"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Use the `:commit_sha` to specify the commit that will have its comments listed. + */ + listCommentsForCommit: { + (params?: RestEndpointMethodTypes["repos"]["listCommentsForCommit"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * + * Comments are ordered by ascending ID. + */ + listCommitCommentsForRepo: { + (params?: RestEndpointMethodTypes["repos"]["listCommitCommentsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. + * + * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + */ + listCommitStatusesForRef: { + (params?: RestEndpointMethodTypes["repos"]["listCommitStatusesForRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + listCommits: { + (params?: RestEndpointMethodTypes["repos"]["listCommits"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. + * + * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. + */ + listContributors: { + (params?: RestEndpointMethodTypes["repos"]["listContributors"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listDeployKeys: { + (params?: RestEndpointMethodTypes["repos"]["listDeployKeys"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with pull access can view deployment statuses for a deployment: + */ + listDeploymentStatuses: { + (params?: RestEndpointMethodTypes["repos"]["listDeploymentStatuses"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Simple filtering of deployments is available via query parameters: + */ + listDeployments: { + (params?: RestEndpointMethodTypes["repos"]["listDeployments"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + */ + listForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["repos"]["listForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists repositories for the specified organization. + */ + listForOrg: { + (params?: RestEndpointMethodTypes["repos"]["listForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists public repositories for the specified user. + */ + listForUser: { + (params?: RestEndpointMethodTypes["repos"]["listForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listForks: { + (params?: RestEndpointMethodTypes["repos"]["listForks"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. + */ + listInvitations: { + (params?: RestEndpointMethodTypes["repos"]["listInvitations"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * When authenticating as a user, this endpoint will list all currently open repository invitations for that user. + */ + listInvitationsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["repos"]["listInvitationsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. + */ + listLanguages: { + (params?: RestEndpointMethodTypes["repos"]["listLanguages"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listPagesBuilds: { + (params?: RestEndpointMethodTypes["repos"]["listPagesBuilds"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all public repositories in the order that they were created. + * + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. + */ + listPublic: { + (params?: RestEndpointMethodTypes["repos"]["listPublic"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. + */ + listPullRequestsAssociatedWithCommit: { + (params?: RestEndpointMethodTypes["repos"]["listPullRequestsAssociatedWithCommit"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listReleaseAssets: { + (params?: RestEndpointMethodTypes["repos"]["listReleaseAssets"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). + * + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + */ + listReleases: { + (params?: RestEndpointMethodTypes["repos"]["listReleases"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listTags: { + (params?: RestEndpointMethodTypes["repos"]["listTags"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listTeams: { + (params?: RestEndpointMethodTypes["repos"]["listTeams"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listWebhooks: { + (params?: RestEndpointMethodTypes["repos"]["listWebhooks"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + merge: { + (params?: RestEndpointMethodTypes["repos"]["merge"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + */ + pingWebhook: { + (params?: RestEndpointMethodTypes["repos"]["pingWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + removeAppAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["removeAppAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + removeCollaborator: { + (params?: RestEndpointMethodTypes["repos"]["removeCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + removeStatusCheckContexts: { + (params?: RestEndpointMethodTypes["repos"]["removeStatusCheckContexts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + removeStatusCheckProtection: { + (params?: RestEndpointMethodTypes["repos"]["removeStatusCheckProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of a team to push to this branch. You can also remove push access for child teams. + * + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + removeTeamAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["removeTeamAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of a user to push to this branch. + * + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + removeUserAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["removeUserAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + replaceAllTopics: { + (params?: RestEndpointMethodTypes["repos"]["replaceAllTopics"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. + * + * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + */ + requestPagesBuild: { + (params?: RestEndpointMethodTypes["repos"]["requestPagesBuild"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + */ + setAdminBranchProtection: { + (params?: RestEndpointMethodTypes["repos"]["setAdminBranchProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + setAppAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["setAppAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + setStatusCheckContexts: { + (params?: RestEndpointMethodTypes["repos"]["setStatusCheckContexts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. + * + * | Type | Description | + * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | + * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + setTeamAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["setTeamAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. + * + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + setUserAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["setUserAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. + * + * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + */ + testPushWebhook: { + (params?: RestEndpointMethodTypes["repos"]["testPushWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/). + */ + transfer: { + (params?: RestEndpointMethodTypes["repos"]["transfer"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. + */ + update: { + (params?: RestEndpointMethodTypes["repos"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Protecting a branch requires admin or owner permissions to the repository. + * + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * + * **Note**: The list of users, apps, and teams in total is limited to 100 items. + */ + updateBranchProtection: { + (params?: RestEndpointMethodTypes["repos"]["updateBranchProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateCommitComment: { + (params?: RestEndpointMethodTypes["repos"]["updateCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). + */ + updateInformationAboutPagesSite: { + (params?: RestEndpointMethodTypes["repos"]["updateInformationAboutPagesSite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateInvitation: { + (params?: RestEndpointMethodTypes["repos"]["updateInvitation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + */ + updatePullRequestReviewProtection: { + (params?: RestEndpointMethodTypes["repos"]["updatePullRequestReviewProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access to the repository can edit a release. + */ + updateRelease: { + (params?: RestEndpointMethodTypes["repos"]["updateRelease"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access to the repository can edit a release asset. + */ + updateReleaseAsset: { + (params?: RestEndpointMethodTypes["repos"]["updateReleaseAsset"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + * @deprecated octokit.repos.updateStatusCheckPotection() has been renamed to octokit.repos.updateStatusCheckProtection() (2020-09-17) + */ + updateStatusCheckPotection: { + (params?: RestEndpointMethodTypes["repos"]["updateStatusCheckPotection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + */ + updateStatusCheckProtection: { + (params?: RestEndpointMethodTypes["repos"]["updateStatusCheckProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." + */ + updateWebhook: { + (params?: RestEndpointMethodTypes["repos"]["updateWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." + * + * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + */ + updateWebhookConfigForRepo: { + (params?: RestEndpointMethodTypes["repos"]["updateWebhookConfigForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#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://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. + * + * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. + * + * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: + * + * `application/zip` + * + * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, + * you'll still need to pass your authentication to be able to upload an asset. + * + * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. + * + * **Notes:** + * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)" + * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact). + * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. + */ + uploadReleaseAsset: { + (params?: RestEndpointMethodTypes["repos"]["uploadReleaseAsset"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + search: { + /** + * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: + * + * `q=addClass+in:file+language:js+repo:jquery/jquery` + * + * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. + * + * #### Considerations for code search + * + * Due to the complexity of searching code, there are a few restrictions on how searches are performed: + * + * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. + * * Only files smaller than 384 KB are searchable. + * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing + * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. + */ + code: { + (params?: RestEndpointMethodTypes["search"]["code"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match + * metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: + * + * `q=repo:octocat/Spoon-Knife+css` + */ + commits: { + (params?: RestEndpointMethodTypes["search"]["commits"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted + * search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. + * + * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + * + * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. + * + * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + */ + issuesAndPullRequests: { + (params?: RestEndpointMethodTypes["search"]["issuesAndPullRequests"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: + * + * `q=bug+defect+enhancement&repository_id=64778136` + * + * The labels that best match the query appear first in the search results. + */ + labels: { + (params?: RestEndpointMethodTypes["search"]["labels"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: + * + * `q=tetris+language:assembly&sort=stars&order=desc` + * + * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + * + * When you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this: + * + * `q=topic:ruby+topic:rails` + */ + repos: { + (params?: RestEndpointMethodTypes["search"]["repos"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://help.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + * + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: + * + * `q=ruby+is:featured` + * + * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + */ + topics: { + (params?: RestEndpointMethodTypes["search"]["topics"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you're looking for a list of popular users, you might try this query: + * + * `q=tom+repos:%3E42+followers:%3E1000` + * + * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + */ + users: { + (params?: RestEndpointMethodTypes["search"]["users"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + secretScanning: { + /** + * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + */ + getAlert: { + (params?: RestEndpointMethodTypes["secretScanning"]["getAlert"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + */ + listAlertsForRepo: { + (params?: RestEndpointMethodTypes["secretScanning"]["listAlertsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + */ + updateAlert: { + (params?: RestEndpointMethodTypes["secretScanning"]["updateAlert"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + teams: { + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. + * + * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + */ + addOrUpdateMembershipForUserInOrg: { + (params?: RestEndpointMethodTypes["teams"]["addOrUpdateMembershipForUserInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + addOrUpdateProjectPermissionsInOrg: { + (params?: RestEndpointMethodTypes["teams"]["addOrUpdateProjectPermissionsInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * + * For more information about the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + */ + addOrUpdateRepoPermissionsInOrg: { + (params?: RestEndpointMethodTypes["teams"]["addOrUpdateRepoPermissionsInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + checkPermissionsForProjectInOrg: { + (params?: RestEndpointMethodTypes["teams"]["checkPermissionsForProjectInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. + * + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * + * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + */ + checkPermissionsForRepoInOrg: { + (params?: RestEndpointMethodTypes["teams"]["checkPermissionsForRepoInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." + * + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". + */ + create: { + (params?: RestEndpointMethodTypes["teams"]["create"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + */ + createDiscussionCommentInOrg: { + (params?: RestEndpointMethodTypes["teams"]["createDiscussionCommentInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + */ + createDiscussionInOrg: { + (params?: RestEndpointMethodTypes["teams"]["createDiscussionInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + deleteDiscussionCommentInOrg: { + (params?: RestEndpointMethodTypes["teams"]["deleteDiscussionCommentInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + deleteDiscussionInOrg: { + (params?: RestEndpointMethodTypes["teams"]["deleteDiscussionInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To delete a team, the authenticated user must be an organization owner or team maintainer. + * + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + */ + deleteInOrg: { + (params?: RestEndpointMethodTypes["teams"]["deleteInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + */ + getByName: { + (params?: RestEndpointMethodTypes["teams"]["getByName"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + getDiscussionCommentInOrg: { + (params?: RestEndpointMethodTypes["teams"]["getDiscussionCommentInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + getDiscussionInOrg: { + (params?: RestEndpointMethodTypes["teams"]["getDiscussionInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Team members will include the members of child teams. + * + * To get a user's membership with a team, the team must be visible to the authenticated user. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * + * **Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). + */ + getMembershipForUserInOrg: { + (params?: RestEndpointMethodTypes["teams"]["getMembershipForUserInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all teams in an organization that are visible to the authenticated user. + */ + list: { + (params?: RestEndpointMethodTypes["teams"]["list"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the child teams of the team specified by `{team_slug}`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + */ + listChildInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listChildInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + */ + listDiscussionCommentsInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listDiscussionCommentsInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + */ + listDiscussionsInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listDiscussionsInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). + */ + listForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["teams"]["listForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Team members will include the members of child teams. + * + * To list members in a team, the team must be visible to the authenticated user. + */ + listMembersInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listMembersInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + */ + listPendingInvitationsInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listPendingInvitationsInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the organization projects for a team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + */ + listProjectsInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listProjectsInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists a team's repositories visible to the authenticated user. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + */ + listReposInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listReposInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + */ + removeMembershipForUserInOrg: { + (params?: RestEndpointMethodTypes["teams"]["removeMembershipForUserInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + removeProjectInOrg: { + (params?: RestEndpointMethodTypes["teams"]["removeProjectInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + */ + removeRepoInOrg: { + (params?: RestEndpointMethodTypes["teams"]["removeRepoInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + updateDiscussionCommentInOrg: { + (params?: RestEndpointMethodTypes["teams"]["updateDiscussionCommentInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + updateDiscussionInOrg: { + (params?: RestEndpointMethodTypes["teams"]["updateDiscussionInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + */ + updateInOrg: { + (params?: RestEndpointMethodTypes["teams"]["updateInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + users: { + /** + * This endpoint is accessible with the `user` scope. + */ + addEmailForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["addEmailForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + block: { + (params?: RestEndpointMethodTypes["users"]["block"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + checkBlocked: { + (params?: RestEndpointMethodTypes["users"]["checkBlocked"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + checkFollowingForUser: { + (params?: RestEndpointMethodTypes["users"]["checkFollowingForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + checkPersonIsFollowedByAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["checkPersonIsFollowedByAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + createGpgKeyForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["createGpgKeyForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + createPublicSshKeyForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["createPublicSshKeyForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint is accessible with the `user` scope. + */ + deleteEmailForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["deleteEmailForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + deleteGpgKeyForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["deleteGpgKeyForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + deletePublicSshKeyForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["deletePublicSshKeyForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + */ + follow: { + (params?: RestEndpointMethodTypes["users"]["follow"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. + * + * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + */ + getAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["getAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Provides publicly available information about someone with a GitHub account. + * + * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". + */ + getByUsername: { + (params?: RestEndpointMethodTypes["users"]["getByUsername"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + * + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: + * + * ```shell + * curl -u username:token + * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 + * ``` + */ + getContextForUser: { + (params?: RestEndpointMethodTypes["users"]["getContextForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + getGpgKeyForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["getGpgKeyForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + getPublicSshKeyForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["getPublicSshKeyForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. + * + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. + */ + list: { + (params?: RestEndpointMethodTypes["users"]["list"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the users you've blocked on your personal account. + */ + listBlockedByAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["listBlockedByAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + */ + listEmailsForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["listEmailsForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the people who the authenticated user follows. + */ + listFollowedByAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["listFollowedByAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the people following the authenticated user. + */ + listFollowersForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["users"]["listFollowersForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the people following the specified user. + */ + listFollowersForUser: { + (params?: RestEndpointMethodTypes["users"]["listFollowersForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the people who the specified user follows. + */ + listFollowingForUser: { + (params?: RestEndpointMethodTypes["users"]["listFollowingForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + listGpgKeysForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["listGpgKeysForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the GPG keys for a user. This information is accessible by anyone. + */ + listGpgKeysForUser: { + (params?: RestEndpointMethodTypes["users"]["listGpgKeysForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + */ + listPublicEmailsForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["listPublicEmailsForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the _verified_ public SSH keys for a user. This is accessible by anyone. + */ + listPublicKeysForUser: { + (params?: RestEndpointMethodTypes["users"]["listPublicKeysForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + listPublicSshKeysForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["listPublicSshKeysForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the visibility for your primary email addresses. + */ + setPrimaryEmailVisibilityForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["setPrimaryEmailVisibilityForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + unblock: { + (params?: RestEndpointMethodTypes["users"]["unblock"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + */ + unfollow: { + (params?: RestEndpointMethodTypes["users"]["unfollow"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. + */ + updateAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["updateAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; +}; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts new file mode 100644 index 0000000..50990c6 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts @@ -0,0 +1,2459 @@ +import { Endpoints, RequestParameters } from "@octokit/types"; +export declare type RestEndpointMethodTypes = { + actions: { + addSelectedRepoToOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["response"]; + }; + cancelWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel"]["response"]; + }; + createOrUpdateOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}"]["response"]; + }; + createOrUpdateRepoSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["response"]; + }; + createRegistrationTokenForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/actions/runners/registration-token"]["response"]; + }; + createRegistrationTokenForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runners/registration-token"]["response"]; + }; + createRemoveTokenForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/actions/runners/remove-token"]["response"]; + }; + createRemoveTokenForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runners/remove-token"]["response"]; + }; + createWorkflowDispatch: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches"]["response"]; + }; + deleteArtifact: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"]["response"]; + }; + deleteOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}"]["response"]; + }; + deleteRepoSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["response"]; + }; + deleteSelfHostedRunnerFromOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/actions/runners/{runner_id}"]["response"]; + }; + deleteSelfHostedRunnerFromRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}"]["response"]; + }; + deleteWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}"]["response"]; + }; + deleteWorkflowRunLogs: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs"]["response"]; + }; + disableSelectedRepositoryGithubActionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}"]["response"]; + }; + disableWorkflow: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable"]["response"]; + }; + downloadArtifact: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}"]["response"]; + }; + downloadJobLogsForWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"]["response"]; + }; + downloadWorkflowRunLogs: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs"]["response"]; + }; + enableSelectedRepositoryGithubActionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/permissions/repositories/{repository_id}"]["response"]; + }; + enableWorkflow: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable"]["response"]; + }; + getAllowedActionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/permissions/selected-actions"]["response"]; + }; + getAllowedActionsRepository: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/permissions/selected-actions"]["response"]; + }; + getArtifact: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"]["response"]; + }; + getGithubActionsPermissionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/permissions"]["response"]; + }; + getGithubActionsPermissionsRepository: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/permissions"]["response"]; + }; + getJobForWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"]["response"]; + }; + getOrgPublicKey: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/secrets/public-key"]["response"]; + }; + getOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}"]["response"]; + }; + getRepoPermissions: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/permissions"]["response"]; + }; + getRepoPublicKey: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets/public-key"]["response"]; + }; + getRepoSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["response"]; + }; + getSelfHostedRunnerForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/runners/{runner_id}"]["response"]; + }; + getSelfHostedRunnerForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners/{runner_id}"]["response"]; + }; + getWorkflow: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"]["response"]; + }; + getWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}"]["response"]; + }; + getWorkflowRunUsage: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing"]["response"]; + }; + getWorkflowUsage: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing"]["response"]; + }; + listArtifactsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts"]["response"]; + }; + listJobsForWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["response"]; + }; + listOrgSecrets: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/secrets"]["response"]; + }; + listRepoSecrets: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets"]["response"]; + }; + listRepoWorkflows: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"]; + }; + listRunnerApplicationsForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/runners/downloads"]["response"]; + }; + listRunnerApplicationsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners/downloads"]["response"]; + }; + listSelectedReposForOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"]["response"]; + }; + listSelectedRepositoriesEnabledGithubActionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["response"]; + }; + listSelfHostedRunnersForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/runners"]["response"]; + }; + listSelfHostedRunnersForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners"]["response"]; + }; + listWorkflowRunArtifacts: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["response"]; + }; + listWorkflowRuns: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"]["response"]; + }; + listWorkflowRunsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["response"]; + }; + reRunWorkflow: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"]["response"]; + }; + removeSelectedRepoFromOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["response"]; + }; + setAllowedActionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/permissions/selected-actions"]["response"]; + }; + setAllowedActionsRepository: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/permissions/selected-actions"]["response"]; + }; + setGithubActionsPermissionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/permissions"]["response"]; + }; + setGithubActionsPermissionsRepository: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/permissions"]["response"]; + }; + setSelectedReposForOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories"]["response"]; + }; + setSelectedRepositoriesEnabledGithubActionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/permissions/repositories"]["response"]; + }; + }; + activity: { + checkRepoIsStarredByAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/starred/{owner}/{repo}"]["response"]; + }; + deleteRepoSubscription: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/subscription"]["response"]; + }; + deleteThreadSubscription: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /notifications/threads/{thread_id}/subscription"]["response"]; + }; + getFeeds: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /feeds"]["response"]; + }; + getRepoSubscription: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/subscription"]["response"]; + }; + getThread: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /notifications/threads/{thread_id}"]["response"]; + }; + getThreadSubscriptionForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /notifications/threads/{thread_id}/subscription"]["response"]; + }; + listEventsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/events"]["response"]; + }; + listNotificationsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /notifications"]["response"]; + }; + listOrgEventsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/events/orgs/{org}"]["response"]; + }; + listPublicEvents: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /events"]["response"]; + }; + listPublicEventsForRepoNetwork: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /networks/{owner}/{repo}/events"]["response"]; + }; + listPublicEventsForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/events/public"]["response"]; + }; + listPublicOrgEvents: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/events"]["response"]; + }; + listReceivedEventsForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/received_events"]["response"]; + }; + listReceivedPublicEventsForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/received_events/public"]["response"]; + }; + listRepoEvents: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/events"]["response"]; + }; + listRepoNotificationsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/notifications"]["response"]; + }; + listReposStarredByAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/starred"]["response"]; + }; + listReposStarredByUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/starred"]["response"]; + }; + listReposWatchedByUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/subscriptions"]["response"]; + }; + listStargazersForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/stargazers"]["response"]; + }; + listWatchedReposForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/subscriptions"]["response"]; + }; + listWatchersForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/subscribers"]["response"]; + }; + markNotificationsAsRead: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /notifications"]["response"]; + }; + markRepoNotificationsAsRead: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/notifications"]["response"]; + }; + markThreadAsRead: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /notifications/threads/{thread_id}"]["response"]; + }; + setRepoSubscription: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/subscription"]["response"]; + }; + setThreadSubscription: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /notifications/threads/{thread_id}/subscription"]["response"]; + }; + starRepoForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /user/starred/{owner}/{repo}"]["response"]; + }; + unstarRepoForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/starred/{owner}/{repo}"]["response"]; + }; + }; + apps: { + addRepoToInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["response"]; + }; + checkToken: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /applications/{client_id}/token"]["response"]; + }; + createContentAttachment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /content_references/{content_reference_id}/attachments"]["response"]; + }; + createFromManifest: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /app-manifests/{code}/conversions"]["response"]; + }; + createInstallationAccessToken: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /app/installations/{installation_id}/access_tokens"]["response"]; + }; + deleteAuthorization: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /applications/{client_id}/grant"]["response"]; + }; + deleteInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /app/installations/{installation_id}"]["response"]; + }; + deleteToken: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /applications/{client_id}/token"]["response"]; + }; + getAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /app"]["response"]; + }; + getBySlug: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /apps/{app_slug}"]["response"]; + }; + getInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /app/installations/{installation_id}"]["response"]; + }; + getOrgInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/installation"]["response"]; + }; + getRepoInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/installation"]["response"]; + }; + getSubscriptionPlanForAccount: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /marketplace_listing/accounts/{account_id}"]["response"]; + }; + getSubscriptionPlanForAccountStubbed: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /marketplace_listing/stubbed/accounts/{account_id}"]["response"]; + }; + getUserInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/installation"]["response"]; + }; + getWebhookConfigForApp: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /app/hook/config"]["response"]; + }; + listAccountsForPlan: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["response"]; + }; + listAccountsForPlanStubbed: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"]["response"]; + }; + listInstallationReposForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/installations/{installation_id}/repositories"]["response"]; + }; + listInstallations: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /app/installations"]["response"]; + }; + listInstallationsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/installations"]["response"]; + }; + listPlans: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /marketplace_listing/plans"]["response"]; + }; + listPlansStubbed: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /marketplace_listing/stubbed/plans"]["response"]; + }; + listReposAccessibleToInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /installation/repositories"]["response"]; + }; + listSubscriptionsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/marketplace_purchases"]["response"]; + }; + listSubscriptionsForAuthenticatedUserStubbed: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/marketplace_purchases/stubbed"]["response"]; + }; + removeRepoFromInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["response"]; + }; + resetToken: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /applications/{client_id}/token"]["response"]; + }; + revokeInstallationAccessToken: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /installation/token"]["response"]; + }; + scopeToken: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /applications/{client_id}/token/scoped"]["response"]; + }; + suspendInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /app/installations/{installation_id}/suspended"]["response"]; + }; + unsuspendInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /app/installations/{installation_id}/suspended"]["response"]; + }; + updateWebhookConfigForApp: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /app/hook/config"]["response"]; + }; + }; + billing: { + getGithubActionsBillingOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/settings/billing/actions"]["response"]; + }; + getGithubActionsBillingUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/settings/billing/actions"]["response"]; + }; + getGithubPackagesBillingOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/settings/billing/packages"]["response"]; + }; + getGithubPackagesBillingUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/settings/billing/packages"]["response"]; + }; + getSharedStorageBillingOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/settings/billing/shared-storage"]["response"]; + }; + getSharedStorageBillingUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/settings/billing/shared-storage"]["response"]; + }; + }; + checks: { + create: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/check-runs"]["response"]; + }; + createSuite: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/check-suites"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}"]["response"]; + }; + getSuite: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}"]["response"]; + }; + listAnnotations: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"]["response"]; + }; + listForRef: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"]["response"]; + }; + listForSuite: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"]["response"]; + }; + listSuitesForRef: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["response"]; + }; + rerequestSuite: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"]["response"]; + }; + setSuitesPreferences: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/check-suites/preferences"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"]["response"]; + }; + }; + codeScanning: { + getAlert: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"]["response"]; + }; + listAlertsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts"]["response"]; + }; + listRecentAnalyses: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/analyses"]["response"]; + }; + updateAlert: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"]["response"]; + }; + uploadSarif: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/code-scanning/sarifs"]["response"]; + }; + }; + codesOfConduct: { + getAllCodesOfConduct: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /codes_of_conduct"]["response"]; + }; + getConductCode: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /codes_of_conduct/{key}"]["response"]; + }; + getForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/community/code_of_conduct"]["response"]; + }; + }; + emojis: { + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /emojis"]["response"]; + }; + }; + enterpriseAdmin: { + disableSelectedOrganizationGithubActionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"]["response"]; + }; + enableSelectedOrganizationGithubActionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"]["response"]; + }; + getAllowedActionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/selected-actions"]["response"]; + }; + getGithubActionsPermissionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /enterprises/{enterprise}/actions/permissions"]["response"]; + }; + listSelectedOrganizationsEnabledGithubActionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["response"]; + }; + setAllowedActionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/selected-actions"]["response"]; + }; + setGithubActionsPermissionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions"]["response"]; + }; + setSelectedOrganizationsEnabledGithubActionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/organizations"]["response"]; + }; + }; + gists: { + checkIsStarred: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}/star"]["response"]; + }; + create: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /gists"]["response"]; + }; + createComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /gists/{gist_id}/comments"]["response"]; + }; + delete: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /gists/{gist_id}"]["response"]; + }; + deleteComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /gists/{gist_id}/comments/{comment_id}"]["response"]; + }; + fork: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /gists/{gist_id}/forks"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}"]["response"]; + }; + getComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}/comments/{comment_id}"]["response"]; + }; + getRevision: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}/{sha}"]["response"]; + }; + list: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists"]["response"]; + }; + listComments: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}/comments"]["response"]; + }; + listCommits: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}/commits"]["response"]; + }; + listForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/gists"]["response"]; + }; + listForks: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}/forks"]["response"]; + }; + listPublic: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/public"]["response"]; + }; + listStarred: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/starred"]["response"]; + }; + star: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /gists/{gist_id}/star"]["response"]; + }; + unstar: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /gists/{gist_id}/star"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /gists/{gist_id}"]["response"]; + }; + updateComment: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /gists/{gist_id}/comments/{comment_id}"]["response"]; + }; + }; + git: { + createBlob: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/git/blobs"]["response"]; + }; + createCommit: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/git/commits"]["response"]; + }; + createRef: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/git/refs"]["response"]; + }; + createTag: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/git/tags"]["response"]; + }; + createTree: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/git/trees"]["response"]; + }; + deleteRef: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/git/refs/{ref}"]["response"]; + }; + getBlob: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"]["response"]; + }; + getCommit: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"]["response"]; + }; + getRef: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/git/ref/{ref}"]["response"]; + }; + getTag: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"]["response"]; + }; + getTree: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"]["response"]; + }; + listMatchingRefs: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"]["response"]; + }; + updateRef: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/git/refs/{ref}"]["response"]; + }; + }; + gitignore: { + getAllTemplates: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gitignore/templates"]["response"]; + }; + getTemplate: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gitignore/templates/{name}"]["response"]; + }; + }; + interactions: { + getRestrictionsForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/interaction-limits"]["response"]; + }; + getRestrictionsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/interaction-limits"]["response"]; + }; + getRestrictionsForYourPublicRepos: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/interaction-limits"]["response"]; + }; + removeRestrictionsForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/interaction-limits"]["response"]; + }; + removeRestrictionsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/interaction-limits"]["response"]; + }; + removeRestrictionsForYourPublicRepos: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/interaction-limits"]["response"]; + }; + setRestrictionsForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/interaction-limits"]["response"]; + }; + setRestrictionsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/interaction-limits"]["response"]; + }; + setRestrictionsForYourPublicRepos: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /user/interaction-limits"]["response"]; + }; + }; + issues: { + addAssignees: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/assignees"]["response"]; + }; + addLabels: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; + }; + checkUserCanBeAssigned: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/assignees/{assignee}"]["response"]; + }; + create: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/issues"]["response"]; + }; + createComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/comments"]["response"]; + }; + createLabel: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/labels"]["response"]; + }; + createMilestone: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/milestones"]["response"]; + }; + deleteComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}"]["response"]; + }; + deleteLabel: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/labels/{name}"]["response"]; + }; + deleteMilestone: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/milestones/{milestone_number}"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}"]["response"]; + }; + getComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"]["response"]; + }; + getEvent: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/events/{event_id}"]["response"]; + }; + getLabel: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/labels/{name}"]["response"]; + }; + getMilestone: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}"]["response"]; + }; + list: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /issues"]["response"]; + }; + listAssignees: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/assignees"]["response"]; + }; + listComments: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"]["response"]; + }; + listCommentsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments"]["response"]; + }; + listEvents: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/events"]["response"]; + }; + listEventsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/events"]["response"]; + }; + listEventsForTimeline: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline"]["response"]; + }; + listForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/issues"]["response"]; + }; + listForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/issues"]["response"]; + }; + listForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues"]["response"]; + }; + listLabelsForMilestone: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels"]["response"]; + }; + listLabelsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/labels"]["response"]; + }; + listLabelsOnIssue: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; + }; + listMilestones: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/milestones"]["response"]; + }; + lock: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"]["response"]; + }; + removeAllLabels: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; + }; + removeAssignees: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees"]["response"]; + }; + removeLabel: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}"]["response"]; + }; + setLabels: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; + }; + unlock: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/issues/{issue_number}"]["response"]; + }; + updateComment: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"]["response"]; + }; + updateLabel: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/labels/{name}"]["response"]; + }; + updateMilestone: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/milestones/{milestone_number}"]["response"]; + }; + }; + licenses: { + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /licenses/{license}"]["response"]; + }; + getAllCommonlyUsed: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /licenses"]["response"]; + }; + getForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/license"]["response"]; + }; + }; + markdown: { + render: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /markdown"]["response"]; + }; + renderRaw: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /markdown/raw"]["response"]; + }; + }; + meta: { + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /meta"]["response"]; + }; + getOctocat: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /octocat"]["response"]; + }; + getZen: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /zen"]["response"]; + }; + root: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /"]["response"]; + }; + }; + migrations: { + cancelImport: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/import"]["response"]; + }; + deleteArchiveForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/migrations/{migration_id}/archive"]["response"]; + }; + deleteArchiveForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/migrations/{migration_id}/archive"]["response"]; + }; + downloadArchiveForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/migrations/{migration_id}/archive"]["response"]; + }; + getArchiveForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/migrations/{migration_id}/archive"]["response"]; + }; + getCommitAuthors: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/import/authors"]["response"]; + }; + getImportStatus: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/import"]["response"]; + }; + getLargeFiles: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/import/large_files"]["response"]; + }; + getStatusForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/migrations/{migration_id}"]["response"]; + }; + getStatusForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/migrations/{migration_id}"]["response"]; + }; + listForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/migrations"]["response"]; + }; + listForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/migrations"]["response"]; + }; + listReposForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["response"]; + }; + listReposForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/migrations/{migration_id}/repositories"]["response"]; + }; + mapCommitAuthor: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"]["response"]; + }; + setLfsPreference: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/import/lfs"]["response"]; + }; + startForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/migrations"]["response"]; + }; + startForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/migrations"]["response"]; + }; + startImport: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/import"]["response"]; + }; + unlockRepoForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock"]["response"]; + }; + unlockRepoForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock"]["response"]; + }; + updateImport: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/import"]["response"]; + }; + }; + orgs: { + blockUser: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/blocks/{username}"]["response"]; + }; + checkBlockedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/blocks/{username}"]["response"]; + }; + checkMembershipForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/members/{username}"]["response"]; + }; + checkPublicMembershipForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/public_members/{username}"]["response"]; + }; + convertMemberToOutsideCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/outside_collaborators/{username}"]["response"]; + }; + createInvitation: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/invitations"]["response"]; + }; + createWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/hooks"]["response"]; + }; + deleteWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/hooks/{hook_id}"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}"]["response"]; + }; + getMembershipForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/memberships/orgs/{org}"]["response"]; + }; + getMembershipForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/memberships/{username}"]["response"]; + }; + getWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/hooks/{hook_id}"]["response"]; + }; + getWebhookConfigForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/hooks/{hook_id}/config"]["response"]; + }; + list: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /organizations"]["response"]; + }; + listAppInstallations: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/installations"]["response"]; + }; + listBlockedUsers: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/blocks"]["response"]; + }; + listForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/orgs"]["response"]; + }; + listForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/orgs"]["response"]; + }; + listInvitationTeams: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["response"]; + }; + listMembers: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/members"]["response"]; + }; + listMembershipsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/memberships/orgs"]["response"]; + }; + listOutsideCollaborators: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/outside_collaborators"]["response"]; + }; + listPendingInvitations: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/invitations"]["response"]; + }; + listPublicMembers: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/public_members"]["response"]; + }; + listWebhooks: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/hooks"]["response"]; + }; + pingWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/hooks/{hook_id}/pings"]["response"]; + }; + removeMember: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/members/{username}"]["response"]; + }; + removeMembershipForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/memberships/{username}"]["response"]; + }; + removeOutsideCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/outside_collaborators/{username}"]["response"]; + }; + removePublicMembershipForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/public_members/{username}"]["response"]; + }; + setMembershipForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/memberships/{username}"]["response"]; + }; + setPublicMembershipForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/public_members/{username}"]["response"]; + }; + unblockUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/blocks/{username}"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /orgs/{org}"]["response"]; + }; + updateMembershipForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /user/memberships/orgs/{org}"]["response"]; + }; + updateWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /orgs/{org}/hooks/{hook_id}"]["response"]; + }; + updateWebhookConfigForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /orgs/{org}/hooks/{hook_id}/config"]["response"]; + }; + }; + projects: { + addCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /projects/{project_id}/collaborators/{username}"]["response"]; + }; + createCard: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /projects/columns/{column_id}/cards"]["response"]; + }; + createColumn: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /projects/{project_id}/columns"]["response"]; + }; + createForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/projects"]["response"]; + }; + createForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/projects"]["response"]; + }; + createForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/projects"]["response"]; + }; + delete: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /projects/{project_id}"]["response"]; + }; + deleteCard: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /projects/columns/cards/{card_id}"]["response"]; + }; + deleteColumn: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /projects/columns/{column_id}"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/{project_id}"]["response"]; + }; + getCard: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/columns/cards/{card_id}"]["response"]; + }; + getColumn: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/columns/{column_id}"]["response"]; + }; + getPermissionForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/{project_id}/collaborators/{username}/permission"]["response"]; + }; + listCards: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/columns/{column_id}/cards"]["response"]; + }; + listCollaborators: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/{project_id}/collaborators"]["response"]; + }; + listColumns: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/{project_id}/columns"]["response"]; + }; + listForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/projects"]["response"]; + }; + listForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/projects"]["response"]; + }; + listForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/projects"]["response"]; + }; + moveCard: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /projects/columns/cards/{card_id}/moves"]["response"]; + }; + moveColumn: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /projects/columns/{column_id}/moves"]["response"]; + }; + removeCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /projects/{project_id}/collaborators/{username}"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /projects/{project_id}"]["response"]; + }; + updateCard: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /projects/columns/cards/{card_id}"]["response"]; + }; + updateColumn: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /projects/columns/{column_id}"]["response"]; + }; + }; + pulls: { + checkIfMerged: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"]["response"]; + }; + create: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls"]["response"]; + }; + createReplyForReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"]["response"]; + }; + createReview: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["response"]; + }; + createReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["response"]; + }; + deletePendingReview: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"]["response"]; + }; + deleteReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}"]["response"]; + }; + dismissReview: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}"]["response"]; + }; + getReview: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"]["response"]; + }; + getReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"]["response"]; + }; + list: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls"]["response"]; + }; + listCommentsForReview: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments"]["response"]; + }; + listCommits: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["response"]; + }; + listFiles: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"]["response"]; + }; + listRequestedReviewers: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"]; + }; + listReviewComments: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["response"]; + }; + listReviewCommentsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments"]["response"]; + }; + listReviews: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["response"]; + }; + merge: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"]["response"]; + }; + removeRequestedReviewers: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"]; + }; + requestReviewers: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"]; + }; + submitReview: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"]["response"]; + }; + updateBranch: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch"]["response"]; + }; + updateReview: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"]["response"]; + }; + updateReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}"]["response"]; + }; + }; + rateLimit: { + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /rate_limit"]["response"]; + }; + }; + reactions: { + createForCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["response"]; + }; + createForIssue: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["response"]; + }; + createForIssueComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["response"]; + }; + createForPullRequestReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["response"]; + }; + createForTeamDiscussionCommentInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"]; + }; + createForTeamDiscussionInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["response"]; + }; + deleteForCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}"]["response"]; + }; + deleteForIssue: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}"]["response"]; + }; + deleteForIssueComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}"]["response"]; + }; + deleteForPullRequestComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}"]["response"]; + }; + deleteForTeamDiscussion: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}"]["response"]; + }; + deleteForTeamDiscussionComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"]["response"]; + }; + deleteLegacy: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /reactions/{reaction_id}"]["response"]; + }; + listForCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["response"]; + }; + listForIssue: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["response"]; + }; + listForIssueComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["response"]; + }; + listForPullRequestReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["response"]; + }; + listForTeamDiscussionCommentInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"]; + }; + listForTeamDiscussionInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["response"]; + }; + }; + repos: { + acceptInvitation: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["response"]; + }; + addAppAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; + }; + addCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/collaborators/{username}"]["response"]; + }; + addStatusCheckContexts: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["response"]; + }; + addTeamAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["response"]; + }; + addUserAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; + }; + checkCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/collaborators/{username}"]["response"]; + }; + checkVulnerabilityAlerts: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/vulnerability-alerts"]["response"]; + }; + compareCommits: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/compare/{base}...{head}"]["response"]; + }; + createCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["response"]; + }; + createCommitSignatureProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"]["response"]; + }; + createCommitStatus: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/statuses/{sha}"]["response"]; + }; + createDeployKey: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/keys"]["response"]; + }; + createDeployment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/deployments"]["response"]; + }; + createDeploymentStatus: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["response"]; + }; + createDispatchEvent: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/dispatches"]["response"]; + }; + createForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/repos"]["response"]; + }; + createFork: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/forks"]["response"]; + }; + createInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/repos"]["response"]; + }; + createOrUpdateFileContents: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/contents/{path}"]["response"]; + }; + createPagesSite: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pages"]["response"]; + }; + createRelease: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/releases"]["response"]; + }; + createUsingTemplate: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{template_owner}/{template_repo}/generate"]["response"]; + }; + createWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/hooks"]["response"]; + }; + declineInvitation: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["response"]; + }; + delete: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}"]["response"]; + }; + deleteAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"]["response"]; + }; + deleteAdminBranchProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"]["response"]; + }; + deleteBranchProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection"]["response"]; + }; + deleteCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/comments/{comment_id}"]["response"]; + }; + deleteCommitSignatureProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"]["response"]; + }; + deleteDeployKey: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/keys/{key_id}"]["response"]; + }; + deleteDeployment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/deployments/{deployment_id}"]["response"]; + }; + deleteFile: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/contents/{path}"]["response"]; + }; + deleteInvitation: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/invitations/{invitation_id}"]["response"]; + }; + deletePagesSite: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/pages"]["response"]; + }; + deletePullRequestReviewProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"]["response"]; + }; + deleteRelease: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/releases/{release_id}"]["response"]; + }; + deleteReleaseAsset: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}"]["response"]; + }; + deleteWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"]["response"]; + }; + disableAutomatedSecurityFixes: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/automated-security-fixes"]["response"]; + }; + disableVulnerabilityAlerts: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/vulnerability-alerts"]["response"]; + }; + downloadArchive: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/zipball/{ref}"]["response"]; + }; + downloadTarballArchive: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/tarball/{ref}"]["response"]; + }; + downloadZipballArchive: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/zipball/{ref}"]["response"]; + }; + enableAutomatedSecurityFixes: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/automated-security-fixes"]["response"]; + }; + enableVulnerabilityAlerts: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/vulnerability-alerts"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}"]["response"]; + }; + getAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"]["response"]; + }; + getAdminBranchProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"]["response"]; + }; + getAllStatusCheckContexts: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["response"]; + }; + getAllTopics: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/topics"]["response"]; + }; + getAppsWithAccessToProtectedBranch: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; + }; + getBranch: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}"]["response"]; + }; + getBranchProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection"]["response"]; + }; + getClones: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/traffic/clones"]["response"]; + }; + getCodeFrequencyStats: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/stats/code_frequency"]["response"]; + }; + getCollaboratorPermissionLevel: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/collaborators/{username}/permission"]["response"]; + }; + getCombinedStatusForRef: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/status"]["response"]; + }; + getCommit: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}"]["response"]; + }; + getCommitActivityStats: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/stats/commit_activity"]["response"]; + }; + getCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}"]["response"]; + }; + getCommitSignatureProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"]["response"]; + }; + getCommunityProfileMetrics: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/community/profile"]["response"]; + }; + getContent: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/contents/{path}"]["response"]; + }; + getContributorsStats: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/stats/contributors"]["response"]; + }; + getDeployKey: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/keys/{key_id}"]["response"]; + }; + getDeployment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}"]["response"]; + }; + getDeploymentStatus: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}"]["response"]; + }; + getLatestPagesBuild: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pages/builds/latest"]["response"]; + }; + getLatestRelease: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/releases/latest"]["response"]; + }; + getPages: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pages"]["response"]; + }; + getPagesBuild: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pages/builds/{build_id}"]["response"]; + }; + getParticipationStats: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/stats/participation"]["response"]; + }; + getPullRequestReviewProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"]["response"]; + }; + getPunchCardStats: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/stats/punch_card"]["response"]; + }; + getReadme: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/readme"]["response"]; + }; + getRelease: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}"]["response"]; + }; + getReleaseAsset: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"]["response"]; + }; + getReleaseByTag: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/releases/tags/{tag}"]["response"]; + }; + getStatusChecksProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["response"]; + }; + getTeamsWithAccessToProtectedBranch: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["response"]; + }; + getTopPaths: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/traffic/popular/paths"]["response"]; + }; + getTopReferrers: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/traffic/popular/referrers"]["response"]; + }; + getUsersWithAccessToProtectedBranch: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; + }; + getViews: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/traffic/views"]["response"]; + }; + getWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}"]["response"]; + }; + getWebhookConfigForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/config"]["response"]; + }; + listBranches: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches"]["response"]; + }; + listBranchesForHeadCommit: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head"]["response"]; + }; + listCollaborators: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/collaborators"]["response"]; + }; + listCommentsForCommit: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["response"]; + }; + listCommitCommentsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/comments"]["response"]; + }; + listCommitStatusesForRef: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/statuses"]["response"]; + }; + listCommits: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits"]["response"]; + }; + listContributors: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/contributors"]["response"]; + }; + listDeployKeys: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/keys"]["response"]; + }; + listDeploymentStatuses: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["response"]; + }; + listDeployments: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/deployments"]["response"]; + }; + listForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/repos"]["response"]; + }; + listForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/repos"]["response"]; + }; + listForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/repos"]["response"]; + }; + listForks: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/forks"]["response"]; + }; + listInvitations: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/invitations"]["response"]; + }; + listInvitationsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/repository_invitations"]["response"]; + }; + listLanguages: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/languages"]["response"]; + }; + listPagesBuilds: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pages/builds"]["response"]; + }; + listPublic: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repositories"]["response"]; + }; + listPullRequestsAssociatedWithCommit: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls"]["response"]; + }; + listReleaseAssets: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/assets"]["response"]; + }; + listReleases: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/releases"]["response"]; + }; + listTags: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/tags"]["response"]; + }; + listTeams: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/teams"]["response"]; + }; + listWebhooks: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/hooks"]["response"]; + }; + merge: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/merges"]["response"]; + }; + pingWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"]["response"]; + }; + removeAppAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; + }; + removeCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/collaborators/{username}"]["response"]; + }; + removeStatusCheckContexts: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["response"]; + }; + removeStatusCheckProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["response"]; + }; + removeTeamAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["response"]; + }; + removeUserAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; + }; + replaceAllTopics: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/topics"]["response"]; + }; + requestPagesBuild: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pages/builds"]["response"]; + }; + setAdminBranchProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"]["response"]; + }; + setAppAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; + }; + setStatusCheckContexts: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["response"]; + }; + setTeamAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["response"]; + }; + setUserAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; + }; + testPushWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"]["response"]; + }; + transfer: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/transfer"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}"]["response"]; + }; + updateBranchProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection"]["response"]; + }; + updateCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/comments/{comment_id}"]["response"]; + }; + updateInformationAboutPagesSite: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/pages"]["response"]; + }; + updateInvitation: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/invitations/{invitation_id}"]["response"]; + }; + updatePullRequestReviewProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"]["response"]; + }; + updateRelease: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/releases/{release_id}"]["response"]; + }; + updateReleaseAsset: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}"]["response"]; + }; + updateStatusCheckPotection: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["response"]; + }; + updateStatusCheckProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["response"]; + }; + updateWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"]["response"]; + }; + updateWebhookConfigForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config"]["response"]; + }; + uploadReleaseAsset: { + parameters: RequestParameters & Omit; + response: Endpoints["POST {origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}"]["response"]; + }; + }; + search: { + code: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/code"]["response"]; + }; + commits: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/commits"]["response"]; + }; + issuesAndPullRequests: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/issues"]["response"]; + }; + labels: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/labels"]["response"]; + }; + repos: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/repositories"]["response"]; + }; + topics: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/topics"]["response"]; + }; + users: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/users"]["response"]; + }; + }; + secretScanning: { + getAlert: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"]["response"]; + }; + listAlertsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["response"]; + }; + updateAlert: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"]["response"]; + }; + }; + teams: { + addOrUpdateMembershipForUserInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/teams/{team_slug}/memberships/{username}"]["response"]; + }; + addOrUpdateProjectPermissionsInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["response"]; + }; + addOrUpdateRepoPermissionsInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["response"]; + }; + checkPermissionsForProjectInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["response"]; + }; + checkPermissionsForRepoInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["response"]; + }; + create: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/teams"]["response"]; + }; + createDiscussionCommentInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["response"]; + }; + createDiscussionInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions"]["response"]; + }; + deleteDiscussionCommentInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"]["response"]; + }; + deleteDiscussionInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"]["response"]; + }; + deleteInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}"]["response"]; + }; + getByName: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}"]["response"]; + }; + getDiscussionCommentInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"]["response"]; + }; + getDiscussionInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"]["response"]; + }; + getMembershipForUserInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/memberships/{username}"]["response"]; + }; + list: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams"]["response"]; + }; + listChildInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/teams"]["response"]; + }; + listDiscussionCommentsInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["response"]; + }; + listDiscussionsInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions"]["response"]; + }; + listForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/teams"]["response"]; + }; + listMembersInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/members"]["response"]; + }; + listPendingInvitationsInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/invitations"]["response"]; + }; + listProjectsInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["response"]; + }; + listReposInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["response"]; + }; + removeMembershipForUserInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}"]["response"]; + }; + removeProjectInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["response"]; + }; + removeRepoInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["response"]; + }; + updateDiscussionCommentInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"]["response"]; + }; + updateDiscussionInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"]["response"]; + }; + updateInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /orgs/{org}/teams/{team_slug}"]["response"]; + }; + }; + users: { + addEmailForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/emails"]["response"]; + }; + block: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /user/blocks/{username}"]["response"]; + }; + checkBlocked: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/blocks/{username}"]["response"]; + }; + checkFollowingForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/following/{target_user}"]["response"]; + }; + checkPersonIsFollowedByAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/following/{username}"]["response"]; + }; + createGpgKeyForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/gpg_keys"]["response"]; + }; + createPublicSshKeyForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/keys"]["response"]; + }; + deleteEmailForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/emails"]["response"]; + }; + deleteGpgKeyForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["response"]; + }; + deletePublicSshKeyForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/keys/{key_id}"]["response"]; + }; + follow: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /user/following/{username}"]["response"]; + }; + getAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user"]["response"]; + }; + getByUsername: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}"]["response"]; + }; + getContextForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/hovercard"]["response"]; + }; + getGpgKeyForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["response"]; + }; + getPublicSshKeyForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/keys/{key_id}"]["response"]; + }; + list: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users"]["response"]; + }; + listBlockedByAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/blocks"]["response"]; + }; + listEmailsForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/emails"]["response"]; + }; + listFollowedByAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/following"]["response"]; + }; + listFollowersForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/followers"]["response"]; + }; + listFollowersForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/followers"]["response"]; + }; + listFollowingForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/following"]["response"]; + }; + listGpgKeysForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/gpg_keys"]["response"]; + }; + listGpgKeysForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/gpg_keys"]["response"]; + }; + listPublicEmailsForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/public_emails"]["response"]; + }; + listPublicKeysForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/keys"]["response"]; + }; + listPublicSshKeysForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/keys"]["response"]; + }; + setPrimaryEmailVisibilityForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /user/email/visibility"]["response"]; + }; + unblock: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/blocks/{username}"]["response"]; + }; + unfollow: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/following/{username}"]["response"]; + }; + updateAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /user"]["response"]; + }; + }; +}; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/index.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/index.d.ts new file mode 100644 index 0000000..455e998 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/index.d.ts @@ -0,0 +1,17 @@ +import { Octokit } from "@octokit/core"; +export { RestEndpointMethodTypes } from "./generated/parameters-and-response-types"; +import { Api } from "./types"; +/** + * This plugin is a 1:1 copy of internal @octokit/rest plugins. The primary + * goal is to rebuild @octokit/rest on top of @octokit/core. Once that is + * done, we will remove the registerEndpoints methods and return the methods + * directly as with the other plugins. At that point we will also remove the + * legacy workarounds and deprecations. + * + * See the plan at + * https://github.com/octokit/plugin-rest-endpoint-methods.js/pull/1 + */ +export declare function restEndpointMethods(octokit: Octokit): Api; +export declare namespace restEndpointMethods { + var VERSION: string; +} diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/types.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/types.d.ts new file mode 100644 index 0000000..e9b177b --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/types.d.ts @@ -0,0 +1,16 @@ +import { Route, RequestParameters } from "@octokit/types"; +import { RestEndpointMethods } from "./generated/method-types"; +export declare type Api = RestEndpointMethods; +export declare type EndpointDecorations = { + mapToData?: string; + deprecated?: string; + renamed?: [string, string]; + renamedParameters?: { + [name: string]: string; + }; +}; +export declare type EndpointsDefaultsAndDecorations = { + [scope: string]: { + [methodName: string]: [Route, RequestParameters?, EndpointDecorations?]; + }; +}; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/version.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/version.d.ts new file mode 100644 index 0000000..40e85aa --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "4.5.2"; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js new file mode 100644 index 0000000..f6d75d8 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js @@ -0,0 +1,1354 @@ +const Endpoints = { + actions: { + addSelectedRepoToOrgSecret: [ + "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + ], + cancelWorkflowRun: [ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel", + ], + createOrUpdateOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}"], + createOrUpdateRepoSecret: [ + "PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}", + ], + createRegistrationTokenForOrg: [ + "POST /orgs/{org}/actions/runners/registration-token", + ], + createRegistrationTokenForRepo: [ + "POST /repos/{owner}/{repo}/actions/runners/registration-token", + ], + createRemoveTokenForOrg: ["POST /orgs/{org}/actions/runners/remove-token"], + createRemoveTokenForRepo: [ + "POST /repos/{owner}/{repo}/actions/runners/remove-token", + ], + createWorkflowDispatch: [ + "POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", + ], + deleteArtifact: [ + "DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}", + ], + deleteOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}"], + deleteRepoSecret: [ + "DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}", + ], + deleteSelfHostedRunnerFromOrg: [ + "DELETE /orgs/{org}/actions/runners/{runner_id}", + ], + deleteSelfHostedRunnerFromRepo: [ + "DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}", + ], + deleteWorkflowRun: ["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}"], + deleteWorkflowRunLogs: [ + "DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs", + ], + disableSelectedRepositoryGithubActionsOrganization: [ + "DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}", + ], + disableWorkflow: [ + "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", + ], + downloadArtifact: [ + "GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", + ], + downloadJobLogsForWorkflowRun: [ + "GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs", + ], + downloadWorkflowRunLogs: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs", + ], + enableSelectedRepositoryGithubActionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/repositories/{repository_id}", + ], + enableWorkflow: [ + "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", + ], + getAllowedActionsOrganization: [ + "GET /orgs/{org}/actions/permissions/selected-actions", + ], + getAllowedActionsRepository: [ + "GET /repos/{owner}/{repo}/actions/permissions/selected-actions", + ], + getArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"], + getGithubActionsPermissionsOrganization: [ + "GET /orgs/{org}/actions/permissions", + ], + getGithubActionsPermissionsRepository: [ + "GET /repos/{owner}/{repo}/actions/permissions", + ], + getJobForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"], + getOrgPublicKey: ["GET /orgs/{org}/actions/secrets/public-key"], + getOrgSecret: ["GET /orgs/{org}/actions/secrets/{secret_name}"], + getRepoPermissions: [ + "GET /repos/{owner}/{repo}/actions/permissions", + {}, + { renamed: ["actions", "getGithubActionsPermissionsRepository"] }, + ], + getRepoPublicKey: ["GET /repos/{owner}/{repo}/actions/secrets/public-key"], + getRepoSecret: ["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"], + getSelfHostedRunnerForOrg: ["GET /orgs/{org}/actions/runners/{runner_id}"], + getSelfHostedRunnerForRepo: [ + "GET /repos/{owner}/{repo}/actions/runners/{runner_id}", + ], + getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], + getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], + getWorkflowRunUsage: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing", + ], + getWorkflowUsage: [ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", + ], + listArtifactsForRepo: ["GET /repos/{owner}/{repo}/actions/artifacts"], + listJobsForWorkflowRun: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", + ], + listOrgSecrets: ["GET /orgs/{org}/actions/secrets"], + listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], + listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], + listRunnerApplicationsForOrg: ["GET /orgs/{org}/actions/runners/downloads"], + listRunnerApplicationsForRepo: [ + "GET /repos/{owner}/{repo}/actions/runners/downloads", + ], + listSelectedReposForOrgSecret: [ + "GET /orgs/{org}/actions/secrets/{secret_name}/repositories", + ], + listSelectedRepositoriesEnabledGithubActionsOrganization: [ + "GET /orgs/{org}/actions/permissions/repositories", + ], + listSelfHostedRunnersForOrg: ["GET /orgs/{org}/actions/runners"], + listSelfHostedRunnersForRepo: ["GET /repos/{owner}/{repo}/actions/runners"], + listWorkflowRunArtifacts: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", + ], + listWorkflowRuns: [ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", + ], + listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"], + reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"], + removeSelectedRepoFromOrgSecret: [ + "DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + ], + setAllowedActionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/selected-actions", + ], + setAllowedActionsRepository: [ + "PUT /repos/{owner}/{repo}/actions/permissions/selected-actions", + ], + setGithubActionsPermissionsOrganization: [ + "PUT /orgs/{org}/actions/permissions", + ], + setGithubActionsPermissionsRepository: [ + "PUT /repos/{owner}/{repo}/actions/permissions", + ], + setSelectedReposForOrgSecret: [ + "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories", + ], + setSelectedRepositoriesEnabledGithubActionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/repositories", + ], + }, + activity: { + checkRepoIsStarredByAuthenticatedUser: ["GET /user/starred/{owner}/{repo}"], + deleteRepoSubscription: ["DELETE /repos/{owner}/{repo}/subscription"], + deleteThreadSubscription: [ + "DELETE /notifications/threads/{thread_id}/subscription", + ], + getFeeds: ["GET /feeds"], + getRepoSubscription: ["GET /repos/{owner}/{repo}/subscription"], + getThread: ["GET /notifications/threads/{thread_id}"], + getThreadSubscriptionForAuthenticatedUser: [ + "GET /notifications/threads/{thread_id}/subscription", + ], + listEventsForAuthenticatedUser: ["GET /users/{username}/events"], + listNotificationsForAuthenticatedUser: ["GET /notifications"], + listOrgEventsForAuthenticatedUser: [ + "GET /users/{username}/events/orgs/{org}", + ], + listPublicEvents: ["GET /events"], + listPublicEventsForRepoNetwork: ["GET /networks/{owner}/{repo}/events"], + listPublicEventsForUser: ["GET /users/{username}/events/public"], + listPublicOrgEvents: ["GET /orgs/{org}/events"], + listReceivedEventsForUser: ["GET /users/{username}/received_events"], + listReceivedPublicEventsForUser: [ + "GET /users/{username}/received_events/public", + ], + listRepoEvents: ["GET /repos/{owner}/{repo}/events"], + listRepoNotificationsForAuthenticatedUser: [ + "GET /repos/{owner}/{repo}/notifications", + ], + listReposStarredByAuthenticatedUser: ["GET /user/starred"], + listReposStarredByUser: ["GET /users/{username}/starred"], + listReposWatchedByUser: ["GET /users/{username}/subscriptions"], + listStargazersForRepo: ["GET /repos/{owner}/{repo}/stargazers"], + listWatchedReposForAuthenticatedUser: ["GET /user/subscriptions"], + listWatchersForRepo: ["GET /repos/{owner}/{repo}/subscribers"], + markNotificationsAsRead: ["PUT /notifications"], + markRepoNotificationsAsRead: ["PUT /repos/{owner}/{repo}/notifications"], + markThreadAsRead: ["PATCH /notifications/threads/{thread_id}"], + setRepoSubscription: ["PUT /repos/{owner}/{repo}/subscription"], + setThreadSubscription: [ + "PUT /notifications/threads/{thread_id}/subscription", + ], + starRepoForAuthenticatedUser: ["PUT /user/starred/{owner}/{repo}"], + unstarRepoForAuthenticatedUser: ["DELETE /user/starred/{owner}/{repo}"], + }, + apps: { + addRepoToInstallation: [ + "PUT /user/installations/{installation_id}/repositories/{repository_id}", + ], + checkToken: ["POST /applications/{client_id}/token"], + createContentAttachment: [ + "POST /content_references/{content_reference_id}/attachments", + { mediaType: { previews: ["corsair"] } }, + ], + createFromManifest: ["POST /app-manifests/{code}/conversions"], + createInstallationAccessToken: [ + "POST /app/installations/{installation_id}/access_tokens", + ], + deleteAuthorization: ["DELETE /applications/{client_id}/grant"], + deleteInstallation: ["DELETE /app/installations/{installation_id}"], + deleteToken: ["DELETE /applications/{client_id}/token"], + getAuthenticated: ["GET /app"], + getBySlug: ["GET /apps/{app_slug}"], + getInstallation: ["GET /app/installations/{installation_id}"], + getOrgInstallation: ["GET /orgs/{org}/installation"], + getRepoInstallation: ["GET /repos/{owner}/{repo}/installation"], + getSubscriptionPlanForAccount: [ + "GET /marketplace_listing/accounts/{account_id}", + ], + getSubscriptionPlanForAccountStubbed: [ + "GET /marketplace_listing/stubbed/accounts/{account_id}", + ], + getUserInstallation: ["GET /users/{username}/installation"], + getWebhookConfigForApp: ["GET /app/hook/config"], + listAccountsForPlan: ["GET /marketplace_listing/plans/{plan_id}/accounts"], + listAccountsForPlanStubbed: [ + "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts", + ], + listInstallationReposForAuthenticatedUser: [ + "GET /user/installations/{installation_id}/repositories", + ], + listInstallations: ["GET /app/installations"], + listInstallationsForAuthenticatedUser: ["GET /user/installations"], + listPlans: ["GET /marketplace_listing/plans"], + listPlansStubbed: ["GET /marketplace_listing/stubbed/plans"], + listReposAccessibleToInstallation: ["GET /installation/repositories"], + listSubscriptionsForAuthenticatedUser: ["GET /user/marketplace_purchases"], + listSubscriptionsForAuthenticatedUserStubbed: [ + "GET /user/marketplace_purchases/stubbed", + ], + removeRepoFromInstallation: [ + "DELETE /user/installations/{installation_id}/repositories/{repository_id}", + ], + resetToken: ["PATCH /applications/{client_id}/token"], + revokeInstallationAccessToken: ["DELETE /installation/token"], + scopeToken: ["POST /applications/{client_id}/token/scoped"], + suspendInstallation: ["PUT /app/installations/{installation_id}/suspended"], + unsuspendInstallation: [ + "DELETE /app/installations/{installation_id}/suspended", + ], + updateWebhookConfigForApp: ["PATCH /app/hook/config"], + }, + billing: { + getGithubActionsBillingOrg: ["GET /orgs/{org}/settings/billing/actions"], + getGithubActionsBillingUser: [ + "GET /users/{username}/settings/billing/actions", + ], + getGithubPackagesBillingOrg: ["GET /orgs/{org}/settings/billing/packages"], + getGithubPackagesBillingUser: [ + "GET /users/{username}/settings/billing/packages", + ], + getSharedStorageBillingOrg: [ + "GET /orgs/{org}/settings/billing/shared-storage", + ], + getSharedStorageBillingUser: [ + "GET /users/{username}/settings/billing/shared-storage", + ], + }, + checks: { + create: ["POST /repos/{owner}/{repo}/check-runs"], + createSuite: ["POST /repos/{owner}/{repo}/check-suites"], + get: ["GET /repos/{owner}/{repo}/check-runs/{check_run_id}"], + getSuite: ["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}"], + listAnnotations: [ + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + ], + listForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"], + listForSuite: [ + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + ], + listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"], + rerequestSuite: [ + "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", + ], + setSuitesPreferences: [ + "PATCH /repos/{owner}/{repo}/check-suites/preferences", + ], + update: ["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"], + }, + codeScanning: { + getAlert: [ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + {}, + { renamedParameters: { alert_id: "alert_number" } }, + ], + listAlertsForRepo: ["GET /repos/{owner}/{repo}/code-scanning/alerts"], + listRecentAnalyses: ["GET /repos/{owner}/{repo}/code-scanning/analyses"], + updateAlert: [ + "PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + ], + uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"], + }, + codesOfConduct: { + getAllCodesOfConduct: [ + "GET /codes_of_conduct", + { mediaType: { previews: ["scarlet-witch"] } }, + ], + getConductCode: [ + "GET /codes_of_conduct/{key}", + { mediaType: { previews: ["scarlet-witch"] } }, + ], + getForRepo: [ + "GET /repos/{owner}/{repo}/community/code_of_conduct", + { mediaType: { previews: ["scarlet-witch"] } }, + ], + }, + emojis: { get: ["GET /emojis"] }, + enterpriseAdmin: { + disableSelectedOrganizationGithubActionsEnterprise: [ + "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + ], + enableSelectedOrganizationGithubActionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + ], + getAllowedActionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions/selected-actions", + ], + getGithubActionsPermissionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions", + ], + listSelectedOrganizationsEnabledGithubActionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions/organizations", + ], + setAllowedActionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/selected-actions", + ], + setGithubActionsPermissionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions", + ], + setSelectedOrganizationsEnabledGithubActionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/organizations", + ], + }, + gists: { + checkIsStarred: ["GET /gists/{gist_id}/star"], + create: ["POST /gists"], + createComment: ["POST /gists/{gist_id}/comments"], + delete: ["DELETE /gists/{gist_id}"], + deleteComment: ["DELETE /gists/{gist_id}/comments/{comment_id}"], + fork: ["POST /gists/{gist_id}/forks"], + get: ["GET /gists/{gist_id}"], + getComment: ["GET /gists/{gist_id}/comments/{comment_id}"], + getRevision: ["GET /gists/{gist_id}/{sha}"], + list: ["GET /gists"], + listComments: ["GET /gists/{gist_id}/comments"], + listCommits: ["GET /gists/{gist_id}/commits"], + listForUser: ["GET /users/{username}/gists"], + listForks: ["GET /gists/{gist_id}/forks"], + listPublic: ["GET /gists/public"], + listStarred: ["GET /gists/starred"], + star: ["PUT /gists/{gist_id}/star"], + unstar: ["DELETE /gists/{gist_id}/star"], + update: ["PATCH /gists/{gist_id}"], + updateComment: ["PATCH /gists/{gist_id}/comments/{comment_id}"], + }, + git: { + createBlob: ["POST /repos/{owner}/{repo}/git/blobs"], + createCommit: ["POST /repos/{owner}/{repo}/git/commits"], + createRef: ["POST /repos/{owner}/{repo}/git/refs"], + createTag: ["POST /repos/{owner}/{repo}/git/tags"], + createTree: ["POST /repos/{owner}/{repo}/git/trees"], + deleteRef: ["DELETE /repos/{owner}/{repo}/git/refs/{ref}"], + getBlob: ["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"], + getCommit: ["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"], + getRef: ["GET /repos/{owner}/{repo}/git/ref/{ref}"], + getTag: ["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"], + getTree: ["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"], + listMatchingRefs: ["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"], + updateRef: ["PATCH /repos/{owner}/{repo}/git/refs/{ref}"], + }, + gitignore: { + getAllTemplates: ["GET /gitignore/templates"], + getTemplate: ["GET /gitignore/templates/{name}"], + }, + interactions: { + getRestrictionsForOrg: ["GET /orgs/{org}/interaction-limits"], + getRestrictionsForRepo: ["GET /repos/{owner}/{repo}/interaction-limits"], + getRestrictionsForYourPublicRepos: ["GET /user/interaction-limits"], + removeRestrictionsForOrg: ["DELETE /orgs/{org}/interaction-limits"], + removeRestrictionsForRepo: [ + "DELETE /repos/{owner}/{repo}/interaction-limits", + ], + removeRestrictionsForYourPublicRepos: ["DELETE /user/interaction-limits"], + setRestrictionsForOrg: ["PUT /orgs/{org}/interaction-limits"], + setRestrictionsForRepo: ["PUT /repos/{owner}/{repo}/interaction-limits"], + setRestrictionsForYourPublicRepos: ["PUT /user/interaction-limits"], + }, + issues: { + addAssignees: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/assignees", + ], + addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"], + checkUserCanBeAssigned: ["GET /repos/{owner}/{repo}/assignees/{assignee}"], + create: ["POST /repos/{owner}/{repo}/issues"], + createComment: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/comments", + ], + createLabel: ["POST /repos/{owner}/{repo}/labels"], + createMilestone: ["POST /repos/{owner}/{repo}/milestones"], + deleteComment: [ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}", + ], + deleteLabel: ["DELETE /repos/{owner}/{repo}/labels/{name}"], + deleteMilestone: [ + "DELETE /repos/{owner}/{repo}/milestones/{milestone_number}", + ], + get: ["GET /repos/{owner}/{repo}/issues/{issue_number}"], + getComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"], + getEvent: ["GET /repos/{owner}/{repo}/issues/events/{event_id}"], + getLabel: ["GET /repos/{owner}/{repo}/labels/{name}"], + getMilestone: ["GET /repos/{owner}/{repo}/milestones/{milestone_number}"], + list: ["GET /issues"], + listAssignees: ["GET /repos/{owner}/{repo}/assignees"], + listComments: ["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"], + listCommentsForRepo: ["GET /repos/{owner}/{repo}/issues/comments"], + listEvents: ["GET /repos/{owner}/{repo}/issues/{issue_number}/events"], + listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"], + listEventsForTimeline: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", + { mediaType: { previews: ["mockingbird"] } }, + ], + listForAuthenticatedUser: ["GET /user/issues"], + listForOrg: ["GET /orgs/{org}/issues"], + listForRepo: ["GET /repos/{owner}/{repo}/issues"], + listLabelsForMilestone: [ + "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels", + ], + listLabelsForRepo: ["GET /repos/{owner}/{repo}/labels"], + listLabelsOnIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/labels", + ], + listMilestones: ["GET /repos/{owner}/{repo}/milestones"], + lock: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"], + removeAllLabels: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels", + ], + removeAssignees: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees", + ], + removeLabel: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", + ], + setLabels: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"], + unlock: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"], + update: ["PATCH /repos/{owner}/{repo}/issues/{issue_number}"], + updateComment: ["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"], + updateLabel: ["PATCH /repos/{owner}/{repo}/labels/{name}"], + updateMilestone: [ + "PATCH /repos/{owner}/{repo}/milestones/{milestone_number}", + ], + }, + licenses: { + get: ["GET /licenses/{license}"], + getAllCommonlyUsed: ["GET /licenses"], + getForRepo: ["GET /repos/{owner}/{repo}/license"], + }, + markdown: { + render: ["POST /markdown"], + renderRaw: [ + "POST /markdown/raw", + { headers: { "content-type": "text/plain; charset=utf-8" } }, + ], + }, + meta: { + get: ["GET /meta"], + getOctocat: ["GET /octocat"], + getZen: ["GET /zen"], + root: ["GET /"], + }, + migrations: { + cancelImport: ["DELETE /repos/{owner}/{repo}/import"], + deleteArchiveForAuthenticatedUser: [ + "DELETE /user/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + deleteArchiveForOrg: [ + "DELETE /orgs/{org}/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + downloadArchiveForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + getArchiveForAuthenticatedUser: [ + "GET /user/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"], + getImportStatus: ["GET /repos/{owner}/{repo}/import"], + getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"], + getStatusForAuthenticatedUser: [ + "GET /user/migrations/{migration_id}", + { mediaType: { previews: ["wyandotte"] } }, + ], + getStatusForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}", + { mediaType: { previews: ["wyandotte"] } }, + ], + listForAuthenticatedUser: [ + "GET /user/migrations", + { mediaType: { previews: ["wyandotte"] } }, + ], + listForOrg: [ + "GET /orgs/{org}/migrations", + { mediaType: { previews: ["wyandotte"] } }, + ], + listReposForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}/repositories", + { mediaType: { previews: ["wyandotte"] } }, + ], + listReposForUser: [ + "GET /user/migrations/{migration_id}/repositories", + { mediaType: { previews: ["wyandotte"] } }, + ], + mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"], + setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"], + startForAuthenticatedUser: ["POST /user/migrations"], + startForOrg: ["POST /orgs/{org}/migrations"], + startImport: ["PUT /repos/{owner}/{repo}/import"], + unlockRepoForAuthenticatedUser: [ + "DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock", + { mediaType: { previews: ["wyandotte"] } }, + ], + unlockRepoForOrg: [ + "DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", + { mediaType: { previews: ["wyandotte"] } }, + ], + updateImport: ["PATCH /repos/{owner}/{repo}/import"], + }, + orgs: { + blockUser: ["PUT /orgs/{org}/blocks/{username}"], + checkBlockedUser: ["GET /orgs/{org}/blocks/{username}"], + checkMembershipForUser: ["GET /orgs/{org}/members/{username}"], + checkPublicMembershipForUser: ["GET /orgs/{org}/public_members/{username}"], + convertMemberToOutsideCollaborator: [ + "PUT /orgs/{org}/outside_collaborators/{username}", + ], + createInvitation: ["POST /orgs/{org}/invitations"], + createWebhook: ["POST /orgs/{org}/hooks"], + deleteWebhook: ["DELETE /orgs/{org}/hooks/{hook_id}"], + get: ["GET /orgs/{org}"], + getMembershipForAuthenticatedUser: ["GET /user/memberships/orgs/{org}"], + getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], + getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], + getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"], + list: ["GET /organizations"], + listAppInstallations: ["GET /orgs/{org}/installations"], + listBlockedUsers: ["GET /orgs/{org}/blocks"], + listForAuthenticatedUser: ["GET /user/orgs"], + listForUser: ["GET /users/{username}/orgs"], + listInvitationTeams: ["GET /orgs/{org}/invitations/{invitation_id}/teams"], + listMembers: ["GET /orgs/{org}/members"], + listMembershipsForAuthenticatedUser: ["GET /user/memberships/orgs"], + listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], + listPendingInvitations: ["GET /orgs/{org}/invitations"], + listPublicMembers: ["GET /orgs/{org}/public_members"], + listWebhooks: ["GET /orgs/{org}/hooks"], + pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], + removeMember: ["DELETE /orgs/{org}/members/{username}"], + removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"], + removeOutsideCollaborator: [ + "DELETE /orgs/{org}/outside_collaborators/{username}", + ], + removePublicMembershipForAuthenticatedUser: [ + "DELETE /orgs/{org}/public_members/{username}", + ], + setMembershipForUser: ["PUT /orgs/{org}/memberships/{username}"], + setPublicMembershipForAuthenticatedUser: [ + "PUT /orgs/{org}/public_members/{username}", + ], + unblockUser: ["DELETE /orgs/{org}/blocks/{username}"], + update: ["PATCH /orgs/{org}"], + updateMembershipForAuthenticatedUser: [ + "PATCH /user/memberships/orgs/{org}", + ], + updateWebhook: ["PATCH /orgs/{org}/hooks/{hook_id}"], + updateWebhookConfigForOrg: ["PATCH /orgs/{org}/hooks/{hook_id}/config"], + }, + projects: { + addCollaborator: [ + "PUT /projects/{project_id}/collaborators/{username}", + { mediaType: { previews: ["inertia"] } }, + ], + createCard: [ + "POST /projects/columns/{column_id}/cards", + { mediaType: { previews: ["inertia"] } }, + ], + createColumn: [ + "POST /projects/{project_id}/columns", + { mediaType: { previews: ["inertia"] } }, + ], + createForAuthenticatedUser: [ + "POST /user/projects", + { mediaType: { previews: ["inertia"] } }, + ], + createForOrg: [ + "POST /orgs/{org}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + createForRepo: [ + "POST /repos/{owner}/{repo}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + delete: [ + "DELETE /projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + deleteCard: [ + "DELETE /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } }, + ], + deleteColumn: [ + "DELETE /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } }, + ], + get: [ + "GET /projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + getCard: [ + "GET /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } }, + ], + getColumn: [ + "GET /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } }, + ], + getPermissionForUser: [ + "GET /projects/{project_id}/collaborators/{username}/permission", + { mediaType: { previews: ["inertia"] } }, + ], + listCards: [ + "GET /projects/columns/{column_id}/cards", + { mediaType: { previews: ["inertia"] } }, + ], + listCollaborators: [ + "GET /projects/{project_id}/collaborators", + { mediaType: { previews: ["inertia"] } }, + ], + listColumns: [ + "GET /projects/{project_id}/columns", + { mediaType: { previews: ["inertia"] } }, + ], + listForOrg: [ + "GET /orgs/{org}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + listForRepo: [ + "GET /repos/{owner}/{repo}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + listForUser: [ + "GET /users/{username}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + moveCard: [ + "POST /projects/columns/cards/{card_id}/moves", + { mediaType: { previews: ["inertia"] } }, + ], + moveColumn: [ + "POST /projects/columns/{column_id}/moves", + { mediaType: { previews: ["inertia"] } }, + ], + removeCollaborator: [ + "DELETE /projects/{project_id}/collaborators/{username}", + { mediaType: { previews: ["inertia"] } }, + ], + update: [ + "PATCH /projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + updateCard: [ + "PATCH /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } }, + ], + updateColumn: [ + "PATCH /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } }, + ], + }, + pulls: { + checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + create: ["POST /repos/{owner}/{repo}/pulls"], + createReplyForReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", + ], + createReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + createReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments", + ], + deletePendingReview: [ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + ], + deleteReviewComment: [ + "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}", + ], + dismissReview: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", + ], + get: ["GET /repos/{owner}/{repo}/pulls/{pull_number}"], + getReview: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + ], + getReviewComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"], + list: ["GET /repos/{owner}/{repo}/pulls"], + listCommentsForReview: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", + ], + listCommits: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"], + listFiles: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"], + listRequestedReviewers: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + ], + listReviewComments: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments", + ], + listReviewCommentsForRepo: ["GET /repos/{owner}/{repo}/pulls/comments"], + listReviews: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + merge: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + removeRequestedReviewers: [ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + ], + requestReviewers: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + ], + submitReview: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", + ], + update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"], + updateBranch: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch", + { mediaType: { previews: ["lydian"] } }, + ], + updateReview: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + ], + updateReviewComment: [ + "PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}", + ], + }, + rateLimit: { get: ["GET /rate_limit"] }, + reactions: { + createForCommitComment: [ + "POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForIssue: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForIssueComment: [ + "POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForPullRequestReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForTeamDiscussionCommentInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForTeamDiscussionInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForCommitComment: [ + "DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForIssue: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForIssueComment: [ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForPullRequestComment: [ + "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForTeamDiscussion: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForTeamDiscussionComment: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteLegacy: [ + "DELETE /reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + { + deprecated: "octokit.reactions.deleteLegacy() is deprecated, see https://docs.github.com/v3/reactions/#delete-a-reaction-legacy", + }, + ], + listForCommitComment: [ + "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForIssueComment: [ + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForPullRequestReviewComment: [ + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForTeamDiscussionCommentInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForTeamDiscussionInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + }, + repos: { + acceptInvitation: ["PATCH /user/repository_invitations/{invitation_id}"], + addAppAccessRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" }, + ], + addCollaborator: ["PUT /repos/{owner}/{repo}/collaborators/{username}"], + addStatusCheckContexts: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" }, + ], + addTeamAccessRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" }, + ], + addUserAccessRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" }, + ], + checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], + checkVulnerabilityAlerts: [ + "GET /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } }, + ], + compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], + createCommitComment: [ + "POST /repos/{owner}/{repo}/commits/{commit_sha}/comments", + ], + createCommitSignatureProtection: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } }, + ], + createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"], + createDeployKey: ["POST /repos/{owner}/{repo}/keys"], + createDeployment: ["POST /repos/{owner}/{repo}/deployments"], + createDeploymentStatus: [ + "POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + ], + createDispatchEvent: ["POST /repos/{owner}/{repo}/dispatches"], + createForAuthenticatedUser: ["POST /user/repos"], + createFork: ["POST /repos/{owner}/{repo}/forks"], + createInOrg: ["POST /orgs/{org}/repos"], + createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], + createPagesSite: [ + "POST /repos/{owner}/{repo}/pages", + { mediaType: { previews: ["switcheroo"] } }, + ], + createRelease: ["POST /repos/{owner}/{repo}/releases"], + createUsingTemplate: [ + "POST /repos/{template_owner}/{template_repo}/generate", + { mediaType: { previews: ["baptiste"] } }, + ], + createWebhook: ["POST /repos/{owner}/{repo}/hooks"], + declineInvitation: ["DELETE /user/repository_invitations/{invitation_id}"], + delete: ["DELETE /repos/{owner}/{repo}"], + deleteAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + ], + deleteAdminBranchProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + ], + deleteBranchProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection", + ], + deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"], + deleteCommitSignatureProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } }, + ], + deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"], + deleteDeployment: [ + "DELETE /repos/{owner}/{repo}/deployments/{deployment_id}", + ], + deleteFile: ["DELETE /repos/{owner}/{repo}/contents/{path}"], + deleteInvitation: [ + "DELETE /repos/{owner}/{repo}/invitations/{invitation_id}", + ], + deletePagesSite: [ + "DELETE /repos/{owner}/{repo}/pages", + { mediaType: { previews: ["switcheroo"] } }, + ], + deletePullRequestReviewProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + ], + deleteRelease: ["DELETE /repos/{owner}/{repo}/releases/{release_id}"], + deleteReleaseAsset: [ + "DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}", + ], + deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], + disableAutomatedSecurityFixes: [ + "DELETE /repos/{owner}/{repo}/automated-security-fixes", + { mediaType: { previews: ["london"] } }, + ], + disableVulnerabilityAlerts: [ + "DELETE /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } }, + ], + downloadArchive: [ + "GET /repos/{owner}/{repo}/zipball/{ref}", + {}, + { renamed: ["repos", "downloadZipballArchive"] }, + ], + downloadTarballArchive: ["GET /repos/{owner}/{repo}/tarball/{ref}"], + downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"], + enableAutomatedSecurityFixes: [ + "PUT /repos/{owner}/{repo}/automated-security-fixes", + { mediaType: { previews: ["london"] } }, + ], + enableVulnerabilityAlerts: [ + "PUT /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } }, + ], + get: ["GET /repos/{owner}/{repo}"], + getAccessRestrictions: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + ], + getAdminBranchProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + ], + getAllStatusCheckContexts: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + ], + getAllTopics: [ + "GET /repos/{owner}/{repo}/topics", + { mediaType: { previews: ["mercy"] } }, + ], + getAppsWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + ], + getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"], + getBranchProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection", + ], + getClones: ["GET /repos/{owner}/{repo}/traffic/clones"], + getCodeFrequencyStats: ["GET /repos/{owner}/{repo}/stats/code_frequency"], + getCollaboratorPermissionLevel: [ + "GET /repos/{owner}/{repo}/collaborators/{username}/permission", + ], + getCombinedStatusForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/status"], + getCommit: ["GET /repos/{owner}/{repo}/commits/{ref}"], + getCommitActivityStats: ["GET /repos/{owner}/{repo}/stats/commit_activity"], + getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"], + getCommitSignatureProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } }, + ], + getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"], + getContent: ["GET /repos/{owner}/{repo}/contents/{path}"], + getContributorsStats: ["GET /repos/{owner}/{repo}/stats/contributors"], + getDeployKey: ["GET /repos/{owner}/{repo}/keys/{key_id}"], + getDeployment: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}"], + getDeploymentStatus: [ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", + ], + getLatestPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/latest"], + getLatestRelease: ["GET /repos/{owner}/{repo}/releases/latest"], + getPages: ["GET /repos/{owner}/{repo}/pages"], + getPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/{build_id}"], + getParticipationStats: ["GET /repos/{owner}/{repo}/stats/participation"], + getPullRequestReviewProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + ], + getPunchCardStats: ["GET /repos/{owner}/{repo}/stats/punch_card"], + getReadme: ["GET /repos/{owner}/{repo}/readme"], + getRelease: ["GET /repos/{owner}/{repo}/releases/{release_id}"], + getReleaseAsset: ["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"], + getReleaseByTag: ["GET /repos/{owner}/{repo}/releases/tags/{tag}"], + getStatusChecksProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + ], + getTeamsWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + ], + getTopPaths: ["GET /repos/{owner}/{repo}/traffic/popular/paths"], + getTopReferrers: ["GET /repos/{owner}/{repo}/traffic/popular/referrers"], + getUsersWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + ], + getViews: ["GET /repos/{owner}/{repo}/traffic/views"], + getWebhook: ["GET /repos/{owner}/{repo}/hooks/{hook_id}"], + getWebhookConfigForRepo: [ + "GET /repos/{owner}/{repo}/hooks/{hook_id}/config", + ], + listBranches: ["GET /repos/{owner}/{repo}/branches"], + listBranchesForHeadCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", + { mediaType: { previews: ["groot"] } }, + ], + listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"], + listCommentsForCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments", + ], + listCommitCommentsForRepo: ["GET /repos/{owner}/{repo}/comments"], + listCommitStatusesForRef: [ + "GET /repos/{owner}/{repo}/commits/{ref}/statuses", + ], + listCommits: ["GET /repos/{owner}/{repo}/commits"], + listContributors: ["GET /repos/{owner}/{repo}/contributors"], + listDeployKeys: ["GET /repos/{owner}/{repo}/keys"], + listDeploymentStatuses: [ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + ], + listDeployments: ["GET /repos/{owner}/{repo}/deployments"], + listForAuthenticatedUser: ["GET /user/repos"], + listForOrg: ["GET /orgs/{org}/repos"], + listForUser: ["GET /users/{username}/repos"], + listForks: ["GET /repos/{owner}/{repo}/forks"], + listInvitations: ["GET /repos/{owner}/{repo}/invitations"], + listInvitationsForAuthenticatedUser: ["GET /user/repository_invitations"], + listLanguages: ["GET /repos/{owner}/{repo}/languages"], + listPagesBuilds: ["GET /repos/{owner}/{repo}/pages/builds"], + listPublic: ["GET /repositories"], + listPullRequestsAssociatedWithCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", + { mediaType: { previews: ["groot"] } }, + ], + listReleaseAssets: [ + "GET /repos/{owner}/{repo}/releases/{release_id}/assets", + ], + listReleases: ["GET /repos/{owner}/{repo}/releases"], + listTags: ["GET /repos/{owner}/{repo}/tags"], + listTeams: ["GET /repos/{owner}/{repo}/teams"], + listWebhooks: ["GET /repos/{owner}/{repo}/hooks"], + merge: ["POST /repos/{owner}/{repo}/merges"], + pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"], + removeAppAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" }, + ], + removeCollaborator: [ + "DELETE /repos/{owner}/{repo}/collaborators/{username}", + ], + removeStatusCheckContexts: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" }, + ], + removeStatusCheckProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + ], + removeTeamAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" }, + ], + removeUserAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" }, + ], + replaceAllTopics: [ + "PUT /repos/{owner}/{repo}/topics", + { mediaType: { previews: ["mercy"] } }, + ], + requestPagesBuild: ["POST /repos/{owner}/{repo}/pages/builds"], + setAdminBranchProtection: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + ], + setAppAccessRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" }, + ], + setStatusCheckContexts: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" }, + ], + setTeamAccessRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" }, + ], + setUserAccessRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" }, + ], + testPushWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"], + transfer: ["POST /repos/{owner}/{repo}/transfer"], + update: ["PATCH /repos/{owner}/{repo}"], + updateBranchProtection: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection", + ], + updateCommitComment: ["PATCH /repos/{owner}/{repo}/comments/{comment_id}"], + updateInformationAboutPagesSite: ["PUT /repos/{owner}/{repo}/pages"], + updateInvitation: [ + "PATCH /repos/{owner}/{repo}/invitations/{invitation_id}", + ], + updatePullRequestReviewProtection: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + ], + updateRelease: ["PATCH /repos/{owner}/{repo}/releases/{release_id}"], + updateReleaseAsset: [ + "PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}", + ], + updateStatusCheckPotection: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + {}, + { renamed: ["repos", "updateStatusCheckProtection"] }, + ], + updateStatusCheckProtection: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + ], + updateWebhook: ["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"], + updateWebhookConfigForRepo: [ + "PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config", + ], + uploadReleaseAsset: [ + "POST /repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", + { baseUrl: "https://uploads.github.com" }, + ], + }, + search: { + code: ["GET /search/code"], + commits: ["GET /search/commits", { mediaType: { previews: ["cloak"] } }], + issuesAndPullRequests: ["GET /search/issues"], + labels: ["GET /search/labels"], + repos: ["GET /search/repositories"], + topics: ["GET /search/topics", { mediaType: { previews: ["mercy"] } }], + users: ["GET /search/users"], + }, + secretScanning: { + getAlert: [ + "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", + ], + listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], + updateAlert: [ + "PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", + ], + }, + teams: { + addOrUpdateMembershipForUserInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/memberships/{username}", + ], + addOrUpdateProjectPermissionsInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + addOrUpdateRepoPermissionsInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + ], + checkPermissionsForProjectInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + checkPermissionsForRepoInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + ], + create: ["POST /orgs/{org}/teams"], + createDiscussionCommentInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + ], + createDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions"], + deleteDiscussionCommentInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + ], + deleteDiscussionInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + ], + deleteInOrg: ["DELETE /orgs/{org}/teams/{team_slug}"], + getByName: ["GET /orgs/{org}/teams/{team_slug}"], + getDiscussionCommentInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + ], + getDiscussionInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + ], + getMembershipForUserInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/memberships/{username}", + ], + list: ["GET /orgs/{org}/teams"], + listChildInOrg: ["GET /orgs/{org}/teams/{team_slug}/teams"], + listDiscussionCommentsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + ], + listDiscussionsInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions"], + listForAuthenticatedUser: ["GET /user/teams"], + listMembersInOrg: ["GET /orgs/{org}/teams/{team_slug}/members"], + listPendingInvitationsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/invitations", + ], + listProjectsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], + removeMembershipForUserInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}", + ], + removeProjectInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}", + ], + removeRepoInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + ], + updateDiscussionCommentInOrg: [ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + ], + updateDiscussionInOrg: [ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + ], + updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"], + }, + users: { + addEmailForAuthenticated: ["POST /user/emails"], + block: ["PUT /user/blocks/{username}"], + checkBlocked: ["GET /user/blocks/{username}"], + checkFollowingForUser: ["GET /users/{username}/following/{target_user}"], + checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"], + createGpgKeyForAuthenticated: ["POST /user/gpg_keys"], + createPublicSshKeyForAuthenticated: ["POST /user/keys"], + deleteEmailForAuthenticated: ["DELETE /user/emails"], + deleteGpgKeyForAuthenticated: ["DELETE /user/gpg_keys/{gpg_key_id}"], + deletePublicSshKeyForAuthenticated: ["DELETE /user/keys/{key_id}"], + follow: ["PUT /user/following/{username}"], + getAuthenticated: ["GET /user"], + getByUsername: ["GET /users/{username}"], + getContextForUser: ["GET /users/{username}/hovercard"], + getGpgKeyForAuthenticated: ["GET /user/gpg_keys/{gpg_key_id}"], + getPublicSshKeyForAuthenticated: ["GET /user/keys/{key_id}"], + list: ["GET /users"], + listBlockedByAuthenticated: ["GET /user/blocks"], + listEmailsForAuthenticated: ["GET /user/emails"], + listFollowedByAuthenticated: ["GET /user/following"], + listFollowersForAuthenticatedUser: ["GET /user/followers"], + listFollowersForUser: ["GET /users/{username}/followers"], + listFollowingForUser: ["GET /users/{username}/following"], + listGpgKeysForAuthenticated: ["GET /user/gpg_keys"], + listGpgKeysForUser: ["GET /users/{username}/gpg_keys"], + listPublicEmailsForAuthenticated: ["GET /user/public_emails"], + listPublicKeysForUser: ["GET /users/{username}/keys"], + listPublicSshKeysForAuthenticated: ["GET /user/keys"], + setPrimaryEmailVisibilityForAuthenticated: ["PATCH /user/email/visibility"], + unblock: ["DELETE /user/blocks/{username}"], + unfollow: ["DELETE /user/following/{username}"], + updateAuthenticated: ["PATCH /user"], + }, +}; + +const VERSION = "4.5.2"; + +function endpointsToMethods(octokit, endpointsMap) { + const newMethods = {}; + for (const [scope, endpoints] of Object.entries(endpointsMap)) { + for (const [methodName, endpoint] of Object.entries(endpoints)) { + const [route, defaults, decorations] = endpoint; + const [method, url] = route.split(/ /); + const endpointDefaults = Object.assign({ method, url }, defaults); + if (!newMethods[scope]) { + newMethods[scope] = {}; + } + const scopeMethods = newMethods[scope]; + if (decorations) { + scopeMethods[methodName] = decorate(octokit, scope, methodName, endpointDefaults, decorations); + continue; + } + scopeMethods[methodName] = octokit.request.defaults(endpointDefaults); + } + } + return newMethods; +} +function decorate(octokit, scope, methodName, defaults, decorations) { + const requestWithDefaults = octokit.request.defaults(defaults); + /* istanbul ignore next */ + function withDecorations(...args) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + let options = requestWithDefaults.endpoint.merge(...args); + // There are currently no other decorations than `.mapToData` + if (decorations.mapToData) { + options = Object.assign({}, options, { + data: options[decorations.mapToData], + [decorations.mapToData]: undefined, + }); + return requestWithDefaults(options); + } + if (decorations.renamed) { + const [newScope, newMethodName] = decorations.renamed; + octokit.log.warn(`octokit.${scope}.${methodName}() has been renamed to octokit.${newScope}.${newMethodName}()`); + } + if (decorations.deprecated) { + octokit.log.warn(decorations.deprecated); + } + if (decorations.renamedParameters) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + const options = requestWithDefaults.endpoint.merge(...args); + for (const [name, alias] of Object.entries(decorations.renamedParameters)) { + if (name in options) { + octokit.log.warn(`"${name}" parameter is deprecated for "octokit.${scope}.${methodName}()". Use "${alias}" instead`); + if (!(alias in options)) { + options[alias] = options[name]; + } + delete options[name]; + } + } + return requestWithDefaults(options); + } + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + return requestWithDefaults(...args); + } + return Object.assign(withDecorations, requestWithDefaults); +} + +/** + * This plugin is a 1:1 copy of internal @octokit/rest plugins. The primary + * goal is to rebuild @octokit/rest on top of @octokit/core. Once that is + * done, we will remove the registerEndpoints methods and return the methods + * directly as with the other plugins. At that point we will also remove the + * legacy workarounds and deprecations. + * + * See the plan at + * https://github.com/octokit/plugin-rest-endpoint-methods.js/pull/1 + */ +function restEndpointMethods(octokit) { + return endpointsToMethods(octokit, Endpoints); +} +restEndpointMethods.VERSION = VERSION; + +export { restEndpointMethods }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js.map b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js.map new file mode 100644 index 0000000..7053f10 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/generated/endpoints.js","../dist-src/version.js","../dist-src/endpoints-to-methods.js","../dist-src/index.js"],"sourcesContent":["const Endpoints = {\n actions: {\n addSelectedRepoToOrgSecret: [\n \"PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}\",\n ],\n cancelWorkflowRun: [\n \"POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel\",\n ],\n createOrUpdateOrgSecret: [\"PUT /orgs/{org}/actions/secrets/{secret_name}\"],\n createOrUpdateRepoSecret: [\n \"PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}\",\n ],\n createRegistrationTokenForOrg: [\n \"POST /orgs/{org}/actions/runners/registration-token\",\n ],\n createRegistrationTokenForRepo: [\n \"POST /repos/{owner}/{repo}/actions/runners/registration-token\",\n ],\n createRemoveTokenForOrg: [\"POST /orgs/{org}/actions/runners/remove-token\"],\n createRemoveTokenForRepo: [\n \"POST /repos/{owner}/{repo}/actions/runners/remove-token\",\n ],\n createWorkflowDispatch: [\n \"POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches\",\n ],\n deleteArtifact: [\n \"DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}\",\n ],\n deleteOrgSecret: [\"DELETE /orgs/{org}/actions/secrets/{secret_name}\"],\n deleteRepoSecret: [\n \"DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}\",\n ],\n deleteSelfHostedRunnerFromOrg: [\n \"DELETE /orgs/{org}/actions/runners/{runner_id}\",\n ],\n deleteSelfHostedRunnerFromRepo: [\n \"DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}\",\n ],\n deleteWorkflowRun: [\"DELETE /repos/{owner}/{repo}/actions/runs/{run_id}\"],\n deleteWorkflowRunLogs: [\n \"DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs\",\n ],\n disableSelectedRepositoryGithubActionsOrganization: [\n \"DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}\",\n ],\n disableWorkflow: [\n \"PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable\",\n ],\n downloadArtifact: [\n \"GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}\",\n ],\n downloadJobLogsForWorkflowRun: [\n \"GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs\",\n ],\n downloadWorkflowRunLogs: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs\",\n ],\n enableSelectedRepositoryGithubActionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions/repositories/{repository_id}\",\n ],\n enableWorkflow: [\n \"PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable\",\n ],\n getAllowedActionsOrganization: [\n \"GET /orgs/{org}/actions/permissions/selected-actions\",\n ],\n getAllowedActionsRepository: [\n \"GET /repos/{owner}/{repo}/actions/permissions/selected-actions\",\n ],\n getArtifact: [\"GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}\"],\n getGithubActionsPermissionsOrganization: [\n \"GET /orgs/{org}/actions/permissions\",\n ],\n getGithubActionsPermissionsRepository: [\n \"GET /repos/{owner}/{repo}/actions/permissions\",\n ],\n getJobForWorkflowRun: [\"GET /repos/{owner}/{repo}/actions/jobs/{job_id}\"],\n getOrgPublicKey: [\"GET /orgs/{org}/actions/secrets/public-key\"],\n getOrgSecret: [\"GET /orgs/{org}/actions/secrets/{secret_name}\"],\n getRepoPermissions: [\n \"GET /repos/{owner}/{repo}/actions/permissions\",\n {},\n { renamed: [\"actions\", \"getGithubActionsPermissionsRepository\"] },\n ],\n getRepoPublicKey: [\"GET /repos/{owner}/{repo}/actions/secrets/public-key\"],\n getRepoSecret: [\"GET /repos/{owner}/{repo}/actions/secrets/{secret_name}\"],\n getSelfHostedRunnerForOrg: [\"GET /orgs/{org}/actions/runners/{runner_id}\"],\n getSelfHostedRunnerForRepo: [\n \"GET /repos/{owner}/{repo}/actions/runners/{runner_id}\",\n ],\n getWorkflow: [\"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}\"],\n getWorkflowRun: [\"GET /repos/{owner}/{repo}/actions/runs/{run_id}\"],\n getWorkflowRunUsage: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing\",\n ],\n getWorkflowUsage: [\n \"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing\",\n ],\n listArtifactsForRepo: [\"GET /repos/{owner}/{repo}/actions/artifacts\"],\n listJobsForWorkflowRun: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs\",\n ],\n listOrgSecrets: [\"GET /orgs/{org}/actions/secrets\"],\n listRepoSecrets: [\"GET /repos/{owner}/{repo}/actions/secrets\"],\n listRepoWorkflows: [\"GET /repos/{owner}/{repo}/actions/workflows\"],\n listRunnerApplicationsForOrg: [\"GET /orgs/{org}/actions/runners/downloads\"],\n listRunnerApplicationsForRepo: [\n \"GET /repos/{owner}/{repo}/actions/runners/downloads\",\n ],\n listSelectedReposForOrgSecret: [\n \"GET /orgs/{org}/actions/secrets/{secret_name}/repositories\",\n ],\n listSelectedRepositoriesEnabledGithubActionsOrganization: [\n \"GET /orgs/{org}/actions/permissions/repositories\",\n ],\n listSelfHostedRunnersForOrg: [\"GET /orgs/{org}/actions/runners\"],\n listSelfHostedRunnersForRepo: [\"GET /repos/{owner}/{repo}/actions/runners\"],\n listWorkflowRunArtifacts: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts\",\n ],\n listWorkflowRuns: [\n \"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs\",\n ],\n listWorkflowRunsForRepo: [\"GET /repos/{owner}/{repo}/actions/runs\"],\n reRunWorkflow: [\"POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun\"],\n removeSelectedRepoFromOrgSecret: [\n \"DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}\",\n ],\n setAllowedActionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions/selected-actions\",\n ],\n setAllowedActionsRepository: [\n \"PUT /repos/{owner}/{repo}/actions/permissions/selected-actions\",\n ],\n setGithubActionsPermissionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions\",\n ],\n setGithubActionsPermissionsRepository: [\n \"PUT /repos/{owner}/{repo}/actions/permissions\",\n ],\n setSelectedReposForOrgSecret: [\n \"PUT /orgs/{org}/actions/secrets/{secret_name}/repositories\",\n ],\n setSelectedRepositoriesEnabledGithubActionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions/repositories\",\n ],\n },\n activity: {\n checkRepoIsStarredByAuthenticatedUser: [\"GET /user/starred/{owner}/{repo}\"],\n deleteRepoSubscription: [\"DELETE /repos/{owner}/{repo}/subscription\"],\n deleteThreadSubscription: [\n \"DELETE /notifications/threads/{thread_id}/subscription\",\n ],\n getFeeds: [\"GET /feeds\"],\n getRepoSubscription: [\"GET /repos/{owner}/{repo}/subscription\"],\n getThread: [\"GET /notifications/threads/{thread_id}\"],\n getThreadSubscriptionForAuthenticatedUser: [\n \"GET /notifications/threads/{thread_id}/subscription\",\n ],\n listEventsForAuthenticatedUser: [\"GET /users/{username}/events\"],\n listNotificationsForAuthenticatedUser: [\"GET /notifications\"],\n listOrgEventsForAuthenticatedUser: [\n \"GET /users/{username}/events/orgs/{org}\",\n ],\n listPublicEvents: [\"GET /events\"],\n listPublicEventsForRepoNetwork: [\"GET /networks/{owner}/{repo}/events\"],\n listPublicEventsForUser: [\"GET /users/{username}/events/public\"],\n listPublicOrgEvents: [\"GET /orgs/{org}/events\"],\n listReceivedEventsForUser: [\"GET /users/{username}/received_events\"],\n listReceivedPublicEventsForUser: [\n \"GET /users/{username}/received_events/public\",\n ],\n listRepoEvents: [\"GET /repos/{owner}/{repo}/events\"],\n listRepoNotificationsForAuthenticatedUser: [\n \"GET /repos/{owner}/{repo}/notifications\",\n ],\n listReposStarredByAuthenticatedUser: [\"GET /user/starred\"],\n listReposStarredByUser: [\"GET /users/{username}/starred\"],\n listReposWatchedByUser: [\"GET /users/{username}/subscriptions\"],\n listStargazersForRepo: [\"GET /repos/{owner}/{repo}/stargazers\"],\n listWatchedReposForAuthenticatedUser: [\"GET /user/subscriptions\"],\n listWatchersForRepo: [\"GET /repos/{owner}/{repo}/subscribers\"],\n markNotificationsAsRead: [\"PUT /notifications\"],\n markRepoNotificationsAsRead: [\"PUT /repos/{owner}/{repo}/notifications\"],\n markThreadAsRead: [\"PATCH /notifications/threads/{thread_id}\"],\n setRepoSubscription: [\"PUT /repos/{owner}/{repo}/subscription\"],\n setThreadSubscription: [\n \"PUT /notifications/threads/{thread_id}/subscription\",\n ],\n starRepoForAuthenticatedUser: [\"PUT /user/starred/{owner}/{repo}\"],\n unstarRepoForAuthenticatedUser: [\"DELETE /user/starred/{owner}/{repo}\"],\n },\n apps: {\n addRepoToInstallation: [\n \"PUT /user/installations/{installation_id}/repositories/{repository_id}\",\n ],\n checkToken: [\"POST /applications/{client_id}/token\"],\n createContentAttachment: [\n \"POST /content_references/{content_reference_id}/attachments\",\n { mediaType: { previews: [\"corsair\"] } },\n ],\n createFromManifest: [\"POST /app-manifests/{code}/conversions\"],\n createInstallationAccessToken: [\n \"POST /app/installations/{installation_id}/access_tokens\",\n ],\n deleteAuthorization: [\"DELETE /applications/{client_id}/grant\"],\n deleteInstallation: [\"DELETE /app/installations/{installation_id}\"],\n deleteToken: [\"DELETE /applications/{client_id}/token\"],\n getAuthenticated: [\"GET /app\"],\n getBySlug: [\"GET /apps/{app_slug}\"],\n getInstallation: [\"GET /app/installations/{installation_id}\"],\n getOrgInstallation: [\"GET /orgs/{org}/installation\"],\n getRepoInstallation: [\"GET /repos/{owner}/{repo}/installation\"],\n getSubscriptionPlanForAccount: [\n \"GET /marketplace_listing/accounts/{account_id}\",\n ],\n getSubscriptionPlanForAccountStubbed: [\n \"GET /marketplace_listing/stubbed/accounts/{account_id}\",\n ],\n getUserInstallation: [\"GET /users/{username}/installation\"],\n getWebhookConfigForApp: [\"GET /app/hook/config\"],\n listAccountsForPlan: [\"GET /marketplace_listing/plans/{plan_id}/accounts\"],\n listAccountsForPlanStubbed: [\n \"GET /marketplace_listing/stubbed/plans/{plan_id}/accounts\",\n ],\n listInstallationReposForAuthenticatedUser: [\n \"GET /user/installations/{installation_id}/repositories\",\n ],\n listInstallations: [\"GET /app/installations\"],\n listInstallationsForAuthenticatedUser: [\"GET /user/installations\"],\n listPlans: [\"GET /marketplace_listing/plans\"],\n listPlansStubbed: [\"GET /marketplace_listing/stubbed/plans\"],\n listReposAccessibleToInstallation: [\"GET /installation/repositories\"],\n listSubscriptionsForAuthenticatedUser: [\"GET /user/marketplace_purchases\"],\n listSubscriptionsForAuthenticatedUserStubbed: [\n \"GET /user/marketplace_purchases/stubbed\",\n ],\n removeRepoFromInstallation: [\n \"DELETE /user/installations/{installation_id}/repositories/{repository_id}\",\n ],\n resetToken: [\"PATCH /applications/{client_id}/token\"],\n revokeInstallationAccessToken: [\"DELETE /installation/token\"],\n scopeToken: [\"POST /applications/{client_id}/token/scoped\"],\n suspendInstallation: [\"PUT /app/installations/{installation_id}/suspended\"],\n unsuspendInstallation: [\n \"DELETE /app/installations/{installation_id}/suspended\",\n ],\n updateWebhookConfigForApp: [\"PATCH /app/hook/config\"],\n },\n billing: {\n getGithubActionsBillingOrg: [\"GET /orgs/{org}/settings/billing/actions\"],\n getGithubActionsBillingUser: [\n \"GET /users/{username}/settings/billing/actions\",\n ],\n getGithubPackagesBillingOrg: [\"GET /orgs/{org}/settings/billing/packages\"],\n getGithubPackagesBillingUser: [\n \"GET /users/{username}/settings/billing/packages\",\n ],\n getSharedStorageBillingOrg: [\n \"GET /orgs/{org}/settings/billing/shared-storage\",\n ],\n getSharedStorageBillingUser: [\n \"GET /users/{username}/settings/billing/shared-storage\",\n ],\n },\n checks: {\n create: [\"POST /repos/{owner}/{repo}/check-runs\"],\n createSuite: [\"POST /repos/{owner}/{repo}/check-suites\"],\n get: [\"GET /repos/{owner}/{repo}/check-runs/{check_run_id}\"],\n getSuite: [\"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}\"],\n listAnnotations: [\n \"GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations\",\n ],\n listForRef: [\"GET /repos/{owner}/{repo}/commits/{ref}/check-runs\"],\n listForSuite: [\n \"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs\",\n ],\n listSuitesForRef: [\"GET /repos/{owner}/{repo}/commits/{ref}/check-suites\"],\n rerequestSuite: [\n \"POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest\",\n ],\n setSuitesPreferences: [\n \"PATCH /repos/{owner}/{repo}/check-suites/preferences\",\n ],\n update: [\"PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}\"],\n },\n codeScanning: {\n getAlert: [\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}\",\n {},\n { renamedParameters: { alert_id: \"alert_number\" } },\n ],\n listAlertsForRepo: [\"GET /repos/{owner}/{repo}/code-scanning/alerts\"],\n listRecentAnalyses: [\"GET /repos/{owner}/{repo}/code-scanning/analyses\"],\n updateAlert: [\n \"PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}\",\n ],\n uploadSarif: [\"POST /repos/{owner}/{repo}/code-scanning/sarifs\"],\n },\n codesOfConduct: {\n getAllCodesOfConduct: [\n \"GET /codes_of_conduct\",\n { mediaType: { previews: [\"scarlet-witch\"] } },\n ],\n getConductCode: [\n \"GET /codes_of_conduct/{key}\",\n { mediaType: { previews: [\"scarlet-witch\"] } },\n ],\n getForRepo: [\n \"GET /repos/{owner}/{repo}/community/code_of_conduct\",\n { mediaType: { previews: [\"scarlet-witch\"] } },\n ],\n },\n emojis: { get: [\"GET /emojis\"] },\n enterpriseAdmin: {\n disableSelectedOrganizationGithubActionsEnterprise: [\n \"DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}\",\n ],\n enableSelectedOrganizationGithubActionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}\",\n ],\n getAllowedActionsEnterprise: [\n \"GET /enterprises/{enterprise}/actions/permissions/selected-actions\",\n ],\n getGithubActionsPermissionsEnterprise: [\n \"GET /enterprises/{enterprise}/actions/permissions\",\n ],\n listSelectedOrganizationsEnabledGithubActionsEnterprise: [\n \"GET /enterprises/{enterprise}/actions/permissions/organizations\",\n ],\n setAllowedActionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions/selected-actions\",\n ],\n setGithubActionsPermissionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions\",\n ],\n setSelectedOrganizationsEnabledGithubActionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions/organizations\",\n ],\n },\n gists: {\n checkIsStarred: [\"GET /gists/{gist_id}/star\"],\n create: [\"POST /gists\"],\n createComment: [\"POST /gists/{gist_id}/comments\"],\n delete: [\"DELETE /gists/{gist_id}\"],\n deleteComment: [\"DELETE /gists/{gist_id}/comments/{comment_id}\"],\n fork: [\"POST /gists/{gist_id}/forks\"],\n get: [\"GET /gists/{gist_id}\"],\n getComment: [\"GET /gists/{gist_id}/comments/{comment_id}\"],\n getRevision: [\"GET /gists/{gist_id}/{sha}\"],\n list: [\"GET /gists\"],\n listComments: [\"GET /gists/{gist_id}/comments\"],\n listCommits: [\"GET /gists/{gist_id}/commits\"],\n listForUser: [\"GET /users/{username}/gists\"],\n listForks: [\"GET /gists/{gist_id}/forks\"],\n listPublic: [\"GET /gists/public\"],\n listStarred: [\"GET /gists/starred\"],\n star: [\"PUT /gists/{gist_id}/star\"],\n unstar: [\"DELETE /gists/{gist_id}/star\"],\n update: [\"PATCH /gists/{gist_id}\"],\n updateComment: [\"PATCH /gists/{gist_id}/comments/{comment_id}\"],\n },\n git: {\n createBlob: [\"POST /repos/{owner}/{repo}/git/blobs\"],\n createCommit: [\"POST /repos/{owner}/{repo}/git/commits\"],\n createRef: [\"POST /repos/{owner}/{repo}/git/refs\"],\n createTag: [\"POST /repos/{owner}/{repo}/git/tags\"],\n createTree: [\"POST /repos/{owner}/{repo}/git/trees\"],\n deleteRef: [\"DELETE /repos/{owner}/{repo}/git/refs/{ref}\"],\n getBlob: [\"GET /repos/{owner}/{repo}/git/blobs/{file_sha}\"],\n getCommit: [\"GET /repos/{owner}/{repo}/git/commits/{commit_sha}\"],\n getRef: [\"GET /repos/{owner}/{repo}/git/ref/{ref}\"],\n getTag: [\"GET /repos/{owner}/{repo}/git/tags/{tag_sha}\"],\n getTree: [\"GET /repos/{owner}/{repo}/git/trees/{tree_sha}\"],\n listMatchingRefs: [\"GET /repos/{owner}/{repo}/git/matching-refs/{ref}\"],\n updateRef: [\"PATCH /repos/{owner}/{repo}/git/refs/{ref}\"],\n },\n gitignore: {\n getAllTemplates: [\"GET /gitignore/templates\"],\n getTemplate: [\"GET /gitignore/templates/{name}\"],\n },\n interactions: {\n getRestrictionsForOrg: [\"GET /orgs/{org}/interaction-limits\"],\n getRestrictionsForRepo: [\"GET /repos/{owner}/{repo}/interaction-limits\"],\n getRestrictionsForYourPublicRepos: [\"GET /user/interaction-limits\"],\n removeRestrictionsForOrg: [\"DELETE /orgs/{org}/interaction-limits\"],\n removeRestrictionsForRepo: [\n \"DELETE /repos/{owner}/{repo}/interaction-limits\",\n ],\n removeRestrictionsForYourPublicRepos: [\"DELETE /user/interaction-limits\"],\n setRestrictionsForOrg: [\"PUT /orgs/{org}/interaction-limits\"],\n setRestrictionsForRepo: [\"PUT /repos/{owner}/{repo}/interaction-limits\"],\n setRestrictionsForYourPublicRepos: [\"PUT /user/interaction-limits\"],\n },\n issues: {\n addAssignees: [\n \"POST /repos/{owner}/{repo}/issues/{issue_number}/assignees\",\n ],\n addLabels: [\"POST /repos/{owner}/{repo}/issues/{issue_number}/labels\"],\n checkUserCanBeAssigned: [\"GET /repos/{owner}/{repo}/assignees/{assignee}\"],\n create: [\"POST /repos/{owner}/{repo}/issues\"],\n createComment: [\n \"POST /repos/{owner}/{repo}/issues/{issue_number}/comments\",\n ],\n createLabel: [\"POST /repos/{owner}/{repo}/labels\"],\n createMilestone: [\"POST /repos/{owner}/{repo}/milestones\"],\n deleteComment: [\n \"DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}\",\n ],\n deleteLabel: [\"DELETE /repos/{owner}/{repo}/labels/{name}\"],\n deleteMilestone: [\n \"DELETE /repos/{owner}/{repo}/milestones/{milestone_number}\",\n ],\n get: [\"GET /repos/{owner}/{repo}/issues/{issue_number}\"],\n getComment: [\"GET /repos/{owner}/{repo}/issues/comments/{comment_id}\"],\n getEvent: [\"GET /repos/{owner}/{repo}/issues/events/{event_id}\"],\n getLabel: [\"GET /repos/{owner}/{repo}/labels/{name}\"],\n getMilestone: [\"GET /repos/{owner}/{repo}/milestones/{milestone_number}\"],\n list: [\"GET /issues\"],\n listAssignees: [\"GET /repos/{owner}/{repo}/assignees\"],\n listComments: [\"GET /repos/{owner}/{repo}/issues/{issue_number}/comments\"],\n listCommentsForRepo: [\"GET /repos/{owner}/{repo}/issues/comments\"],\n listEvents: [\"GET /repos/{owner}/{repo}/issues/{issue_number}/events\"],\n listEventsForRepo: [\"GET /repos/{owner}/{repo}/issues/events\"],\n listEventsForTimeline: [\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/timeline\",\n { mediaType: { previews: [\"mockingbird\"] } },\n ],\n listForAuthenticatedUser: [\"GET /user/issues\"],\n listForOrg: [\"GET /orgs/{org}/issues\"],\n listForRepo: [\"GET /repos/{owner}/{repo}/issues\"],\n listLabelsForMilestone: [\n \"GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels\",\n ],\n listLabelsForRepo: [\"GET /repos/{owner}/{repo}/labels\"],\n listLabelsOnIssue: [\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/labels\",\n ],\n listMilestones: [\"GET /repos/{owner}/{repo}/milestones\"],\n lock: [\"PUT /repos/{owner}/{repo}/issues/{issue_number}/lock\"],\n removeAllLabels: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels\",\n ],\n removeAssignees: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees\",\n ],\n removeLabel: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}\",\n ],\n setLabels: [\"PUT /repos/{owner}/{repo}/issues/{issue_number}/labels\"],\n unlock: [\"DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock\"],\n update: [\"PATCH /repos/{owner}/{repo}/issues/{issue_number}\"],\n updateComment: [\"PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}\"],\n updateLabel: [\"PATCH /repos/{owner}/{repo}/labels/{name}\"],\n updateMilestone: [\n \"PATCH /repos/{owner}/{repo}/milestones/{milestone_number}\",\n ],\n },\n licenses: {\n get: [\"GET /licenses/{license}\"],\n getAllCommonlyUsed: [\"GET /licenses\"],\n getForRepo: [\"GET /repos/{owner}/{repo}/license\"],\n },\n markdown: {\n render: [\"POST /markdown\"],\n renderRaw: [\n \"POST /markdown/raw\",\n { headers: { \"content-type\": \"text/plain; charset=utf-8\" } },\n ],\n },\n meta: {\n get: [\"GET /meta\"],\n getOctocat: [\"GET /octocat\"],\n getZen: [\"GET /zen\"],\n root: [\"GET /\"],\n },\n migrations: {\n cancelImport: [\"DELETE /repos/{owner}/{repo}/import\"],\n deleteArchiveForAuthenticatedUser: [\n \"DELETE /user/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n deleteArchiveForOrg: [\n \"DELETE /orgs/{org}/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n downloadArchiveForOrg: [\n \"GET /orgs/{org}/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n getArchiveForAuthenticatedUser: [\n \"GET /user/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n getCommitAuthors: [\"GET /repos/{owner}/{repo}/import/authors\"],\n getImportStatus: [\"GET /repos/{owner}/{repo}/import\"],\n getLargeFiles: [\"GET /repos/{owner}/{repo}/import/large_files\"],\n getStatusForAuthenticatedUser: [\n \"GET /user/migrations/{migration_id}\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n getStatusForOrg: [\n \"GET /orgs/{org}/migrations/{migration_id}\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listForAuthenticatedUser: [\n \"GET /user/migrations\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listForOrg: [\n \"GET /orgs/{org}/migrations\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listReposForOrg: [\n \"GET /orgs/{org}/migrations/{migration_id}/repositories\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listReposForUser: [\n \"GET /user/migrations/{migration_id}/repositories\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n mapCommitAuthor: [\"PATCH /repos/{owner}/{repo}/import/authors/{author_id}\"],\n setLfsPreference: [\"PATCH /repos/{owner}/{repo}/import/lfs\"],\n startForAuthenticatedUser: [\"POST /user/migrations\"],\n startForOrg: [\"POST /orgs/{org}/migrations\"],\n startImport: [\"PUT /repos/{owner}/{repo}/import\"],\n unlockRepoForAuthenticatedUser: [\n \"DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n unlockRepoForOrg: [\n \"DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n updateImport: [\"PATCH /repos/{owner}/{repo}/import\"],\n },\n orgs: {\n blockUser: [\"PUT /orgs/{org}/blocks/{username}\"],\n checkBlockedUser: [\"GET /orgs/{org}/blocks/{username}\"],\n checkMembershipForUser: [\"GET /orgs/{org}/members/{username}\"],\n checkPublicMembershipForUser: [\"GET /orgs/{org}/public_members/{username}\"],\n convertMemberToOutsideCollaborator: [\n \"PUT /orgs/{org}/outside_collaborators/{username}\",\n ],\n createInvitation: [\"POST /orgs/{org}/invitations\"],\n createWebhook: [\"POST /orgs/{org}/hooks\"],\n deleteWebhook: [\"DELETE /orgs/{org}/hooks/{hook_id}\"],\n get: [\"GET /orgs/{org}\"],\n getMembershipForAuthenticatedUser: [\"GET /user/memberships/orgs/{org}\"],\n getMembershipForUser: [\"GET /orgs/{org}/memberships/{username}\"],\n getWebhook: [\"GET /orgs/{org}/hooks/{hook_id}\"],\n getWebhookConfigForOrg: [\"GET /orgs/{org}/hooks/{hook_id}/config\"],\n list: [\"GET /organizations\"],\n listAppInstallations: [\"GET /orgs/{org}/installations\"],\n listBlockedUsers: [\"GET /orgs/{org}/blocks\"],\n listForAuthenticatedUser: [\"GET /user/orgs\"],\n listForUser: [\"GET /users/{username}/orgs\"],\n listInvitationTeams: [\"GET /orgs/{org}/invitations/{invitation_id}/teams\"],\n listMembers: [\"GET /orgs/{org}/members\"],\n listMembershipsForAuthenticatedUser: [\"GET /user/memberships/orgs\"],\n listOutsideCollaborators: [\"GET /orgs/{org}/outside_collaborators\"],\n listPendingInvitations: [\"GET /orgs/{org}/invitations\"],\n listPublicMembers: [\"GET /orgs/{org}/public_members\"],\n listWebhooks: [\"GET /orgs/{org}/hooks\"],\n pingWebhook: [\"POST /orgs/{org}/hooks/{hook_id}/pings\"],\n removeMember: [\"DELETE /orgs/{org}/members/{username}\"],\n removeMembershipForUser: [\"DELETE /orgs/{org}/memberships/{username}\"],\n removeOutsideCollaborator: [\n \"DELETE /orgs/{org}/outside_collaborators/{username}\",\n ],\n removePublicMembershipForAuthenticatedUser: [\n \"DELETE /orgs/{org}/public_members/{username}\",\n ],\n setMembershipForUser: [\"PUT /orgs/{org}/memberships/{username}\"],\n setPublicMembershipForAuthenticatedUser: [\n \"PUT /orgs/{org}/public_members/{username}\",\n ],\n unblockUser: [\"DELETE /orgs/{org}/blocks/{username}\"],\n update: [\"PATCH /orgs/{org}\"],\n updateMembershipForAuthenticatedUser: [\n \"PATCH /user/memberships/orgs/{org}\",\n ],\n updateWebhook: [\"PATCH /orgs/{org}/hooks/{hook_id}\"],\n updateWebhookConfigForOrg: [\"PATCH /orgs/{org}/hooks/{hook_id}/config\"],\n },\n projects: {\n addCollaborator: [\n \"PUT /projects/{project_id}/collaborators/{username}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createCard: [\n \"POST /projects/columns/{column_id}/cards\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createColumn: [\n \"POST /projects/{project_id}/columns\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createForAuthenticatedUser: [\n \"POST /user/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createForOrg: [\n \"POST /orgs/{org}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createForRepo: [\n \"POST /repos/{owner}/{repo}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n delete: [\n \"DELETE /projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n deleteCard: [\n \"DELETE /projects/columns/cards/{card_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n deleteColumn: [\n \"DELETE /projects/columns/{column_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n get: [\n \"GET /projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n getCard: [\n \"GET /projects/columns/cards/{card_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n getColumn: [\n \"GET /projects/columns/{column_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n getPermissionForUser: [\n \"GET /projects/{project_id}/collaborators/{username}/permission\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listCards: [\n \"GET /projects/columns/{column_id}/cards\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listCollaborators: [\n \"GET /projects/{project_id}/collaborators\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listColumns: [\n \"GET /projects/{project_id}/columns\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listForOrg: [\n \"GET /orgs/{org}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listForRepo: [\n \"GET /repos/{owner}/{repo}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listForUser: [\n \"GET /users/{username}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n moveCard: [\n \"POST /projects/columns/cards/{card_id}/moves\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n moveColumn: [\n \"POST /projects/columns/{column_id}/moves\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n removeCollaborator: [\n \"DELETE /projects/{project_id}/collaborators/{username}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n update: [\n \"PATCH /projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n updateCard: [\n \"PATCH /projects/columns/cards/{card_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n updateColumn: [\n \"PATCH /projects/columns/{column_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n },\n pulls: {\n checkIfMerged: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/merge\"],\n create: [\"POST /repos/{owner}/{repo}/pulls\"],\n createReplyForReviewComment: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies\",\n ],\n createReview: [\"POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews\"],\n createReviewComment: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/comments\",\n ],\n deletePendingReview: [\n \"DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}\",\n ],\n deleteReviewComment: [\n \"DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}\",\n ],\n dismissReview: [\n \"PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals\",\n ],\n get: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}\"],\n getReview: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}\",\n ],\n getReviewComment: [\"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}\"],\n list: [\"GET /repos/{owner}/{repo}/pulls\"],\n listCommentsForReview: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments\",\n ],\n listCommits: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/commits\"],\n listFiles: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/files\"],\n listRequestedReviewers: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n ],\n listReviewComments: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/comments\",\n ],\n listReviewCommentsForRepo: [\"GET /repos/{owner}/{repo}/pulls/comments\"],\n listReviews: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews\"],\n merge: [\"PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge\"],\n removeRequestedReviewers: [\n \"DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n ],\n requestReviewers: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n ],\n submitReview: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events\",\n ],\n update: [\"PATCH /repos/{owner}/{repo}/pulls/{pull_number}\"],\n updateBranch: [\n \"PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch\",\n { mediaType: { previews: [\"lydian\"] } },\n ],\n updateReview: [\n \"PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}\",\n ],\n updateReviewComment: [\n \"PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}\",\n ],\n },\n rateLimit: { get: [\"GET /rate_limit\"] },\n reactions: {\n createForCommitComment: [\n \"POST /repos/{owner}/{repo}/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForIssue: [\n \"POST /repos/{owner}/{repo}/issues/{issue_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForIssueComment: [\n \"POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForPullRequestReviewComment: [\n \"POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForTeamDiscussionCommentInOrg: [\n \"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForTeamDiscussionInOrg: [\n \"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForCommitComment: [\n \"DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForIssue: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForIssueComment: [\n \"DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForPullRequestComment: [\n \"DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForTeamDiscussion: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForTeamDiscussionComment: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteLegacy: [\n \"DELETE /reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n {\n deprecated: \"octokit.reactions.deleteLegacy() is deprecated, see https://docs.github.com/v3/reactions/#delete-a-reaction-legacy\",\n },\n ],\n listForCommitComment: [\n \"GET /repos/{owner}/{repo}/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForIssue: [\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForIssueComment: [\n \"GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForPullRequestReviewComment: [\n \"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForTeamDiscussionCommentInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForTeamDiscussionInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n },\n repos: {\n acceptInvitation: [\"PATCH /user/repository_invitations/{invitation_id}\"],\n addAppAccessRestrictions: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n {},\n { mapToData: \"apps\" },\n ],\n addCollaborator: [\"PUT /repos/{owner}/{repo}/collaborators/{username}\"],\n addStatusCheckContexts: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n {},\n { mapToData: \"contexts\" },\n ],\n addTeamAccessRestrictions: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n {},\n { mapToData: \"teams\" },\n ],\n addUserAccessRestrictions: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n {},\n { mapToData: \"users\" },\n ],\n checkCollaborator: [\"GET /repos/{owner}/{repo}/collaborators/{username}\"],\n checkVulnerabilityAlerts: [\n \"GET /repos/{owner}/{repo}/vulnerability-alerts\",\n { mediaType: { previews: [\"dorian\"] } },\n ],\n compareCommits: [\"GET /repos/{owner}/{repo}/compare/{base}...{head}\"],\n createCommitComment: [\n \"POST /repos/{owner}/{repo}/commits/{commit_sha}/comments\",\n ],\n createCommitSignatureProtection: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures\",\n { mediaType: { previews: [\"zzzax\"] } },\n ],\n createCommitStatus: [\"POST /repos/{owner}/{repo}/statuses/{sha}\"],\n createDeployKey: [\"POST /repos/{owner}/{repo}/keys\"],\n createDeployment: [\"POST /repos/{owner}/{repo}/deployments\"],\n createDeploymentStatus: [\n \"POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses\",\n ],\n createDispatchEvent: [\"POST /repos/{owner}/{repo}/dispatches\"],\n createForAuthenticatedUser: [\"POST /user/repos\"],\n createFork: [\"POST /repos/{owner}/{repo}/forks\"],\n createInOrg: [\"POST /orgs/{org}/repos\"],\n createOrUpdateFileContents: [\"PUT /repos/{owner}/{repo}/contents/{path}\"],\n createPagesSite: [\n \"POST /repos/{owner}/{repo}/pages\",\n { mediaType: { previews: [\"switcheroo\"] } },\n ],\n createRelease: [\"POST /repos/{owner}/{repo}/releases\"],\n createUsingTemplate: [\n \"POST /repos/{template_owner}/{template_repo}/generate\",\n { mediaType: { previews: [\"baptiste\"] } },\n ],\n createWebhook: [\"POST /repos/{owner}/{repo}/hooks\"],\n declineInvitation: [\"DELETE /user/repository_invitations/{invitation_id}\"],\n delete: [\"DELETE /repos/{owner}/{repo}\"],\n deleteAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions\",\n ],\n deleteAdminBranchProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins\",\n ],\n deleteBranchProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection\",\n ],\n deleteCommitComment: [\"DELETE /repos/{owner}/{repo}/comments/{comment_id}\"],\n deleteCommitSignatureProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures\",\n { mediaType: { previews: [\"zzzax\"] } },\n ],\n deleteDeployKey: [\"DELETE /repos/{owner}/{repo}/keys/{key_id}\"],\n deleteDeployment: [\n \"DELETE /repos/{owner}/{repo}/deployments/{deployment_id}\",\n ],\n deleteFile: [\"DELETE /repos/{owner}/{repo}/contents/{path}\"],\n deleteInvitation: [\n \"DELETE /repos/{owner}/{repo}/invitations/{invitation_id}\",\n ],\n deletePagesSite: [\n \"DELETE /repos/{owner}/{repo}/pages\",\n { mediaType: { previews: [\"switcheroo\"] } },\n ],\n deletePullRequestReviewProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews\",\n ],\n deleteRelease: [\"DELETE /repos/{owner}/{repo}/releases/{release_id}\"],\n deleteReleaseAsset: [\n \"DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}\",\n ],\n deleteWebhook: [\"DELETE /repos/{owner}/{repo}/hooks/{hook_id}\"],\n disableAutomatedSecurityFixes: [\n \"DELETE /repos/{owner}/{repo}/automated-security-fixes\",\n { mediaType: { previews: [\"london\"] } },\n ],\n disableVulnerabilityAlerts: [\n \"DELETE /repos/{owner}/{repo}/vulnerability-alerts\",\n { mediaType: { previews: [\"dorian\"] } },\n ],\n downloadArchive: [\n \"GET /repos/{owner}/{repo}/zipball/{ref}\",\n {},\n { renamed: [\"repos\", \"downloadZipballArchive\"] },\n ],\n downloadTarballArchive: [\"GET /repos/{owner}/{repo}/tarball/{ref}\"],\n downloadZipballArchive: [\"GET /repos/{owner}/{repo}/zipball/{ref}\"],\n enableAutomatedSecurityFixes: [\n \"PUT /repos/{owner}/{repo}/automated-security-fixes\",\n { mediaType: { previews: [\"london\"] } },\n ],\n enableVulnerabilityAlerts: [\n \"PUT /repos/{owner}/{repo}/vulnerability-alerts\",\n { mediaType: { previews: [\"dorian\"] } },\n ],\n get: [\"GET /repos/{owner}/{repo}\"],\n getAccessRestrictions: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions\",\n ],\n getAdminBranchProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins\",\n ],\n getAllStatusCheckContexts: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n ],\n getAllTopics: [\n \"GET /repos/{owner}/{repo}/topics\",\n { mediaType: { previews: [\"mercy\"] } },\n ],\n getAppsWithAccessToProtectedBranch: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n ],\n getBranch: [\"GET /repos/{owner}/{repo}/branches/{branch}\"],\n getBranchProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection\",\n ],\n getClones: [\"GET /repos/{owner}/{repo}/traffic/clones\"],\n getCodeFrequencyStats: [\"GET /repos/{owner}/{repo}/stats/code_frequency\"],\n getCollaboratorPermissionLevel: [\n \"GET /repos/{owner}/{repo}/collaborators/{username}/permission\",\n ],\n getCombinedStatusForRef: [\"GET /repos/{owner}/{repo}/commits/{ref}/status\"],\n getCommit: [\"GET /repos/{owner}/{repo}/commits/{ref}\"],\n getCommitActivityStats: [\"GET /repos/{owner}/{repo}/stats/commit_activity\"],\n getCommitComment: [\"GET /repos/{owner}/{repo}/comments/{comment_id}\"],\n getCommitSignatureProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures\",\n { mediaType: { previews: [\"zzzax\"] } },\n ],\n getCommunityProfileMetrics: [\"GET /repos/{owner}/{repo}/community/profile\"],\n getContent: [\"GET /repos/{owner}/{repo}/contents/{path}\"],\n getContributorsStats: [\"GET /repos/{owner}/{repo}/stats/contributors\"],\n getDeployKey: [\"GET /repos/{owner}/{repo}/keys/{key_id}\"],\n getDeployment: [\"GET /repos/{owner}/{repo}/deployments/{deployment_id}\"],\n getDeploymentStatus: [\n \"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}\",\n ],\n getLatestPagesBuild: [\"GET /repos/{owner}/{repo}/pages/builds/latest\"],\n getLatestRelease: [\"GET /repos/{owner}/{repo}/releases/latest\"],\n getPages: [\"GET /repos/{owner}/{repo}/pages\"],\n getPagesBuild: [\"GET /repos/{owner}/{repo}/pages/builds/{build_id}\"],\n getParticipationStats: [\"GET /repos/{owner}/{repo}/stats/participation\"],\n getPullRequestReviewProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews\",\n ],\n getPunchCardStats: [\"GET /repos/{owner}/{repo}/stats/punch_card\"],\n getReadme: [\"GET /repos/{owner}/{repo}/readme\"],\n getRelease: [\"GET /repos/{owner}/{repo}/releases/{release_id}\"],\n getReleaseAsset: [\"GET /repos/{owner}/{repo}/releases/assets/{asset_id}\"],\n getReleaseByTag: [\"GET /repos/{owner}/{repo}/releases/tags/{tag}\"],\n getStatusChecksProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n ],\n getTeamsWithAccessToProtectedBranch: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n ],\n getTopPaths: [\"GET /repos/{owner}/{repo}/traffic/popular/paths\"],\n getTopReferrers: [\"GET /repos/{owner}/{repo}/traffic/popular/referrers\"],\n getUsersWithAccessToProtectedBranch: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n ],\n getViews: [\"GET /repos/{owner}/{repo}/traffic/views\"],\n getWebhook: [\"GET /repos/{owner}/{repo}/hooks/{hook_id}\"],\n getWebhookConfigForRepo: [\n \"GET /repos/{owner}/{repo}/hooks/{hook_id}/config\",\n ],\n listBranches: [\"GET /repos/{owner}/{repo}/branches\"],\n listBranchesForHeadCommit: [\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head\",\n { mediaType: { previews: [\"groot\"] } },\n ],\n listCollaborators: [\"GET /repos/{owner}/{repo}/collaborators\"],\n listCommentsForCommit: [\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/comments\",\n ],\n listCommitCommentsForRepo: [\"GET /repos/{owner}/{repo}/comments\"],\n listCommitStatusesForRef: [\n \"GET /repos/{owner}/{repo}/commits/{ref}/statuses\",\n ],\n listCommits: [\"GET /repos/{owner}/{repo}/commits\"],\n listContributors: [\"GET /repos/{owner}/{repo}/contributors\"],\n listDeployKeys: [\"GET /repos/{owner}/{repo}/keys\"],\n listDeploymentStatuses: [\n \"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses\",\n ],\n listDeployments: [\"GET /repos/{owner}/{repo}/deployments\"],\n listForAuthenticatedUser: [\"GET /user/repos\"],\n listForOrg: [\"GET /orgs/{org}/repos\"],\n listForUser: [\"GET /users/{username}/repos\"],\n listForks: [\"GET /repos/{owner}/{repo}/forks\"],\n listInvitations: [\"GET /repos/{owner}/{repo}/invitations\"],\n listInvitationsForAuthenticatedUser: [\"GET /user/repository_invitations\"],\n listLanguages: [\"GET /repos/{owner}/{repo}/languages\"],\n listPagesBuilds: [\"GET /repos/{owner}/{repo}/pages/builds\"],\n listPublic: [\"GET /repositories\"],\n listPullRequestsAssociatedWithCommit: [\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls\",\n { mediaType: { previews: [\"groot\"] } },\n ],\n listReleaseAssets: [\n \"GET /repos/{owner}/{repo}/releases/{release_id}/assets\",\n ],\n listReleases: [\"GET /repos/{owner}/{repo}/releases\"],\n listTags: [\"GET /repos/{owner}/{repo}/tags\"],\n listTeams: [\"GET /repos/{owner}/{repo}/teams\"],\n listWebhooks: [\"GET /repos/{owner}/{repo}/hooks\"],\n merge: [\"POST /repos/{owner}/{repo}/merges\"],\n pingWebhook: [\"POST /repos/{owner}/{repo}/hooks/{hook_id}/pings\"],\n removeAppAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n {},\n { mapToData: \"apps\" },\n ],\n removeCollaborator: [\n \"DELETE /repos/{owner}/{repo}/collaborators/{username}\",\n ],\n removeStatusCheckContexts: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n {},\n { mapToData: \"contexts\" },\n ],\n removeStatusCheckProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n ],\n removeTeamAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n {},\n { mapToData: \"teams\" },\n ],\n removeUserAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n {},\n { mapToData: \"users\" },\n ],\n replaceAllTopics: [\n \"PUT /repos/{owner}/{repo}/topics\",\n { mediaType: { previews: [\"mercy\"] } },\n ],\n requestPagesBuild: [\"POST /repos/{owner}/{repo}/pages/builds\"],\n setAdminBranchProtection: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins\",\n ],\n setAppAccessRestrictions: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n {},\n { mapToData: \"apps\" },\n ],\n setStatusCheckContexts: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n {},\n { mapToData: \"contexts\" },\n ],\n setTeamAccessRestrictions: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n {},\n { mapToData: \"teams\" },\n ],\n setUserAccessRestrictions: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n {},\n { mapToData: \"users\" },\n ],\n testPushWebhook: [\"POST /repos/{owner}/{repo}/hooks/{hook_id}/tests\"],\n transfer: [\"POST /repos/{owner}/{repo}/transfer\"],\n update: [\"PATCH /repos/{owner}/{repo}\"],\n updateBranchProtection: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection\",\n ],\n updateCommitComment: [\"PATCH /repos/{owner}/{repo}/comments/{comment_id}\"],\n updateInformationAboutPagesSite: [\"PUT /repos/{owner}/{repo}/pages\"],\n updateInvitation: [\n \"PATCH /repos/{owner}/{repo}/invitations/{invitation_id}\",\n ],\n updatePullRequestReviewProtection: [\n \"PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews\",\n ],\n updateRelease: [\"PATCH /repos/{owner}/{repo}/releases/{release_id}\"],\n updateReleaseAsset: [\n \"PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}\",\n ],\n updateStatusCheckPotection: [\n \"PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n {},\n { renamed: [\"repos\", \"updateStatusCheckProtection\"] },\n ],\n updateStatusCheckProtection: [\n \"PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n ],\n updateWebhook: [\"PATCH /repos/{owner}/{repo}/hooks/{hook_id}\"],\n updateWebhookConfigForRepo: [\n \"PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config\",\n ],\n uploadReleaseAsset: [\n \"POST /repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}\",\n { baseUrl: \"https://uploads.github.com\" },\n ],\n },\n search: {\n code: [\"GET /search/code\"],\n commits: [\"GET /search/commits\", { mediaType: { previews: [\"cloak\"] } }],\n issuesAndPullRequests: [\"GET /search/issues\"],\n labels: [\"GET /search/labels\"],\n repos: [\"GET /search/repositories\"],\n topics: [\"GET /search/topics\", { mediaType: { previews: [\"mercy\"] } }],\n users: [\"GET /search/users\"],\n },\n secretScanning: {\n getAlert: [\n \"GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}\",\n ],\n listAlertsForRepo: [\"GET /repos/{owner}/{repo}/secret-scanning/alerts\"],\n updateAlert: [\n \"PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}\",\n ],\n },\n teams: {\n addOrUpdateMembershipForUserInOrg: [\n \"PUT /orgs/{org}/teams/{team_slug}/memberships/{username}\",\n ],\n addOrUpdateProjectPermissionsInOrg: [\n \"PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n addOrUpdateRepoPermissionsInOrg: [\n \"PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}\",\n ],\n checkPermissionsForProjectInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n checkPermissionsForRepoInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}\",\n ],\n create: [\"POST /orgs/{org}/teams\"],\n createDiscussionCommentInOrg: [\n \"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments\",\n ],\n createDiscussionInOrg: [\"POST /orgs/{org}/teams/{team_slug}/discussions\"],\n deleteDiscussionCommentInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}\",\n ],\n deleteDiscussionInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}\",\n ],\n deleteInOrg: [\"DELETE /orgs/{org}/teams/{team_slug}\"],\n getByName: [\"GET /orgs/{org}/teams/{team_slug}\"],\n getDiscussionCommentInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}\",\n ],\n getDiscussionInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}\",\n ],\n getMembershipForUserInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/memberships/{username}\",\n ],\n list: [\"GET /orgs/{org}/teams\"],\n listChildInOrg: [\"GET /orgs/{org}/teams/{team_slug}/teams\"],\n listDiscussionCommentsInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments\",\n ],\n listDiscussionsInOrg: [\"GET /orgs/{org}/teams/{team_slug}/discussions\"],\n listForAuthenticatedUser: [\"GET /user/teams\"],\n listMembersInOrg: [\"GET /orgs/{org}/teams/{team_slug}/members\"],\n listPendingInvitationsInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/invitations\",\n ],\n listProjectsInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listReposInOrg: [\"GET /orgs/{org}/teams/{team_slug}/repos\"],\n removeMembershipForUserInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}\",\n ],\n removeProjectInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}\",\n ],\n removeRepoInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}\",\n ],\n updateDiscussionCommentInOrg: [\n \"PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}\",\n ],\n updateDiscussionInOrg: [\n \"PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}\",\n ],\n updateInOrg: [\"PATCH /orgs/{org}/teams/{team_slug}\"],\n },\n users: {\n addEmailForAuthenticated: [\"POST /user/emails\"],\n block: [\"PUT /user/blocks/{username}\"],\n checkBlocked: [\"GET /user/blocks/{username}\"],\n checkFollowingForUser: [\"GET /users/{username}/following/{target_user}\"],\n checkPersonIsFollowedByAuthenticated: [\"GET /user/following/{username}\"],\n createGpgKeyForAuthenticated: [\"POST /user/gpg_keys\"],\n createPublicSshKeyForAuthenticated: [\"POST /user/keys\"],\n deleteEmailForAuthenticated: [\"DELETE /user/emails\"],\n deleteGpgKeyForAuthenticated: [\"DELETE /user/gpg_keys/{gpg_key_id}\"],\n deletePublicSshKeyForAuthenticated: [\"DELETE /user/keys/{key_id}\"],\n follow: [\"PUT /user/following/{username}\"],\n getAuthenticated: [\"GET /user\"],\n getByUsername: [\"GET /users/{username}\"],\n getContextForUser: [\"GET /users/{username}/hovercard\"],\n getGpgKeyForAuthenticated: [\"GET /user/gpg_keys/{gpg_key_id}\"],\n getPublicSshKeyForAuthenticated: [\"GET /user/keys/{key_id}\"],\n list: [\"GET /users\"],\n listBlockedByAuthenticated: [\"GET /user/blocks\"],\n listEmailsForAuthenticated: [\"GET /user/emails\"],\n listFollowedByAuthenticated: [\"GET /user/following\"],\n listFollowersForAuthenticatedUser: [\"GET /user/followers\"],\n listFollowersForUser: [\"GET /users/{username}/followers\"],\n listFollowingForUser: [\"GET /users/{username}/following\"],\n listGpgKeysForAuthenticated: [\"GET /user/gpg_keys\"],\n listGpgKeysForUser: [\"GET /users/{username}/gpg_keys\"],\n listPublicEmailsForAuthenticated: [\"GET /user/public_emails\"],\n listPublicKeysForUser: [\"GET /users/{username}/keys\"],\n listPublicSshKeysForAuthenticated: [\"GET /user/keys\"],\n setPrimaryEmailVisibilityForAuthenticated: [\"PATCH /user/email/visibility\"],\n unblock: [\"DELETE /user/blocks/{username}\"],\n unfollow: [\"DELETE /user/following/{username}\"],\n updateAuthenticated: [\"PATCH /user\"],\n },\n};\nexport default Endpoints;\n","export const VERSION = \"4.5.2\";\n","export function endpointsToMethods(octokit, endpointsMap) {\n const newMethods = {};\n for (const [scope, endpoints] of Object.entries(endpointsMap)) {\n for (const [methodName, endpoint] of Object.entries(endpoints)) {\n const [route, defaults, decorations] = endpoint;\n const [method, url] = route.split(/ /);\n const endpointDefaults = Object.assign({ method, url }, defaults);\n if (!newMethods[scope]) {\n newMethods[scope] = {};\n }\n const scopeMethods = newMethods[scope];\n if (decorations) {\n scopeMethods[methodName] = decorate(octokit, scope, methodName, endpointDefaults, decorations);\n continue;\n }\n scopeMethods[methodName] = octokit.request.defaults(endpointDefaults);\n }\n }\n return newMethods;\n}\nfunction decorate(octokit, scope, methodName, defaults, decorations) {\n const requestWithDefaults = octokit.request.defaults(defaults);\n /* istanbul ignore next */\n function withDecorations(...args) {\n // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488\n let options = requestWithDefaults.endpoint.merge(...args);\n // There are currently no other decorations than `.mapToData`\n if (decorations.mapToData) {\n options = Object.assign({}, options, {\n data: options[decorations.mapToData],\n [decorations.mapToData]: undefined,\n });\n return requestWithDefaults(options);\n }\n if (decorations.renamed) {\n const [newScope, newMethodName] = decorations.renamed;\n octokit.log.warn(`octokit.${scope}.${methodName}() has been renamed to octokit.${newScope}.${newMethodName}()`);\n }\n if (decorations.deprecated) {\n octokit.log.warn(decorations.deprecated);\n }\n if (decorations.renamedParameters) {\n // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488\n const options = requestWithDefaults.endpoint.merge(...args);\n for (const [name, alias] of Object.entries(decorations.renamedParameters)) {\n if (name in options) {\n octokit.log.warn(`\"${name}\" parameter is deprecated for \"octokit.${scope}.${methodName}()\". Use \"${alias}\" instead`);\n if (!(alias in options)) {\n options[alias] = options[name];\n }\n delete options[name];\n }\n }\n return requestWithDefaults(options);\n }\n // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488\n return requestWithDefaults(...args);\n }\n return Object.assign(withDecorations, requestWithDefaults);\n}\n","import ENDPOINTS from \"./generated/endpoints\";\nimport { VERSION } from \"./version\";\nimport { endpointsToMethods } from \"./endpoints-to-methods\";\n/**\n * This plugin is a 1:1 copy of internal @octokit/rest plugins. The primary\n * goal is to rebuild @octokit/rest on top of @octokit/core. Once that is\n * done, we will remove the registerEndpoints methods and return the methods\n * directly as with the other plugins. At that point we will also remove the\n * legacy workarounds and deprecations.\n *\n * See the plan at\n * https://github.com/octokit/plugin-rest-endpoint-methods.js/pull/1\n */\nexport function restEndpointMethods(octokit) {\n return endpointsToMethods(octokit, ENDPOINTS);\n}\nrestEndpointMethods.VERSION = VERSION;\n"],"names":["ENDPOINTS"],"mappings":"AAAA,MAAM,SAAS,GAAG;AAClB,IAAI,OAAO,EAAE;AACb,QAAQ,0BAA0B,EAAE;AACpC,YAAY,4EAA4E;AACxF,SAAS;AACT,QAAQ,iBAAiB,EAAE;AAC3B,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,uBAAuB,EAAE,CAAC,+CAA+C,CAAC;AAClF,QAAQ,wBAAwB,EAAE;AAClC,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,6BAA6B,EAAE;AACvC,YAAY,qDAAqD;AACjE,SAAS;AACT,QAAQ,8BAA8B,EAAE;AACxC,YAAY,+DAA+D;AAC3E,SAAS;AACT,QAAQ,uBAAuB,EAAE,CAAC,+CAA+C,CAAC;AAClF,QAAQ,wBAAwB,EAAE;AAClC,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,sBAAsB,EAAE;AAChC,YAAY,uEAAuE;AACnF,SAAS;AACT,QAAQ,cAAc,EAAE;AACxB,YAAY,8DAA8D;AAC1E,SAAS;AACT,QAAQ,eAAe,EAAE,CAAC,kDAAkD,CAAC;AAC7E,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,4DAA4D;AACxE,SAAS;AACT,QAAQ,6BAA6B,EAAE;AACvC,YAAY,gDAAgD;AAC5D,SAAS;AACT,QAAQ,8BAA8B,EAAE;AACxC,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,oDAAoD,CAAC;AACjF,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,kDAAkD,EAAE;AAC5D,YAAY,qEAAqE;AACjF,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,mEAAmE;AAC/E,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,4EAA4E;AACxF,SAAS;AACT,QAAQ,6BAA6B,EAAE;AACvC,YAAY,sDAAsD;AAClE,SAAS;AACT,QAAQ,uBAAuB,EAAE;AACjC,YAAY,sDAAsD;AAClE,SAAS;AACT,QAAQ,iDAAiD,EAAE;AAC3D,YAAY,kEAAkE;AAC9E,SAAS;AACT,QAAQ,cAAc,EAAE;AACxB,YAAY,kEAAkE;AAC9E,SAAS;AACT,QAAQ,6BAA6B,EAAE;AACvC,YAAY,sDAAsD;AAClE,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,gEAAgE;AAC5E,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,2DAA2D,CAAC;AAClF,QAAQ,uCAAuC,EAAE;AACjD,YAAY,qCAAqC;AACjD,SAAS;AACT,QAAQ,qCAAqC,EAAE;AAC/C,YAAY,+CAA+C;AAC3D,SAAS;AACT,QAAQ,oBAAoB,EAAE,CAAC,iDAAiD,CAAC;AACjF,QAAQ,eAAe,EAAE,CAAC,4CAA4C,CAAC;AACvE,QAAQ,YAAY,EAAE,CAAC,+CAA+C,CAAC;AACvE,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,+CAA+C;AAC3D,YAAY,EAAE;AACd,YAAY,EAAE,OAAO,EAAE,CAAC,SAAS,EAAE,uCAAuC,CAAC,EAAE;AAC7E,SAAS;AACT,QAAQ,gBAAgB,EAAE,CAAC,sDAAsD,CAAC;AAClF,QAAQ,aAAa,EAAE,CAAC,yDAAyD,CAAC;AAClF,QAAQ,yBAAyB,EAAE,CAAC,6CAA6C,CAAC;AAClF,QAAQ,0BAA0B,EAAE;AACpC,YAAY,uDAAuD;AACnE,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,2DAA2D,CAAC;AAClF,QAAQ,cAAc,EAAE,CAAC,iDAAiD,CAAC;AAC3E,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,kEAAkE;AAC9E,SAAS;AACT,QAAQ,oBAAoB,EAAE,CAAC,6CAA6C,CAAC;AAC7E,QAAQ,sBAAsB,EAAE;AAChC,YAAY,sDAAsD;AAClE,SAAS;AACT,QAAQ,cAAc,EAAE,CAAC,iCAAiC,CAAC;AAC3D,QAAQ,eAAe,EAAE,CAAC,2CAA2C,CAAC;AACtE,QAAQ,iBAAiB,EAAE,CAAC,6CAA6C,CAAC;AAC1E,QAAQ,4BAA4B,EAAE,CAAC,2CAA2C,CAAC;AACnF,QAAQ,6BAA6B,EAAE;AACvC,YAAY,qDAAqD;AACjE,SAAS;AACT,QAAQ,6BAA6B,EAAE;AACvC,YAAY,4DAA4D;AACxE,SAAS;AACT,QAAQ,wDAAwD,EAAE;AAClE,YAAY,kDAAkD;AAC9D,SAAS;AACT,QAAQ,2BAA2B,EAAE,CAAC,iCAAiC,CAAC;AACxE,QAAQ,4BAA4B,EAAE,CAAC,2CAA2C,CAAC;AACnF,QAAQ,wBAAwB,EAAE;AAClC,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,gEAAgE;AAC5E,SAAS;AACT,QAAQ,uBAAuB,EAAE,CAAC,wCAAwC,CAAC;AAC3E,QAAQ,aAAa,EAAE,CAAC,wDAAwD,CAAC;AACjF,QAAQ,+BAA+B,EAAE;AACzC,YAAY,+EAA+E;AAC3F,SAAS;AACT,QAAQ,6BAA6B,EAAE;AACvC,YAAY,sDAAsD;AAClE,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,gEAAgE;AAC5E,SAAS;AACT,QAAQ,uCAAuC,EAAE;AACjD,YAAY,qCAAqC;AACjD,SAAS;AACT,QAAQ,qCAAqC,EAAE;AAC/C,YAAY,+CAA+C;AAC3D,SAAS;AACT,QAAQ,4BAA4B,EAAE;AACtC,YAAY,4DAA4D;AACxE,SAAS;AACT,QAAQ,uDAAuD,EAAE;AACjE,YAAY,kDAAkD;AAC9D,SAAS;AACT,KAAK;AACL,IAAI,QAAQ,EAAE;AACd,QAAQ,qCAAqC,EAAE,CAAC,kCAAkC,CAAC;AACnF,QAAQ,sBAAsB,EAAE,CAAC,2CAA2C,CAAC;AAC7E,QAAQ,wBAAwB,EAAE;AAClC,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,QAAQ,EAAE,CAAC,YAAY,CAAC;AAChC,QAAQ,mBAAmB,EAAE,CAAC,wCAAwC,CAAC;AACvE,QAAQ,SAAS,EAAE,CAAC,wCAAwC,CAAC;AAC7D,QAAQ,yCAAyC,EAAE;AACnD,YAAY,qDAAqD;AACjE,SAAS;AACT,QAAQ,8BAA8B,EAAE,CAAC,8BAA8B,CAAC;AACxE,QAAQ,qCAAqC,EAAE,CAAC,oBAAoB,CAAC;AACrE,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,yCAAyC;AACrD,SAAS;AACT,QAAQ,gBAAgB,EAAE,CAAC,aAAa,CAAC;AACzC,QAAQ,8BAA8B,EAAE,CAAC,qCAAqC,CAAC;AAC/E,QAAQ,uBAAuB,EAAE,CAAC,qCAAqC,CAAC;AACxE,QAAQ,mBAAmB,EAAE,CAAC,wBAAwB,CAAC;AACvD,QAAQ,yBAAyB,EAAE,CAAC,uCAAuC,CAAC;AAC5E,QAAQ,+BAA+B,EAAE;AACzC,YAAY,8CAA8C;AAC1D,SAAS;AACT,QAAQ,cAAc,EAAE,CAAC,kCAAkC,CAAC;AAC5D,QAAQ,yCAAyC,EAAE;AACnD,YAAY,yCAAyC;AACrD,SAAS;AACT,QAAQ,mCAAmC,EAAE,CAAC,mBAAmB,CAAC;AAClE,QAAQ,sBAAsB,EAAE,CAAC,+BAA+B,CAAC;AACjE,QAAQ,sBAAsB,EAAE,CAAC,qCAAqC,CAAC;AACvE,QAAQ,qBAAqB,EAAE,CAAC,sCAAsC,CAAC;AACvE,QAAQ,oCAAoC,EAAE,CAAC,yBAAyB,CAAC;AACzE,QAAQ,mBAAmB,EAAE,CAAC,uCAAuC,CAAC;AACtE,QAAQ,uBAAuB,EAAE,CAAC,oBAAoB,CAAC;AACvD,QAAQ,2BAA2B,EAAE,CAAC,yCAAyC,CAAC;AAChF,QAAQ,gBAAgB,EAAE,CAAC,0CAA0C,CAAC;AACtE,QAAQ,mBAAmB,EAAE,CAAC,wCAAwC,CAAC;AACvE,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,qDAAqD;AACjE,SAAS;AACT,QAAQ,4BAA4B,EAAE,CAAC,kCAAkC,CAAC;AAC1E,QAAQ,8BAA8B,EAAE,CAAC,qCAAqC,CAAC;AAC/E,KAAK;AACL,IAAI,IAAI,EAAE;AACV,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,wEAAwE;AACpF,SAAS;AACT,QAAQ,UAAU,EAAE,CAAC,sCAAsC,CAAC;AAC5D,QAAQ,uBAAuB,EAAE;AACjC,YAAY,6DAA6D;AACzE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,kBAAkB,EAAE,CAAC,wCAAwC,CAAC;AACtE,QAAQ,6BAA6B,EAAE;AACvC,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,mBAAmB,EAAE,CAAC,wCAAwC,CAAC;AACvE,QAAQ,kBAAkB,EAAE,CAAC,6CAA6C,CAAC;AAC3E,QAAQ,WAAW,EAAE,CAAC,wCAAwC,CAAC;AAC/D,QAAQ,gBAAgB,EAAE,CAAC,UAAU,CAAC;AACtC,QAAQ,SAAS,EAAE,CAAC,sBAAsB,CAAC;AAC3C,QAAQ,eAAe,EAAE,CAAC,0CAA0C,CAAC;AACrE,QAAQ,kBAAkB,EAAE,CAAC,8BAA8B,CAAC;AAC5D,QAAQ,mBAAmB,EAAE,CAAC,wCAAwC,CAAC;AACvE,QAAQ,6BAA6B,EAAE;AACvC,YAAY,gDAAgD;AAC5D,SAAS;AACT,QAAQ,oCAAoC,EAAE;AAC9C,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,mBAAmB,EAAE,CAAC,oCAAoC,CAAC;AACnE,QAAQ,sBAAsB,EAAE,CAAC,sBAAsB,CAAC;AACxD,QAAQ,mBAAmB,EAAE,CAAC,mDAAmD,CAAC;AAClF,QAAQ,0BAA0B,EAAE;AACpC,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,yCAAyC,EAAE;AACnD,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,wBAAwB,CAAC;AACrD,QAAQ,qCAAqC,EAAE,CAAC,yBAAyB,CAAC;AAC1E,QAAQ,SAAS,EAAE,CAAC,gCAAgC,CAAC;AACrD,QAAQ,gBAAgB,EAAE,CAAC,wCAAwC,CAAC;AACpE,QAAQ,iCAAiC,EAAE,CAAC,gCAAgC,CAAC;AAC7E,QAAQ,qCAAqC,EAAE,CAAC,iCAAiC,CAAC;AAClF,QAAQ,4CAA4C,EAAE;AACtD,YAAY,yCAAyC;AACrD,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,2EAA2E;AACvF,SAAS;AACT,QAAQ,UAAU,EAAE,CAAC,uCAAuC,CAAC;AAC7D,QAAQ,6BAA6B,EAAE,CAAC,4BAA4B,CAAC;AACrE,QAAQ,UAAU,EAAE,CAAC,6CAA6C,CAAC;AACnE,QAAQ,mBAAmB,EAAE,CAAC,oDAAoD,CAAC;AACnF,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,uDAAuD;AACnE,SAAS;AACT,QAAQ,yBAAyB,EAAE,CAAC,wBAAwB,CAAC;AAC7D,KAAK;AACL,IAAI,OAAO,EAAE;AACb,QAAQ,0BAA0B,EAAE,CAAC,0CAA0C,CAAC;AAChF,QAAQ,2BAA2B,EAAE;AACrC,YAAY,gDAAgD;AAC5D,SAAS;AACT,QAAQ,2BAA2B,EAAE,CAAC,2CAA2C,CAAC;AAClF,QAAQ,4BAA4B,EAAE;AACtC,YAAY,iDAAiD;AAC7D,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,iDAAiD;AAC7D,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,uDAAuD;AACnE,SAAS;AACT,KAAK;AACL,IAAI,MAAM,EAAE;AACZ,QAAQ,MAAM,EAAE,CAAC,uCAAuC,CAAC;AACzD,QAAQ,WAAW,EAAE,CAAC,yCAAyC,CAAC;AAChE,QAAQ,GAAG,EAAE,CAAC,qDAAqD,CAAC;AACpE,QAAQ,QAAQ,EAAE,CAAC,yDAAyD,CAAC;AAC7E,QAAQ,eAAe,EAAE;AACzB,YAAY,iEAAiE;AAC7E,SAAS;AACT,QAAQ,UAAU,EAAE,CAAC,oDAAoD,CAAC;AAC1E,QAAQ,YAAY,EAAE;AACtB,YAAY,oEAAoE;AAChF,SAAS;AACT,QAAQ,gBAAgB,EAAE,CAAC,sDAAsD,CAAC;AAClF,QAAQ,cAAc,EAAE;AACxB,YAAY,oEAAoE;AAChF,SAAS;AACT,QAAQ,oBAAoB,EAAE;AAC9B,YAAY,sDAAsD;AAClE,SAAS;AACT,QAAQ,MAAM,EAAE,CAAC,uDAAuD,CAAC;AACzE,KAAK;AACL,IAAI,YAAY,EAAE;AAClB,QAAQ,QAAQ,EAAE;AAClB,YAAY,+DAA+D;AAC3E,YAAY,EAAE;AACd,YAAY,EAAE,iBAAiB,EAAE,EAAE,QAAQ,EAAE,cAAc,EAAE,EAAE;AAC/D,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,gDAAgD,CAAC;AAC7E,QAAQ,kBAAkB,EAAE,CAAC,kDAAkD,CAAC;AAChF,QAAQ,WAAW,EAAE;AACrB,YAAY,iEAAiE;AAC7E,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,iDAAiD,CAAC;AACxE,KAAK;AACL,IAAI,cAAc,EAAE;AACpB,QAAQ,oBAAoB,EAAE;AAC9B,YAAY,uBAAuB;AACnC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,cAAc,EAAE;AACxB,YAAY,6BAA6B;AACzC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,qDAAqD;AACjE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,KAAK;AACL,IAAI,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,EAAE;AACpC,IAAI,eAAe,EAAE;AACrB,QAAQ,kDAAkD,EAAE;AAC5D,YAAY,6EAA6E;AACzF,SAAS;AACT,QAAQ,iDAAiD,EAAE;AAC3D,YAAY,0EAA0E;AACtF,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,oEAAoE;AAChF,SAAS;AACT,QAAQ,qCAAqC,EAAE;AAC/C,YAAY,mDAAmD;AAC/D,SAAS;AACT,QAAQ,uDAAuD,EAAE;AACjE,YAAY,iEAAiE;AAC7E,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,oEAAoE;AAChF,SAAS;AACT,QAAQ,qCAAqC,EAAE;AAC/C,YAAY,mDAAmD;AAC/D,SAAS;AACT,QAAQ,sDAAsD,EAAE;AAChE,YAAY,iEAAiE;AAC7E,SAAS;AACT,KAAK;AACL,IAAI,KAAK,EAAE;AACX,QAAQ,cAAc,EAAE,CAAC,2BAA2B,CAAC;AACrD,QAAQ,MAAM,EAAE,CAAC,aAAa,CAAC;AAC/B,QAAQ,aAAa,EAAE,CAAC,gCAAgC,CAAC;AACzD,QAAQ,MAAM,EAAE,CAAC,yBAAyB,CAAC;AAC3C,QAAQ,aAAa,EAAE,CAAC,+CAA+C,CAAC;AACxE,QAAQ,IAAI,EAAE,CAAC,6BAA6B,CAAC;AAC7C,QAAQ,GAAG,EAAE,CAAC,sBAAsB,CAAC;AACrC,QAAQ,UAAU,EAAE,CAAC,4CAA4C,CAAC;AAClE,QAAQ,WAAW,EAAE,CAAC,4BAA4B,CAAC;AACnD,QAAQ,IAAI,EAAE,CAAC,YAAY,CAAC;AAC5B,QAAQ,YAAY,EAAE,CAAC,+BAA+B,CAAC;AACvD,QAAQ,WAAW,EAAE,CAAC,8BAA8B,CAAC;AACrD,QAAQ,WAAW,EAAE,CAAC,6BAA6B,CAAC;AACpD,QAAQ,SAAS,EAAE,CAAC,4BAA4B,CAAC;AACjD,QAAQ,UAAU,EAAE,CAAC,mBAAmB,CAAC;AACzC,QAAQ,WAAW,EAAE,CAAC,oBAAoB,CAAC;AAC3C,QAAQ,IAAI,EAAE,CAAC,2BAA2B,CAAC;AAC3C,QAAQ,MAAM,EAAE,CAAC,8BAA8B,CAAC;AAChD,QAAQ,MAAM,EAAE,CAAC,wBAAwB,CAAC;AAC1C,QAAQ,aAAa,EAAE,CAAC,8CAA8C,CAAC;AACvE,KAAK;AACL,IAAI,GAAG,EAAE;AACT,QAAQ,UAAU,EAAE,CAAC,sCAAsC,CAAC;AAC5D,QAAQ,YAAY,EAAE,CAAC,wCAAwC,CAAC;AAChE,QAAQ,SAAS,EAAE,CAAC,qCAAqC,CAAC;AAC1D,QAAQ,SAAS,EAAE,CAAC,qCAAqC,CAAC;AAC1D,QAAQ,UAAU,EAAE,CAAC,sCAAsC,CAAC;AAC5D,QAAQ,SAAS,EAAE,CAAC,6CAA6C,CAAC;AAClE,QAAQ,OAAO,EAAE,CAAC,gDAAgD,CAAC;AACnE,QAAQ,SAAS,EAAE,CAAC,oDAAoD,CAAC;AACzE,QAAQ,MAAM,EAAE,CAAC,yCAAyC,CAAC;AAC3D,QAAQ,MAAM,EAAE,CAAC,8CAA8C,CAAC;AAChE,QAAQ,OAAO,EAAE,CAAC,gDAAgD,CAAC;AACnE,QAAQ,gBAAgB,EAAE,CAAC,mDAAmD,CAAC;AAC/E,QAAQ,SAAS,EAAE,CAAC,4CAA4C,CAAC;AACjE,KAAK;AACL,IAAI,SAAS,EAAE;AACf,QAAQ,eAAe,EAAE,CAAC,0BAA0B,CAAC;AACrD,QAAQ,WAAW,EAAE,CAAC,iCAAiC,CAAC;AACxD,KAAK;AACL,IAAI,YAAY,EAAE;AAClB,QAAQ,qBAAqB,EAAE,CAAC,oCAAoC,CAAC;AACrE,QAAQ,sBAAsB,EAAE,CAAC,8CAA8C,CAAC;AAChF,QAAQ,iCAAiC,EAAE,CAAC,8BAA8B,CAAC;AAC3E,QAAQ,wBAAwB,EAAE,CAAC,uCAAuC,CAAC;AAC3E,QAAQ,yBAAyB,EAAE;AACnC,YAAY,iDAAiD;AAC7D,SAAS;AACT,QAAQ,oCAAoC,EAAE,CAAC,iCAAiC,CAAC;AACjF,QAAQ,qBAAqB,EAAE,CAAC,oCAAoC,CAAC;AACrE,QAAQ,sBAAsB,EAAE,CAAC,8CAA8C,CAAC;AAChF,QAAQ,iCAAiC,EAAE,CAAC,8BAA8B,CAAC;AAC3E,KAAK;AACL,IAAI,MAAM,EAAE;AACZ,QAAQ,YAAY,EAAE;AACtB,YAAY,4DAA4D;AACxE,SAAS;AACT,QAAQ,SAAS,EAAE,CAAC,yDAAyD,CAAC;AAC9E,QAAQ,sBAAsB,EAAE,CAAC,gDAAgD,CAAC;AAClF,QAAQ,MAAM,EAAE,CAAC,mCAAmC,CAAC;AACrD,QAAQ,aAAa,EAAE;AACvB,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,mCAAmC,CAAC;AAC1D,QAAQ,eAAe,EAAE,CAAC,uCAAuC,CAAC;AAClE,QAAQ,aAAa,EAAE;AACvB,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,4CAA4C,CAAC;AACnE,QAAQ,eAAe,EAAE;AACzB,YAAY,4DAA4D;AACxE,SAAS;AACT,QAAQ,GAAG,EAAE,CAAC,iDAAiD,CAAC;AAChE,QAAQ,UAAU,EAAE,CAAC,wDAAwD,CAAC;AAC9E,QAAQ,QAAQ,EAAE,CAAC,oDAAoD,CAAC;AACxE,QAAQ,QAAQ,EAAE,CAAC,yCAAyC,CAAC;AAC7D,QAAQ,YAAY,EAAE,CAAC,yDAAyD,CAAC;AACjF,QAAQ,IAAI,EAAE,CAAC,aAAa,CAAC;AAC7B,QAAQ,aAAa,EAAE,CAAC,qCAAqC,CAAC;AAC9D,QAAQ,YAAY,EAAE,CAAC,0DAA0D,CAAC;AAClF,QAAQ,mBAAmB,EAAE,CAAC,2CAA2C,CAAC;AAC1E,QAAQ,UAAU,EAAE,CAAC,wDAAwD,CAAC;AAC9E,QAAQ,iBAAiB,EAAE,CAAC,yCAAyC,CAAC;AACtE,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,0DAA0D;AACtE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC,EAAE,EAAE;AACxD,SAAS;AACT,QAAQ,wBAAwB,EAAE,CAAC,kBAAkB,CAAC;AACtD,QAAQ,UAAU,EAAE,CAAC,wBAAwB,CAAC;AAC9C,QAAQ,WAAW,EAAE,CAAC,kCAAkC,CAAC;AACzD,QAAQ,sBAAsB,EAAE;AAChC,YAAY,gEAAgE;AAC5E,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,kCAAkC,CAAC;AAC/D,QAAQ,iBAAiB,EAAE;AAC3B,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,cAAc,EAAE,CAAC,sCAAsC,CAAC;AAChE,QAAQ,IAAI,EAAE,CAAC,sDAAsD,CAAC;AACtE,QAAQ,eAAe,EAAE;AACzB,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,8DAA8D;AAC1E,SAAS;AACT,QAAQ,WAAW,EAAE;AACrB,YAAY,kEAAkE;AAC9E,SAAS;AACT,QAAQ,SAAS,EAAE,CAAC,wDAAwD,CAAC;AAC7E,QAAQ,MAAM,EAAE,CAAC,yDAAyD,CAAC;AAC3E,QAAQ,MAAM,EAAE,CAAC,mDAAmD,CAAC;AACrE,QAAQ,aAAa,EAAE,CAAC,0DAA0D,CAAC;AACnF,QAAQ,WAAW,EAAE,CAAC,2CAA2C,CAAC;AAClE,QAAQ,eAAe,EAAE;AACzB,YAAY,2DAA2D;AACvE,SAAS;AACT,KAAK;AACL,IAAI,QAAQ,EAAE;AACd,QAAQ,GAAG,EAAE,CAAC,yBAAyB,CAAC;AACxC,QAAQ,kBAAkB,EAAE,CAAC,eAAe,CAAC;AAC7C,QAAQ,UAAU,EAAE,CAAC,mCAAmC,CAAC;AACzD,KAAK;AACL,IAAI,QAAQ,EAAE;AACd,QAAQ,MAAM,EAAE,CAAC,gBAAgB,CAAC;AAClC,QAAQ,SAAS,EAAE;AACnB,YAAY,oBAAoB;AAChC,YAAY,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,2BAA2B,EAAE,EAAE;AACxE,SAAS;AACT,KAAK;AACL,IAAI,IAAI,EAAE;AACV,QAAQ,GAAG,EAAE,CAAC,WAAW,CAAC;AAC1B,QAAQ,UAAU,EAAE,CAAC,cAAc,CAAC;AACpC,QAAQ,MAAM,EAAE,CAAC,UAAU,CAAC;AAC5B,QAAQ,IAAI,EAAE,CAAC,OAAO,CAAC;AACvB,KAAK;AACL,IAAI,UAAU,EAAE;AAChB,QAAQ,YAAY,EAAE,CAAC,qCAAqC,CAAC;AAC7D,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,gDAAgD;AAC5D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,sDAAsD;AAClE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,mDAAmD;AAC/D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,8BAA8B,EAAE;AACxC,YAAY,6CAA6C;AACzD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,gBAAgB,EAAE,CAAC,0CAA0C,CAAC;AACtE,QAAQ,eAAe,EAAE,CAAC,kCAAkC,CAAC;AAC7D,QAAQ,aAAa,EAAE,CAAC,8CAA8C,CAAC;AACvE,QAAQ,6BAA6B,EAAE;AACvC,YAAY,qCAAqC;AACjD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,2CAA2C;AACvD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,wBAAwB,EAAE;AAClC,YAAY,sBAAsB;AAClC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,4BAA4B;AACxC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,wDAAwD;AACpE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,kDAAkD;AAC9D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,eAAe,EAAE,CAAC,wDAAwD,CAAC;AACnF,QAAQ,gBAAgB,EAAE,CAAC,wCAAwC,CAAC;AACpE,QAAQ,yBAAyB,EAAE,CAAC,uBAAuB,CAAC;AAC5D,QAAQ,WAAW,EAAE,CAAC,6BAA6B,CAAC;AACpD,QAAQ,WAAW,EAAE,CAAC,kCAAkC,CAAC;AACzD,QAAQ,8BAA8B,EAAE;AACxC,YAAY,+DAA+D;AAC3E,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,qEAAqE;AACjF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,YAAY,EAAE,CAAC,oCAAoC,CAAC;AAC5D,KAAK;AACL,IAAI,IAAI,EAAE;AACV,QAAQ,SAAS,EAAE,CAAC,mCAAmC,CAAC;AACxD,QAAQ,gBAAgB,EAAE,CAAC,mCAAmC,CAAC;AAC/D,QAAQ,sBAAsB,EAAE,CAAC,oCAAoC,CAAC;AACtE,QAAQ,4BAA4B,EAAE,CAAC,2CAA2C,CAAC;AACnF,QAAQ,kCAAkC,EAAE;AAC5C,YAAY,kDAAkD;AAC9D,SAAS;AACT,QAAQ,gBAAgB,EAAE,CAAC,8BAA8B,CAAC;AAC1D,QAAQ,aAAa,EAAE,CAAC,wBAAwB,CAAC;AACjD,QAAQ,aAAa,EAAE,CAAC,oCAAoC,CAAC;AAC7D,QAAQ,GAAG,EAAE,CAAC,iBAAiB,CAAC;AAChC,QAAQ,iCAAiC,EAAE,CAAC,kCAAkC,CAAC;AAC/E,QAAQ,oBAAoB,EAAE,CAAC,wCAAwC,CAAC;AACxE,QAAQ,UAAU,EAAE,CAAC,iCAAiC,CAAC;AACvD,QAAQ,sBAAsB,EAAE,CAAC,wCAAwC,CAAC;AAC1E,QAAQ,IAAI,EAAE,CAAC,oBAAoB,CAAC;AACpC,QAAQ,oBAAoB,EAAE,CAAC,+BAA+B,CAAC;AAC/D,QAAQ,gBAAgB,EAAE,CAAC,wBAAwB,CAAC;AACpD,QAAQ,wBAAwB,EAAE,CAAC,gBAAgB,CAAC;AACpD,QAAQ,WAAW,EAAE,CAAC,4BAA4B,CAAC;AACnD,QAAQ,mBAAmB,EAAE,CAAC,mDAAmD,CAAC;AAClF,QAAQ,WAAW,EAAE,CAAC,yBAAyB,CAAC;AAChD,QAAQ,mCAAmC,EAAE,CAAC,4BAA4B,CAAC;AAC3E,QAAQ,wBAAwB,EAAE,CAAC,uCAAuC,CAAC;AAC3E,QAAQ,sBAAsB,EAAE,CAAC,6BAA6B,CAAC;AAC/D,QAAQ,iBAAiB,EAAE,CAAC,gCAAgC,CAAC;AAC7D,QAAQ,YAAY,EAAE,CAAC,uBAAuB,CAAC;AAC/C,QAAQ,WAAW,EAAE,CAAC,wCAAwC,CAAC;AAC/D,QAAQ,YAAY,EAAE,CAAC,uCAAuC,CAAC;AAC/D,QAAQ,uBAAuB,EAAE,CAAC,2CAA2C,CAAC;AAC9E,QAAQ,yBAAyB,EAAE;AACnC,YAAY,qDAAqD;AACjE,SAAS;AACT,QAAQ,0CAA0C,EAAE;AACpD,YAAY,8CAA8C;AAC1D,SAAS;AACT,QAAQ,oBAAoB,EAAE,CAAC,wCAAwC,CAAC;AACxE,QAAQ,uCAAuC,EAAE;AACjD,YAAY,2CAA2C;AACvD,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,sCAAsC,CAAC;AAC7D,QAAQ,MAAM,EAAE,CAAC,mBAAmB,CAAC;AACrC,QAAQ,oCAAoC,EAAE;AAC9C,YAAY,oCAAoC;AAChD,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,mCAAmC,CAAC;AAC5D,QAAQ,yBAAyB,EAAE,CAAC,0CAA0C,CAAC;AAC/E,KAAK;AACL,IAAI,QAAQ,EAAE;AACd,QAAQ,eAAe,EAAE;AACzB,YAAY,qDAAqD;AACjE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,0CAA0C;AACtD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,qCAAqC;AACjD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,qBAAqB;AACjC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,2BAA2B;AACvC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,aAAa,EAAE;AACvB,YAAY,qCAAqC;AACjD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,MAAM,EAAE;AAChB,YAAY,+BAA+B;AAC3C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,0CAA0C;AACtD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,sCAAsC;AAClD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,GAAG,EAAE;AACb,YAAY,4BAA4B;AACxC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,OAAO,EAAE;AACjB,YAAY,uCAAuC;AACnD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,SAAS,EAAE;AACnB,YAAY,mCAAmC;AAC/C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,oBAAoB,EAAE;AAC9B,YAAY,gEAAgE;AAC5E,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,SAAS,EAAE;AACnB,YAAY,yCAAyC;AACrD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,iBAAiB,EAAE;AAC3B,YAAY,0CAA0C;AACtD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,WAAW,EAAE;AACrB,YAAY,oCAAoC;AAChD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,0BAA0B;AACtC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,WAAW,EAAE;AACrB,YAAY,oCAAoC;AAChD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,WAAW,EAAE;AACrB,YAAY,gCAAgC;AAC5C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,QAAQ,EAAE;AAClB,YAAY,8CAA8C;AAC1D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,0CAA0C;AACtD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,wDAAwD;AACpE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,MAAM,EAAE;AAChB,YAAY,8BAA8B;AAC1C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,yCAAyC;AACrD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,qCAAqC;AACjD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,KAAK;AACL,IAAI,KAAK,EAAE;AACX,QAAQ,aAAa,EAAE,CAAC,qDAAqD,CAAC;AAC9E,QAAQ,MAAM,EAAE,CAAC,kCAAkC,CAAC;AACpD,QAAQ,2BAA2B,EAAE;AACrC,YAAY,8EAA8E;AAC1F,SAAS;AACT,QAAQ,YAAY,EAAE,CAAC,wDAAwD,CAAC;AAChF,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,sEAAsE;AAClF,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,aAAa,EAAE;AACvB,YAAY,8EAA8E;AAC1F,SAAS;AACT,QAAQ,GAAG,EAAE,CAAC,+CAA+C,CAAC;AAC9D,QAAQ,SAAS,EAAE;AACnB,YAAY,mEAAmE;AAC/E,SAAS;AACT,QAAQ,gBAAgB,EAAE,CAAC,uDAAuD,CAAC;AACnF,QAAQ,IAAI,EAAE,CAAC,iCAAiC,CAAC;AACjD,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,4EAA4E;AACxF,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,uDAAuD,CAAC;AAC9E,QAAQ,SAAS,EAAE,CAAC,qDAAqD,CAAC;AAC1E,QAAQ,sBAAsB,EAAE;AAChC,YAAY,mEAAmE;AAC/E,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,yBAAyB,EAAE,CAAC,0CAA0C,CAAC;AAC/E,QAAQ,WAAW,EAAE,CAAC,uDAAuD,CAAC;AAC9E,QAAQ,KAAK,EAAE,CAAC,qDAAqD,CAAC;AACtE,QAAQ,wBAAwB,EAAE;AAClC,YAAY,sEAAsE;AAClF,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,oEAAoE;AAChF,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,2EAA2E;AACvF,SAAS;AACT,QAAQ,MAAM,EAAE,CAAC,iDAAiD,CAAC;AACnE,QAAQ,YAAY,EAAE;AACtB,YAAY,6DAA6D;AACzE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;AACnD,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,mEAAmE;AAC/E,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,yDAAyD;AACrE,SAAS;AACT,KAAK;AACL,IAAI,SAAS,EAAE,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EAAE;AAC3C,IAAI,SAAS,EAAE;AACf,QAAQ,sBAAsB,EAAE;AAChC,YAAY,4DAA4D;AACxE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,cAAc,EAAE;AACxB,YAAY,4DAA4D;AACxE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,mEAAmE;AAC/E,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,kEAAkE;AAC9E,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,mCAAmC,EAAE;AAC7C,YAAY,wGAAwG;AACpH,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,4BAA4B,EAAE;AACtC,YAAY,8EAA8E;AAC1F,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,sBAAsB,EAAE;AAChC,YAAY,4EAA4E;AACxF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,cAAc,EAAE;AACxB,YAAY,4EAA4E;AACxF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,mFAAmF;AAC/F,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,kFAAkF;AAC9F,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,uBAAuB,EAAE;AACjC,YAAY,8FAA8F;AAC1G,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,8BAA8B,EAAE;AACxC,YAAY,wHAAwH;AACpI,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,iCAAiC;AAC7C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,YAAY;AACZ,gBAAgB,UAAU,EAAE,oHAAoH;AAChJ,aAAa;AACb,SAAS;AACT,QAAQ,oBAAoB,EAAE;AAC9B,YAAY,2DAA2D;AACvE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,2DAA2D;AACvE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,kEAAkE;AAC9E,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,+BAA+B,EAAE;AACzC,YAAY,iEAAiE;AAC7E,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,uGAAuG;AACnH,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,6EAA6E;AACzF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,KAAK;AACL,IAAI,KAAK,EAAE;AACX,QAAQ,gBAAgB,EAAE,CAAC,oDAAoD,CAAC;AAChF,QAAQ,wBAAwB,EAAE;AAClC,YAAY,2EAA2E;AACvF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE;AACjC,SAAS;AACT,QAAQ,eAAe,EAAE,CAAC,oDAAoD,CAAC;AAC/E,QAAQ,sBAAsB,EAAE;AAChC,YAAY,yFAAyF;AACrG,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE;AACrC,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,4EAA4E;AACxF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE;AAClC,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,4EAA4E;AACxF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE;AAClC,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,oDAAoD,CAAC;AACjF,QAAQ,wBAAwB,EAAE;AAClC,YAAY,gDAAgD;AAC5D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;AACnD,SAAS;AACT,QAAQ,cAAc,EAAE,CAAC,mDAAmD,CAAC;AAC7E,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,+BAA+B,EAAE;AACzC,YAAY,6EAA6E;AACzF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,kBAAkB,EAAE,CAAC,2CAA2C,CAAC;AACzE,QAAQ,eAAe,EAAE,CAAC,iCAAiC,CAAC;AAC5D,QAAQ,gBAAgB,EAAE,CAAC,wCAAwC,CAAC;AACpE,QAAQ,sBAAsB,EAAE;AAChC,YAAY,iEAAiE;AAC7E,SAAS;AACT,QAAQ,mBAAmB,EAAE,CAAC,uCAAuC,CAAC;AACtE,QAAQ,0BAA0B,EAAE,CAAC,kBAAkB,CAAC;AACxD,QAAQ,UAAU,EAAE,CAAC,kCAAkC,CAAC;AACxD,QAAQ,WAAW,EAAE,CAAC,wBAAwB,CAAC;AAC/C,QAAQ,0BAA0B,EAAE,CAAC,2CAA2C,CAAC;AACjF,QAAQ,eAAe,EAAE;AACzB,YAAY,kCAAkC;AAC9C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE;AACvD,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,qCAAqC,CAAC;AAC9D,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,uDAAuD;AACnE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE;AACrD,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,kCAAkC,CAAC;AAC3D,QAAQ,iBAAiB,EAAE,CAAC,qDAAqD,CAAC;AAClF,QAAQ,MAAM,EAAE,CAAC,8BAA8B,CAAC;AAChD,QAAQ,wBAAwB,EAAE;AAClC,YAAY,wEAAwE;AACpF,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,0EAA0E;AACtF,SAAS;AACT,QAAQ,sBAAsB,EAAE;AAChC,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,mBAAmB,EAAE,CAAC,oDAAoD,CAAC;AACnF,QAAQ,+BAA+B,EAAE;AACzC,YAAY,+EAA+E;AAC3F,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,eAAe,EAAE,CAAC,4CAA4C,CAAC;AACvE,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,UAAU,EAAE,CAAC,8CAA8C,CAAC;AACpE,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,oCAAoC;AAChD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE;AACvD,SAAS;AACT,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,yFAAyF;AACrG,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,oDAAoD,CAAC;AAC7E,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,8CAA8C,CAAC;AACvE,QAAQ,6BAA6B,EAAE;AACvC,YAAY,uDAAuD;AACnE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;AACnD,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,mDAAmD;AAC/D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;AACnD,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,yCAAyC;AACrD,YAAY,EAAE;AACd,YAAY,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,wBAAwB,CAAC,EAAE;AAC5D,SAAS;AACT,QAAQ,sBAAsB,EAAE,CAAC,yCAAyC,CAAC;AAC3E,QAAQ,sBAAsB,EAAE,CAAC,yCAAyC,CAAC;AAC3E,QAAQ,4BAA4B,EAAE;AACtC,YAAY,oDAAoD;AAChE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;AACnD,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,gDAAgD;AAC5D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;AACnD,SAAS;AACT,QAAQ,GAAG,EAAE,CAAC,2BAA2B,CAAC;AAC1C,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,qEAAqE;AACjF,SAAS;AACT,QAAQ,wBAAwB,EAAE;AAClC,YAAY,uEAAuE;AACnF,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,wFAAwF;AACpG,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,kCAAkC;AAC9C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,kCAAkC,EAAE;AAC5C,YAAY,0EAA0E;AACtF,SAAS;AACT,QAAQ,SAAS,EAAE,CAAC,6CAA6C,CAAC;AAClE,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,SAAS,EAAE,CAAC,0CAA0C,CAAC;AAC/D,QAAQ,qBAAqB,EAAE,CAAC,gDAAgD,CAAC;AACjF,QAAQ,8BAA8B,EAAE;AACxC,YAAY,+DAA+D;AAC3E,SAAS;AACT,QAAQ,uBAAuB,EAAE,CAAC,gDAAgD,CAAC;AACnF,QAAQ,SAAS,EAAE,CAAC,yCAAyC,CAAC;AAC9D,QAAQ,sBAAsB,EAAE,CAAC,iDAAiD,CAAC;AACnF,QAAQ,gBAAgB,EAAE,CAAC,iDAAiD,CAAC;AAC7E,QAAQ,4BAA4B,EAAE;AACtC,YAAY,4EAA4E;AACxF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,0BAA0B,EAAE,CAAC,6CAA6C,CAAC;AACnF,QAAQ,UAAU,EAAE,CAAC,2CAA2C,CAAC;AACjE,QAAQ,oBAAoB,EAAE,CAAC,8CAA8C,CAAC;AAC9E,QAAQ,YAAY,EAAE,CAAC,yCAAyC,CAAC;AACjE,QAAQ,aAAa,EAAE,CAAC,uDAAuD,CAAC;AAChF,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,4EAA4E;AACxF,SAAS;AACT,QAAQ,mBAAmB,EAAE,CAAC,+CAA+C,CAAC;AAC9E,QAAQ,gBAAgB,EAAE,CAAC,2CAA2C,CAAC;AACvE,QAAQ,QAAQ,EAAE,CAAC,iCAAiC,CAAC;AACrD,QAAQ,aAAa,EAAE,CAAC,mDAAmD,CAAC;AAC5E,QAAQ,qBAAqB,EAAE,CAAC,+CAA+C,CAAC;AAChF,QAAQ,8BAA8B,EAAE;AACxC,YAAY,sFAAsF;AAClG,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,4CAA4C,CAAC;AACzE,QAAQ,SAAS,EAAE,CAAC,kCAAkC,CAAC;AACvD,QAAQ,UAAU,EAAE,CAAC,iDAAiD,CAAC;AACvE,QAAQ,eAAe,EAAE,CAAC,sDAAsD,CAAC;AACjF,QAAQ,eAAe,EAAE,CAAC,+CAA+C,CAAC;AAC1E,QAAQ,yBAAyB,EAAE;AACnC,YAAY,+EAA+E;AAC3F,SAAS;AACT,QAAQ,mCAAmC,EAAE;AAC7C,YAAY,2EAA2E;AACvF,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,iDAAiD,CAAC;AACxE,QAAQ,eAAe,EAAE,CAAC,qDAAqD,CAAC;AAChF,QAAQ,mCAAmC,EAAE;AAC7C,YAAY,2EAA2E;AACvF,SAAS;AACT,QAAQ,QAAQ,EAAE,CAAC,yCAAyC,CAAC;AAC7D,QAAQ,UAAU,EAAE,CAAC,2CAA2C,CAAC;AACjE,QAAQ,uBAAuB,EAAE;AACjC,YAAY,kDAAkD;AAC9D,SAAS;AACT,QAAQ,YAAY,EAAE,CAAC,oCAAoC,CAAC;AAC5D,QAAQ,yBAAyB,EAAE;AACnC,YAAY,oEAAoE;AAChF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,yCAAyC,CAAC;AACtE,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,yBAAyB,EAAE,CAAC,oCAAoC,CAAC;AACzE,QAAQ,wBAAwB,EAAE;AAClC,YAAY,kDAAkD;AAC9D,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,mCAAmC,CAAC;AAC1D,QAAQ,gBAAgB,EAAE,CAAC,wCAAwC,CAAC;AACpE,QAAQ,cAAc,EAAE,CAAC,gCAAgC,CAAC;AAC1D,QAAQ,sBAAsB,EAAE;AAChC,YAAY,gEAAgE;AAC5E,SAAS;AACT,QAAQ,eAAe,EAAE,CAAC,uCAAuC,CAAC;AAClE,QAAQ,wBAAwB,EAAE,CAAC,iBAAiB,CAAC;AACrD,QAAQ,UAAU,EAAE,CAAC,uBAAuB,CAAC;AAC7C,QAAQ,WAAW,EAAE,CAAC,6BAA6B,CAAC;AACpD,QAAQ,SAAS,EAAE,CAAC,iCAAiC,CAAC;AACtD,QAAQ,eAAe,EAAE,CAAC,uCAAuC,CAAC;AAClE,QAAQ,mCAAmC,EAAE,CAAC,kCAAkC,CAAC;AACjF,QAAQ,aAAa,EAAE,CAAC,qCAAqC,CAAC;AAC9D,QAAQ,eAAe,EAAE,CAAC,wCAAwC,CAAC;AACnE,QAAQ,UAAU,EAAE,CAAC,mBAAmB,CAAC;AACzC,QAAQ,oCAAoC,EAAE;AAC9C,YAAY,sDAAsD;AAClE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,iBAAiB,EAAE;AAC3B,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,YAAY,EAAE,CAAC,oCAAoC,CAAC;AAC5D,QAAQ,QAAQ,EAAE,CAAC,gCAAgC,CAAC;AACpD,QAAQ,SAAS,EAAE,CAAC,iCAAiC,CAAC;AACtD,QAAQ,YAAY,EAAE,CAAC,iCAAiC,CAAC;AACzD,QAAQ,KAAK,EAAE,CAAC,mCAAmC,CAAC;AACpD,QAAQ,WAAW,EAAE,CAAC,kDAAkD,CAAC;AACzE,QAAQ,2BAA2B,EAAE;AACrC,YAAY,6EAA6E;AACzF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE;AACjC,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,uDAAuD;AACnE,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,2FAA2F;AACvG,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE;AACrC,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,kFAAkF;AAC9F,SAAS;AACT,QAAQ,4BAA4B,EAAE;AACtC,YAAY,8EAA8E;AAC1F,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE;AAClC,SAAS;AACT,QAAQ,4BAA4B,EAAE;AACtC,YAAY,8EAA8E;AAC1F,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE;AAClC,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,kCAAkC;AAC9C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,yCAAyC,CAAC;AACtE,QAAQ,wBAAwB,EAAE;AAClC,YAAY,wEAAwE;AACpF,SAAS;AACT,QAAQ,wBAAwB,EAAE;AAClC,YAAY,0EAA0E;AACtF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE;AACjC,SAAS;AACT,QAAQ,sBAAsB,EAAE;AAChC,YAAY,wFAAwF;AACpG,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE;AACrC,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,2EAA2E;AACvF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE;AAClC,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,2EAA2E;AACvF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE;AAClC,SAAS;AACT,QAAQ,eAAe,EAAE,CAAC,kDAAkD,CAAC;AAC7E,QAAQ,QAAQ,EAAE,CAAC,qCAAqC,CAAC;AACzD,QAAQ,MAAM,EAAE,CAAC,6BAA6B,CAAC;AAC/C,QAAQ,sBAAsB,EAAE;AAChC,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,mBAAmB,EAAE,CAAC,mDAAmD,CAAC;AAClF,QAAQ,+BAA+B,EAAE,CAAC,iCAAiC,CAAC;AAC5E,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,wFAAwF;AACpG,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,mDAAmD,CAAC;AAC5E,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,iFAAiF;AAC7F,YAAY,EAAE;AACd,YAAY,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,6BAA6B,CAAC,EAAE;AACjE,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,iFAAiF;AAC7F,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,6CAA6C,CAAC;AACtE,QAAQ,0BAA0B,EAAE;AACpC,YAAY,oDAAoD;AAChE,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,sEAAsE;AAClF,YAAY,EAAE,OAAO,EAAE,4BAA4B,EAAE;AACrD,SAAS;AACT,KAAK;AACL,IAAI,MAAM,EAAE;AACZ,QAAQ,IAAI,EAAE,CAAC,kBAAkB,CAAC;AAClC,QAAQ,OAAO,EAAE,CAAC,qBAAqB,EAAE,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;AAChF,QAAQ,qBAAqB,EAAE,CAAC,oBAAoB,CAAC;AACrD,QAAQ,MAAM,EAAE,CAAC,oBAAoB,CAAC;AACtC,QAAQ,KAAK,EAAE,CAAC,0BAA0B,CAAC;AAC3C,QAAQ,MAAM,EAAE,CAAC,oBAAoB,EAAE,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;AAC9E,QAAQ,KAAK,EAAE,CAAC,mBAAmB,CAAC;AACpC,KAAK;AACL,IAAI,cAAc,EAAE;AACpB,QAAQ,QAAQ,EAAE;AAClB,YAAY,iEAAiE;AAC7E,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,kDAAkD,CAAC;AAC/E,QAAQ,WAAW,EAAE;AACrB,YAAY,mEAAmE;AAC/E,SAAS;AACT,KAAK;AACL,IAAI,KAAK,EAAE;AACX,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,kCAAkC,EAAE;AAC5C,YAAY,yDAAyD;AACrE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,+BAA+B,EAAE;AACzC,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,+BAA+B,EAAE;AACzC,YAAY,yDAAyD;AACrE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,4BAA4B,EAAE;AACtC,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,MAAM,EAAE,CAAC,wBAAwB,CAAC;AAC1C,QAAQ,4BAA4B,EAAE;AACtC,YAAY,6EAA6E;AACzF,SAAS;AACT,QAAQ,qBAAqB,EAAE,CAAC,gDAAgD,CAAC;AACjF,QAAQ,4BAA4B,EAAE;AACtC,YAAY,gGAAgG;AAC5G,SAAS;AACT,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,sEAAsE;AAClF,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,sCAAsC,CAAC;AAC7D,QAAQ,SAAS,EAAE,CAAC,mCAAmC,CAAC;AACxD,QAAQ,yBAAyB,EAAE;AACnC,YAAY,6FAA6F;AACzG,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,mEAAmE;AAC/E,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,IAAI,EAAE,CAAC,uBAAuB,CAAC;AACvC,QAAQ,cAAc,EAAE,CAAC,yCAAyC,CAAC;AACnE,QAAQ,2BAA2B,EAAE;AACrC,YAAY,4EAA4E;AACxF,SAAS;AACT,QAAQ,oBAAoB,EAAE,CAAC,+CAA+C,CAAC;AAC/E,QAAQ,wBAAwB,EAAE,CAAC,iBAAiB,CAAC;AACrD,QAAQ,gBAAgB,EAAE,CAAC,2CAA2C,CAAC;AACvE,QAAQ,2BAA2B,EAAE;AACrC,YAAY,+CAA+C;AAC3D,SAAS;AACT,QAAQ,iBAAiB,EAAE;AAC3B,YAAY,4CAA4C;AACxD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,cAAc,EAAE,CAAC,yCAAyC,CAAC;AACnE,QAAQ,4BAA4B,EAAE;AACtC,YAAY,6DAA6D;AACzE,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,4DAA4D;AACxE,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,4BAA4B,EAAE;AACtC,YAAY,+FAA+F;AAC3G,SAAS;AACT,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,qEAAqE;AACjF,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,qCAAqC,CAAC;AAC5D,KAAK;AACL,IAAI,KAAK,EAAE;AACX,QAAQ,wBAAwB,EAAE,CAAC,mBAAmB,CAAC;AACvD,QAAQ,KAAK,EAAE,CAAC,6BAA6B,CAAC;AAC9C,QAAQ,YAAY,EAAE,CAAC,6BAA6B,CAAC;AACrD,QAAQ,qBAAqB,EAAE,CAAC,+CAA+C,CAAC;AAChF,QAAQ,oCAAoC,EAAE,CAAC,gCAAgC,CAAC;AAChF,QAAQ,4BAA4B,EAAE,CAAC,qBAAqB,CAAC;AAC7D,QAAQ,kCAAkC,EAAE,CAAC,iBAAiB,CAAC;AAC/D,QAAQ,2BAA2B,EAAE,CAAC,qBAAqB,CAAC;AAC5D,QAAQ,4BAA4B,EAAE,CAAC,oCAAoC,CAAC;AAC5E,QAAQ,kCAAkC,EAAE,CAAC,4BAA4B,CAAC;AAC1E,QAAQ,MAAM,EAAE,CAAC,gCAAgC,CAAC;AAClD,QAAQ,gBAAgB,EAAE,CAAC,WAAW,CAAC;AACvC,QAAQ,aAAa,EAAE,CAAC,uBAAuB,CAAC;AAChD,QAAQ,iBAAiB,EAAE,CAAC,iCAAiC,CAAC;AAC9D,QAAQ,yBAAyB,EAAE,CAAC,iCAAiC,CAAC;AACtE,QAAQ,+BAA+B,EAAE,CAAC,yBAAyB,CAAC;AACpE,QAAQ,IAAI,EAAE,CAAC,YAAY,CAAC;AAC5B,QAAQ,0BAA0B,EAAE,CAAC,kBAAkB,CAAC;AACxD,QAAQ,0BAA0B,EAAE,CAAC,kBAAkB,CAAC;AACxD,QAAQ,2BAA2B,EAAE,CAAC,qBAAqB,CAAC;AAC5D,QAAQ,iCAAiC,EAAE,CAAC,qBAAqB,CAAC;AAClE,QAAQ,oBAAoB,EAAE,CAAC,iCAAiC,CAAC;AACjE,QAAQ,oBAAoB,EAAE,CAAC,iCAAiC,CAAC;AACjE,QAAQ,2BAA2B,EAAE,CAAC,oBAAoB,CAAC;AAC3D,QAAQ,kBAAkB,EAAE,CAAC,gCAAgC,CAAC;AAC9D,QAAQ,gCAAgC,EAAE,CAAC,yBAAyB,CAAC;AACrE,QAAQ,qBAAqB,EAAE,CAAC,4BAA4B,CAAC;AAC7D,QAAQ,iCAAiC,EAAE,CAAC,gBAAgB,CAAC;AAC7D,QAAQ,yCAAyC,EAAE,CAAC,8BAA8B,CAAC;AACnF,QAAQ,OAAO,EAAE,CAAC,gCAAgC,CAAC;AACnD,QAAQ,QAAQ,EAAE,CAAC,mCAAmC,CAAC;AACvD,QAAQ,mBAAmB,EAAE,CAAC,aAAa,CAAC;AAC5C,KAAK;AACL,CAAC;;ACxvCM,MAAM,OAAO,GAAG,mBAAmB,CAAC;;ACApC,SAAS,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE;AAC1D,IAAI,MAAM,UAAU,GAAG,EAAE,CAAC;AAC1B,IAAI,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;AACnE,QAAQ,KAAK,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;AACxE,YAAY,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAC;AAC5D,YAAY,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACnD,YAAY,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC;AAC9E,YAAY,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;AACpC,gBAAgB,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;AACvC,aAAa;AACb,YAAY,MAAM,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;AACnD,YAAY,IAAI,WAAW,EAAE;AAC7B,gBAAgB,YAAY,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,CAAC,CAAC;AAC/G,gBAAgB,SAAS;AACzB,aAAa;AACb,YAAY,YAAY,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;AAClF,SAAS;AACT,KAAK;AACL,IAAI,OAAO,UAAU,CAAC;AACtB,CAAC;AACD,SAAS,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE;AACrE,IAAI,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACnE;AACA,IAAI,SAAS,eAAe,CAAC,GAAG,IAAI,EAAE;AACtC;AACA,QAAQ,IAAI,OAAO,GAAG,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;AAClE;AACA,QAAQ,IAAI,WAAW,CAAC,SAAS,EAAE;AACnC,YAAY,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE;AACjD,gBAAgB,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC;AACpD,gBAAgB,CAAC,WAAW,CAAC,SAAS,GAAG,SAAS;AAClD,aAAa,CAAC,CAAC;AACf,YAAY,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC;AAChD,SAAS;AACT,QAAQ,IAAI,WAAW,CAAC,OAAO,EAAE;AACjC,YAAY,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC;AAClE,YAAY,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,+BAA+B,EAAE,QAAQ,CAAC,CAAC,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;AAC5H,SAAS;AACT,QAAQ,IAAI,WAAW,CAAC,UAAU,EAAE;AACpC,YAAY,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AACrD,SAAS;AACT,QAAQ,IAAI,WAAW,CAAC,iBAAiB,EAAE;AAC3C;AACA,YAAY,MAAM,OAAO,GAAG,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;AACxE,YAAY,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,iBAAiB,CAAC,EAAE;AACvF,gBAAgB,IAAI,IAAI,IAAI,OAAO,EAAE;AACrC,oBAAoB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;AACzI,oBAAoB,IAAI,EAAE,KAAK,IAAI,OAAO,CAAC,EAAE;AAC7C,wBAAwB,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AACvD,qBAAqB;AACrB,oBAAoB,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;AACzC,iBAAiB;AACjB,aAAa;AACb,YAAY,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC;AAChD,SAAS;AACT;AACA,QAAQ,OAAO,mBAAmB,CAAC,GAAG,IAAI,CAAC,CAAC;AAC5C,KAAK;AACL,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;AAC/D,CAAC;;ACxDD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,AAAO,SAAS,mBAAmB,CAAC,OAAO,EAAE;AAC7C,IAAI,OAAO,kBAAkB,CAAC,OAAO,EAAEA,SAAS,CAAC,CAAC;AAClD,CAAC;AACD,mBAAmB,CAAC,OAAO,GAAG,OAAO,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/package.json b/node_modules/@octokit/plugin-rest-endpoint-methods/package.json new file mode 100644 index 0000000..3763d8f --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/package.json @@ -0,0 +1,96 @@ +{ + "_args": [ + [ + "@octokit/plugin-rest-endpoint-methods@4.5.2", + "." + ] + ], + "_from": "@octokit/plugin-rest-endpoint-methods@4.5.2", + "_id": "@octokit/plugin-rest-endpoint-methods@4.5.2", + "_inBundle": false, + "_integrity": "sha512-JXoDIh+QnzFb6C5ZqIcUzDkn1fLrxawi98ZbvYb9s7Z2CJLITUWpbTAxSgseczEho18pYhamEBRR/h3o3HIXJQ==", + "_location": "/@octokit/plugin-rest-endpoint-methods", + "_phantomChildren": {}, + "_requested": { + "type": "version", + "registry": true, + "raw": "@octokit/plugin-rest-endpoint-methods@4.5.2", + "name": "@octokit/plugin-rest-endpoint-methods", + "escapedName": "@octokit%2fplugin-rest-endpoint-methods", + "scope": "@octokit", + "rawSpec": "4.5.2", + "saveSpec": null, + "fetchSpec": "4.5.2" + }, + "_requiredBy": [ + "/@actions/github" + ], + "_resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-4.5.2.tgz", + "_spec": "4.5.2", + "_where": ".", + "bugs": { + "url": "https://github.com/octokit/plugin-rest-endpoint-methods.js/issues" + }, + "dependencies": { + "@octokit/types": "^6.3.2", + "deprecation": "^2.3.1" + }, + "description": "Octokit plugin adding one method for all of api.github.com REST API endpoints", + "devDependencies": { + "@gimenete/type-writer": "^0.1.5", + "@octokit/core": "^3.0.0", + "@octokit/graphql": "^4.3.1", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/fetch-mock": "^7.3.1", + "@types/jest": "^26.0.0", + "@types/node": "^14.0.4", + "fetch-mock": "^9.0.0", + "fs-extra": "^9.0.0", + "jest": "^26.1.0", + "lodash.camelcase": "^4.3.0", + "lodash.set": "^4.3.2", + "lodash.upperfirst": "^4.3.1", + "mustache": "^4.0.0", + "npm-run-all": "^4.1.5", + "prettier": "^2.0.1", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "sort-keys": "^4.0.0", + "string-to-jsdoc-comment": "^1.0.0", + "ts-jest": "^26.1.3", + "typescript": "^4.0.2" + }, + "files": [ + "dist-*/", + "bin/" + ], + "homepage": "https://github.com/octokit/plugin-rest-endpoint-methods.js#readme", + "keywords": [ + "github", + "api", + "sdk", + "toolkit" + ], + "license": "MIT", + "main": "dist-node/index.js", + "module": "dist-web/index.js", + "name": "@octokit/plugin-rest-endpoint-methods", + "peerDependencies": { + "@octokit/core": ">=3" + }, + "pika": true, + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/octokit/plugin-rest-endpoint-methods.js.git" + }, + "sideEffects": false, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "version": "4.5.2" +} diff --git a/node_modules/@octokit/request-error/README.md b/node_modules/@octokit/request-error/README.md index bcb711d..c939cda 100644 --- a/node_modules/@octokit/request-error/README.md +++ b/node_modules/@octokit/request-error/README.md @@ -3,8 +3,7 @@ > Error class for Octokit request errors [![@latest](https://img.shields.io/npm/v/@octokit/request-error.svg)](https://www.npmjs.com/package/@octokit/request-error) -[![Build Status](https://travis-ci.com/octokit/request-error.js.svg?branch=master)](https://travis-ci.com/octokit/request-error.js) -[![Greenkeeper](https://badges.greenkeeper.io/octokit/request-error.js.svg)](https://greenkeeper.io/) +[![Build Status](https://github.com/octokit/request-error.js/workflows/Test/badge.svg)](https://github.com/octokit/request-error.js/actions?query=workflow%3ATest) ## Usage @@ -13,11 +12,11 @@ Browsers -Load @octokit/request-error directly from cdn.pika.dev +Load @octokit/request-error directly from cdn.skypack.dev ```html ``` @@ -40,18 +39,18 @@ const { RequestError } = require("@octokit/request-error"); ```js const error = new RequestError("Oops", 500, { headers: { - "x-github-request-id": "1:2:3:4" + "x-github-request-id": "1:2:3:4", }, // response headers request: { method: "POST", url: "https://api.github.com/foo", body: { - bar: "baz" + bar: "baz", }, headers: { - authorization: "token secret123" - } - } + authorization: "token secret123", + }, + }, }); error.message; // Oops diff --git a/node_modules/@octokit/request-error/dist-node/index.js.map b/node_modules/@octokit/request-error/dist-node/index.js.map index ec1c6db..2562006 100644 --- a/node_modules/@octokit/request-error/dist-node/index.js.map +++ b/node_modules/@octokit/request-error/dist-node/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n }\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\")\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":["logOnce","once","deprecation","console","warn","RequestError","Error","constructor","message","statusCode","options","captureStackTrace","name","status","Object","defineProperty","get","Deprecation","headers","requestCopy","assign","request","authorization","replace","url"],"mappings":";;;;;;;;;AAEA,MAAMA,OAAO,GAAGC,IAAI,CAAEC,WAAD,IAAiBC,OAAO,CAACC,IAAR,CAAaF,WAAb,CAAlB,CAApB;;;;;AAIA,AAAO,MAAMG,YAAN,SAA2BC,KAA3B,CAAiC;EACpCC,WAAW,CAACC,OAAD,EAAUC,UAAV,EAAsBC,OAAtB,EAA+B;UAChCF,OAAN,EADsC;;;;QAIlCF,KAAK,CAACK,iBAAV,EAA6B;MACzBL,KAAK,CAACK,iBAAN,CAAwB,IAAxB,EAA8B,KAAKJ,WAAnC;;;SAECK,IAAL,GAAY,WAAZ;SACKC,MAAL,GAAcJ,UAAd;IACAK,MAAM,CAACC,cAAP,CAAsB,IAAtB,EAA4B,MAA5B,EAAoC;MAChCC,GAAG,GAAG;QACFhB,OAAO,CAAC,IAAIiB,uBAAJ,CAAgB,0EAAhB,CAAD,CAAP;eACOR,UAAP;;;KAHR;SAMKS,OAAL,GAAeR,OAAO,CAACQ,OAAR,IAAmB,EAAlC,CAfsC;;UAiBhCC,WAAW,GAAGL,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAA1B,CAApB;;QACIX,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAA5B,EAA2C;MACvCH,WAAW,CAACD,OAAZ,GAAsBJ,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAAR,CAAgBH,OAAlC,EAA2C;QAC7DI,aAAa,EAAEZ,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAAxB,CAAsCC,OAAtC,CAA8C,MAA9C,EAAsD,aAAtD;OADG,CAAtB;;;IAIJJ,WAAW,CAACK,GAAZ,GAAkBL,WAAW,CAACK,GAAZ;;KAGbD,OAHa,CAGL,sBAHK,EAGmB,0BAHnB;;KAMbA,OANa,CAML,qBANK,EAMkB,yBANlB,CAAlB;SAOKF,OAAL,GAAeF,WAAf;;;;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n },\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\"),\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":["logOnce","once","deprecation","console","warn","RequestError","Error","constructor","message","statusCode","options","captureStackTrace","name","status","Object","defineProperty","get","Deprecation","headers","requestCopy","assign","request","authorization","replace","url"],"mappings":";;;;;;;;;AAEA,MAAMA,OAAO,GAAGC,IAAI,CAAEC,WAAD,IAAiBC,OAAO,CAACC,IAAR,CAAaF,WAAb,CAAlB,CAApB;AACA;;;;AAGO,MAAMG,YAAN,SAA2BC,KAA3B,CAAiC;AACpCC,EAAAA,WAAW,CAACC,OAAD,EAAUC,UAAV,EAAsBC,OAAtB,EAA+B;AACtC,UAAMF,OAAN,EADsC;;AAGtC;;AACA,QAAIF,KAAK,CAACK,iBAAV,EAA6B;AACzBL,MAAAA,KAAK,CAACK,iBAAN,CAAwB,IAAxB,EAA8B,KAAKJ,WAAnC;AACH;;AACD,SAAKK,IAAL,GAAY,WAAZ;AACA,SAAKC,MAAL,GAAcJ,UAAd;AACAK,IAAAA,MAAM,CAACC,cAAP,CAAsB,IAAtB,EAA4B,MAA5B,EAAoC;AAChCC,MAAAA,GAAG,GAAG;AACFhB,QAAAA,OAAO,CAAC,IAAIiB,uBAAJ,CAAgB,0EAAhB,CAAD,CAAP;AACA,eAAOR,UAAP;AACH;;AAJ+B,KAApC;AAMA,SAAKS,OAAL,GAAeR,OAAO,CAACQ,OAAR,IAAmB,EAAlC,CAfsC;;AAiBtC,UAAMC,WAAW,GAAGL,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAA1B,CAApB;;AACA,QAAIX,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAA5B,EAA2C;AACvCH,MAAAA,WAAW,CAACD,OAAZ,GAAsBJ,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAAR,CAAgBH,OAAlC,EAA2C;AAC7DI,QAAAA,aAAa,EAAEZ,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAAxB,CAAsCC,OAAtC,CAA8C,MAA9C,EAAsD,aAAtD;AAD8C,OAA3C,CAAtB;AAGH;;AACDJ,IAAAA,WAAW,CAACK,GAAZ,GAAkBL,WAAW,CAACK,GAAZ;AAEd;AAFc,KAGbD,OAHa,CAGL,sBAHK,EAGmB,0BAHnB;AAKd;AALc,KAMbA,OANa,CAML,qBANK,EAMkB,yBANlB,CAAlB;AAOA,SAAKF,OAAL,GAAeF,WAAf;AACH;;AAhCmC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request-error/dist-src/index.js b/node_modules/@octokit/request-error/dist-src/index.js index cfcb7c4..c880b45 100644 --- a/node_modules/@octokit/request-error/dist-src/index.js +++ b/node_modules/@octokit/request-error/dist-src/index.js @@ -18,14 +18,14 @@ export class RequestError extends Error { get() { logOnce(new Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); return statusCode; - } + }, }); this.headers = options.headers || {}; // redact request credentials without mutating original request options const requestCopy = Object.assign({}, options.request); if (options.request.headers.authorization) { requestCopy.headers = Object.assign({}, options.request.headers, { - authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]") + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]"), }); } requestCopy.url = requestCopy.url diff --git a/node_modules/@octokit/request-error/dist-web/index.js b/node_modules/@octokit/request-error/dist-web/index.js index 32b45a3..feec58e 100644 --- a/node_modules/@octokit/request-error/dist-web/index.js +++ b/node_modules/@octokit/request-error/dist-web/index.js @@ -19,14 +19,14 @@ class RequestError extends Error { get() { logOnce(new Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); return statusCode; - } + }, }); this.headers = options.headers || {}; // redact request credentials without mutating original request options const requestCopy = Object.assign({}, options.request); if (options.request.headers.authorization) { requestCopy.headers = Object.assign({}, options.request.headers, { - authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]") + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]"), }); } requestCopy.url = requestCopy.url diff --git a/node_modules/@octokit/request-error/dist-web/index.js.map b/node_modules/@octokit/request-error/dist-web/index.js.map index 05151b0..130740d 100644 --- a/node_modules/@octokit/request-error/dist-web/index.js.map +++ b/node_modules/@octokit/request-error/dist-web/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n }\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\")\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":[],"mappings":";;;AAEA,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;;;;AAIjE,AAAO,MAAM,YAAY,SAAS,KAAK,CAAC;IACpC,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE;QACtC,KAAK,CAAC,OAAO,CAAC,CAAC;;;QAGf,IAAI,KAAK,CAAC,iBAAiB,EAAE;YACzB,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;SACnD;QACD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;QACzB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE;YAChC,GAAG,GAAG;gBACF,OAAO,CAAC,IAAI,WAAW,CAAC,0EAA0E,CAAC,CAAC,CAAC;gBACrG,OAAO,UAAU,CAAC;aACrB;SACJ,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;;QAErC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE;YACvC,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE;gBAC7D,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC;aACtF,CAAC,CAAC;SACN;QACD,WAAW,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG;;;aAG5B,OAAO,CAAC,sBAAsB,EAAE,0BAA0B,CAAC;;;aAG3D,OAAO,CAAC,qBAAqB,EAAE,yBAAyB,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC;KAC9B;CACJ;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n },\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\"),\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":[],"mappings":";;;AAEA,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;AACjE;AACA;AACA;AACO,MAAM,YAAY,SAAS,KAAK,CAAC;AACxC,IAAI,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE;AAC9C,QAAQ,KAAK,CAAC,OAAO,CAAC,CAAC;AACvB;AACA;AACA,QAAQ,IAAI,KAAK,CAAC,iBAAiB,EAAE;AACrC,YAAY,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;AAC5D,SAAS;AACT,QAAQ,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;AAChC,QAAQ,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;AACjC,QAAQ,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE;AAC5C,YAAY,GAAG,GAAG;AAClB,gBAAgB,OAAO,CAAC,IAAI,WAAW,CAAC,0EAA0E,CAAC,CAAC,CAAC;AACrH,gBAAgB,OAAO,UAAU,CAAC;AAClC,aAAa;AACb,SAAS,CAAC,CAAC;AACX,QAAQ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;AAC7C;AACA,QAAQ,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AAC/D,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE;AACnD,YAAY,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE;AAC7E,gBAAgB,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC;AACnG,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,WAAW,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG;AACzC;AACA;AACA,aAAa,OAAO,CAAC,sBAAsB,EAAE,0BAA0B,CAAC;AACxE;AACA;AACA,aAAa,OAAO,CAAC,qBAAqB,EAAE,yBAAyB,CAAC,CAAC;AACvE,QAAQ,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC;AACnC,KAAK;AACL;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request-error/package.json b/node_modules/@octokit/request-error/package.json index 96e9055..bc4019f 100644 --- a/node_modules/@octokit/request-error/package.json +++ b/node_modules/@octokit/request-error/package.json @@ -1,55 +1,56 @@ { - "_from": "@octokit/request-error@^1.0.1", - "_id": "@octokit/request-error@1.2.0", + "_args": [ + [ + "@octokit/request-error@2.0.4", + "." + ] + ], + "_from": "@octokit/request-error@2.0.4", + "_id": "@octokit/request-error@2.0.4", "_inBundle": false, - "_integrity": "sha512-DNBhROBYjjV/I9n7A8kVkmQNkqFAMem90dSxqvPq57e2hBr7mNTX98y3R2zDpqMQHVRpBDjsvsfIGgBzy+4PAg==", + "_integrity": "sha512-LjkSiTbsxIErBiRh5wSZvpZqT4t0/c9+4dOe0PII+6jXR+oj/h66s7E4a/MghV7iT8W9ffoQ5Skoxzs96+gBPA==", "_location": "/@octokit/request-error", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "@octokit/request-error@^1.0.1", + "raw": "@octokit/request-error@2.0.4", "name": "@octokit/request-error", "escapedName": "@octokit%2frequest-error", "scope": "@octokit", - "rawSpec": "^1.0.1", + "rawSpec": "2.0.4", "saveSpec": null, - "fetchSpec": "^1.0.1" + "fetchSpec": "2.0.4" }, "_requiredBy": [ - "/@octokit/request", - "/@octokit/rest" + "/@octokit/request" ], - "_resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-1.2.0.tgz", - "_shasum": "a64d2a9d7a13555570cd79722de4a4d76371baaa", - "_spec": "@octokit/request-error@^1.0.1", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/request", + "_resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.4.tgz", + "_spec": "2.0.4", + "_where": ".", "bugs": { "url": "https://github.com/octokit/request-error.js/issues" }, - "bundleDependencies": false, - "deno": "dist-web/index.js", "dependencies": { - "@octokit/types": "^2.0.0", + "@octokit/types": "^6.0.0", "deprecation": "^2.0.0", "once": "^1.4.0" }, - "deprecated": false, "description": "Error class for Octokit request errors", "devDependencies": { "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.7.0", - "@pika/plugin-build-web": "^0.7.0", - "@pika/plugin-bundle-web": "^0.7.0", - "@pika/plugin-ts-standard-pkg": "^0.7.0", - "@types/jest": "^24.0.12", - "@types/node": "^12.0.2", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-bundle-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/jest": "^26.0.0", + "@types/node": "^14.0.4", "@types/once": "^1.4.0", - "jest": "^24.7.1", + "jest": "^25.1.0", "pika-plugin-unpkg-field": "^1.1.0", - "prettier": "^1.17.0", - "semantic-release": "^15.10.5", - "ts-jest": "^24.0.2", + "prettier": "^2.0.1", + "semantic-release": "^17.0.0", + "ts-jest": "^25.1.0", "typescript": "^3.4.5" }, "files": [ @@ -65,6 +66,7 @@ ], "license": "MIT", "main": "dist-node/index.js", + "module": "dist-web/index.js", "name": "@octokit/request-error", "pika": true, "publishConfig": { @@ -77,5 +79,5 @@ "sideEffects": false, "source": "dist-src/index.js", "types": "dist-types/index.d.ts", - "version": "1.2.0" + "version": "2.0.4" } diff --git a/node_modules/@octokit/request/README.md b/node_modules/@octokit/request/README.md index db35e62..514eb6e 100644 --- a/node_modules/@octokit/request/README.md +++ b/node_modules/@octokit/request/README.md @@ -3,8 +3,7 @@ > Send parameterized requests to GitHub’s APIs with sensible defaults in browsers and Node [![@latest](https://img.shields.io/npm/v/@octokit/request.svg)](https://www.npmjs.com/package/@octokit/request) -[![Build Status](https://travis-ci.org/octokit/request.js.svg?branch=master)](https://travis-ci.org/octokit/request.js) -[![Greenkeeper](https://badges.greenkeeper.io/octokit/request.js.svg)](https://greenkeeper.io/) +[![Build Status](https://github.com/octokit/request.js/workflows/Test/badge.svg)](https://github.com/octokit/request.js/actions?query=workflow%3ATest+branch%3Amaster) `@octokit/request` is a request library for browsers & node that makes it easier to interact with [GitHub’s REST API](https://developer.github.com/v3/) and @@ -39,14 +38,14 @@ the passed options and sends the request using [fetch](https://developer.mozilla 🤩 1:1 mapping of REST API endpoint documentation, e.g. [Add labels to an issue](https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue) becomes ```js -request("POST /repos/:owner/:repo/issues/:number/labels", { +request("POST /repos/{owner}/{repo}/issues/{number}/labels", { mediaType: { - previews: ["symmetra"] + previews: ["symmetra"], }, owner: "octokit", repo: "request.js", number: 1, - labels: ["🐛 bug"] + labels: ["🐛 bug"], }); ``` @@ -71,11 +70,11 @@ request("POST /repos/:owner/:repo/issues/:number/labels", { Browsers -Load @octokit/request directly from cdn.pika.dev +Load @octokit/request directly from cdn.skypack.dev ```html ``` @@ -100,12 +99,12 @@ const { request } = require("@octokit/request"); ```js // Following GitHub docs formatting: // https://developer.github.com/v3/repos/#list-organization-repositories -const result = await request("GET /orgs/:org/repos", { +const result = await request("GET /orgs/{org}/repos", { headers: { - authorization: "token 0000000000000000000000000000000000000001" + authorization: "token 0000000000000000000000000000000000000001", }, org: "octokit", - type: "private" + type: "private", }); console.log(`${result.data.length} repos found.`); @@ -118,7 +117,7 @@ For GraphQL request we recommend using [`@octokit/graphql`](https://github.com/o ```js const result = await request("POST /graphql", { headers: { - authorization: "token 0000000000000000000000000000000000000001" + authorization: "token 0000000000000000000000000000000000000001", }, query: `query ($login: String!) { organization(login: $login) { @@ -128,8 +127,8 @@ const result = await request("POST /graphql", { } }`, variables: { - login: "octokit" - } + login: "octokit", + }, }); ``` @@ -140,12 +139,12 @@ Alternatively, pass in a method and a url ```js const result = await request({ method: "GET", - url: "/orgs/:org/repos", + url: "/orgs/{org}/repos", headers: { - authorization: "token 0000000000000000000000000000000000000001" + authorization: "token 0000000000000000000000000000000000000001", }, org: "octokit", - type: "private" + type: "private", }); ``` @@ -156,10 +155,10 @@ The simplest way to authenticate a request is to set the `Authorization` header ```js const requestWithAuth = request.defaults({ headers: { - authorization: "token 0000000000000000000000000000000000000001" - } + authorization: "token 0000000000000000000000000000000000000001", + }, }); -const result = await request("GET /user"); +const result = await requestWithAuth("GET /user"); ``` For more complex authentication strategies such as GitHub Apps or Basic, we recommend the according authentication library exported by [`@octokit/auth`](https://github.com/octokit/auth.js). @@ -167,25 +166,28 @@ For more complex authentication strategies such as GitHub Apps or Basic, we reco ```js const { createAppAuth } = require("@octokit/auth-app"); const auth = createAppAuth({ - id: process.env.APP_ID, + appId: process.env.APP_ID, privateKey: process.env.PRIVATE_KEY, - installationId: 123 + installationId: 123, }); const requestWithAuth = request.defaults({ request: { - hook: auth.hook + hook: auth.hook, }, mediaType: { - previews: ["machine-man"] - } + previews: ["machine-man"], + }, }); const { data: app } = await requestWithAuth("GET /app"); -const { data: app } = await requestWithAuth("POST /repos/:owner/:repo/issues", { - owner: "octocat", - repo: "hello-world", - title: "Hello from the engine room" -}); +const { data: app } = await requestWithAuth( + "POST /repos/{owner}/{repo}/issues", + { + owner: "octocat", + repo: "hello-world", + title: "Hello from the engine room", + } +); ``` ## request() @@ -216,7 +218,7 @@ const { data: app } = await requestWithAuth("POST /repos/:owner/:repo/issues", { String - If route is set it has to be a string consisting of the request method and URL, e.g. GET /orgs/:org + If route is set it has to be a string consisting of the request method and URL, e.g. GET /orgs/{org} @@ -284,7 +286,7 @@ const { data: app } = await requestWithAuth("POST /repos/:owner/:repo/issues", { Required. A path or full URL which may contain :variable or {variable} placeholders, - e.g. /orgs/:org/repos. The url is parsed using url-template. + e.g. /orgs/{org}/repos. The url is parsed using url-template. @@ -357,7 +359,7 @@ const { data: app } = await requestWithAuth("POST /repos/:owner/:repo/issues", { All other options except `options.request.*` will be passed depending on the `method` and `url` options. -1. If the option key is a placeholder in the `url`, it will be used as replacement. For example, if the passed options are `{url: '/orgs/:org/repos', org: 'foo'}` the returned `options.url` is `https://api.github.com/orgs/foo/repos` +1. If the option key is a placeholder in the `url`, it will be used as replacement. For example, if the passed options are `{url: '/orgs/{org}/repos', org: 'foo'}` the returned `options.url` is `https://api.github.com/orgs/foo/repos` 2. If the `method` is `GET` or `HEAD`, the option is passed as query parameter 3. Otherwise the parameter is passed in the request body as JSON key. @@ -416,13 +418,13 @@ const myrequest = require("@octokit/request").defaults({ baseUrl: "https://github-enterprise.acme-inc.com/api/v3", headers: { "user-agent": "myApp/1.2.3", - authorization: `token 0000000000000000000000000000000000000001` + authorization: `token 0000000000000000000000000000000000000001`, }, org: "my-project", - per_page: 100 + per_page: 100, }); -myrequest(`GET /orgs/:org/repos`); +myrequest(`GET /orgs/{org}/repos`); ``` You can call `.defaults()` again on the returned method, the defaults will cascade. @@ -431,14 +433,14 @@ You can call `.defaults()` again on the returned method, the defaults will casca const myProjectRequest = request.defaults({ baseUrl: "https://github-enterprise.acme-inc.com/api/v3", headers: { - "user-agent": "myApp/1.2.3" + "user-agent": "myApp/1.2.3", }, - org: "my-project" + org: "my-project", }); const myProjectRequestWithAuth = myProjectRequest.defaults({ headers: { - authorization: `token 0000000000000000000000000000000000000001` - } + authorization: `token 0000000000000000000000000000000000000001`, + }, }); ``` @@ -451,9 +453,9 @@ by the global default. See https://github.com/octokit/endpoint.js. Example ```js -const options = request.endpoint("GET /orgs/:org/repos", { +const options = request.endpoint("GET /orgs/{org}/repos", { org: "my-project", - type: "private" + type: "private", }); // { @@ -487,8 +489,8 @@ const response = await request("POST /markdown/raw", { data: "Hello world github/linguist#1 **cool**, and #1!", headers: { accept: "text/html;charset=utf-8", - "content-type": "text/plain" - } + "content-type": "text/plain", + }, }); // Request is sent as @@ -527,9 +529,9 @@ request( headers: { "content-type": "text/plain", "content-length": 14, - authorization: `token 0000000000000000000000000000000000000001` + authorization: `token 0000000000000000000000000000000000000001`, }, - data: "Hello, world!" + data: "Hello, world!", } ); ``` diff --git a/node_modules/@octokit/request/dist-node/index.js b/node_modules/@octokit/request/dist-node/index.js index 19b227b..808deb6 100644 --- a/node_modules/@octokit/request/dist-node/index.js +++ b/node_modules/@octokit/request/dist-node/index.js @@ -6,18 +6,18 @@ function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'defau var endpoint = require('@octokit/endpoint'); var universalUserAgent = require('universal-user-agent'); -var isPlainObject = _interopDefault(require('is-plain-object')); +var isPlainObject = require('is-plain-object'); var nodeFetch = _interopDefault(require('node-fetch')); var requestError = require('@octokit/request-error'); -const VERSION = "5.3.1"; +const VERSION = "5.4.12"; function getBufferResponse(response) { return response.arrayBuffer(); } function fetchWrapper(requestOptions) { - if (isPlainObject(requestOptions.body) || Array.isArray(requestOptions.body)) { + if (isPlainObject.isPlainObject(requestOptions.body) || Array.isArray(requestOptions.body)) { requestOptions.body = JSON.stringify(requestOptions.body); } @@ -40,7 +40,7 @@ function fetchWrapper(requestOptions) { if (status === 204 || status === 205) { return; - } // GitHub API returns 200 for HEAD requsets + } // GitHub API returns 200 for HEAD requests if (requestOptions.method === "HEAD") { @@ -71,7 +71,7 @@ function fetchWrapper(requestOptions) { try { let responseBody = JSON.parse(error.message); Object.assign(error, responseBody); - let errors = responseBody.errors; // Assumption `errors` would always be in Array Fotmat + let errors = responseBody.errors; // Assumption `errors` would always be in Array format error.message = error.message + ": " + errors.map(JSON.stringify).join(", "); } catch (e) {// ignore, see octokit/rest.js#684 diff --git a/node_modules/@octokit/request/dist-node/index.js.map b/node_modules/@octokit/request/dist-node/index.js.map index b0ffb70..cfa7cc0 100644 --- a/node_modules/@octokit/request/dist-node/index.js.map +++ b/node_modules/@octokit/request/dist-node/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/get-buffer-response.js","../dist-src/fetch-wrapper.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.3.1\";\n","export default function getBufferResponse(response) {\n return response.arrayBuffer();\n}\n","import isPlainObject from \"is-plain-object\";\nimport nodeFetch from \"node-fetch\";\nimport { RequestError } from \"@octokit/request-error\";\nimport getBuffer from \"./get-buffer-response\";\nexport default function fetchWrapper(requestOptions) {\n if (isPlainObject(requestOptions.body) ||\n Array.isArray(requestOptions.body)) {\n requestOptions.body = JSON.stringify(requestOptions.body);\n }\n let headers = {};\n let status;\n let url;\n const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch;\n return fetch(requestOptions.url, Object.assign({\n method: requestOptions.method,\n body: requestOptions.body,\n headers: requestOptions.headers,\n redirect: requestOptions.redirect\n }, requestOptions.request))\n .then(response => {\n url = response.url;\n status = response.status;\n for (const keyAndValue of response.headers) {\n headers[keyAndValue[0]] = keyAndValue[1];\n }\n if (status === 204 || status === 205) {\n return;\n }\n // GitHub API returns 200 for HEAD requsets\n if (requestOptions.method === \"HEAD\") {\n if (status < 400) {\n return;\n }\n throw new RequestError(response.statusText, status, {\n headers,\n request: requestOptions\n });\n }\n if (status === 304) {\n throw new RequestError(\"Not modified\", status, {\n headers,\n request: requestOptions\n });\n }\n if (status >= 400) {\n return response\n .text()\n .then(message => {\n const error = new RequestError(message, status, {\n headers,\n request: requestOptions\n });\n try {\n let responseBody = JSON.parse(error.message);\n Object.assign(error, responseBody);\n let errors = responseBody.errors;\n // Assumption `errors` would always be in Array Fotmat\n error.message =\n error.message + \": \" + errors.map(JSON.stringify).join(\", \");\n }\n catch (e) {\n // ignore, see octokit/rest.js#684\n }\n throw error;\n });\n }\n const contentType = response.headers.get(\"content-type\");\n if (/application\\/json/.test(contentType)) {\n return response.json();\n }\n if (!contentType || /^text\\/|charset=utf-8$/.test(contentType)) {\n return response.text();\n }\n return getBuffer(response);\n })\n .then(data => {\n return {\n status,\n url,\n headers,\n data\n };\n })\n .catch(error => {\n if (error instanceof RequestError) {\n throw error;\n }\n throw new RequestError(error.message, 500, {\n headers,\n request: requestOptions\n });\n });\n}\n","import fetchWrapper from \"./fetch-wrapper\";\nexport default function withDefaults(oldEndpoint, newDefaults) {\n const endpoint = oldEndpoint.defaults(newDefaults);\n const newApi = function (route, parameters) {\n const endpointOptions = endpoint.merge(route, parameters);\n if (!endpointOptions.request || !endpointOptions.request.hook) {\n return fetchWrapper(endpoint.parse(endpointOptions));\n }\n const request = (route, parameters) => {\n return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters)));\n };\n Object.assign(request, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint)\n });\n return endpointOptions.request.hook(request, endpointOptions);\n };\n return Object.assign(newApi, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint)\n });\n}\n","import { endpoint } from \"@octokit/endpoint\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport withDefaults from \"./with-defaults\";\nexport const request = withDefaults(endpoint, {\n headers: {\n \"user-agent\": `octokit-request.js/${VERSION} ${getUserAgent()}`\n }\n});\n"],"names":["VERSION","getBufferResponse","response","arrayBuffer","fetchWrapper","requestOptions","isPlainObject","body","Array","isArray","JSON","stringify","headers","status","url","fetch","request","nodeFetch","Object","assign","method","redirect","then","keyAndValue","RequestError","statusText","text","message","error","responseBody","parse","errors","map","join","e","contentType","get","test","json","getBuffer","data","catch","withDefaults","oldEndpoint","newDefaults","endpoint","defaults","newApi","route","parameters","endpointOptions","merge","hook","bind","getUserAgent"],"mappings":";;;;;;;;;;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACAQ,SAASC,iBAAT,CAA2BC,QAA3B,EAAqC;SACzCA,QAAQ,CAACC,WAAT,EAAP;;;ACGW,SAASC,YAAT,CAAsBC,cAAtB,EAAsC;MAC7CC,aAAa,CAACD,cAAc,CAACE,IAAhB,CAAb,IACAC,KAAK,CAACC,OAAN,CAAcJ,cAAc,CAACE,IAA7B,CADJ,EACwC;IACpCF,cAAc,CAACE,IAAf,GAAsBG,IAAI,CAACC,SAAL,CAAeN,cAAc,CAACE,IAA9B,CAAtB;;;MAEAK,OAAO,GAAG,EAAd;MACIC,MAAJ;MACIC,GAAJ;QACMC,KAAK,GAAIV,cAAc,CAACW,OAAf,IAA0BX,cAAc,CAACW,OAAf,CAAuBD,KAAlD,IAA4DE,SAA1E;SACOF,KAAK,CAACV,cAAc,CAACS,GAAhB,EAAqBI,MAAM,CAACC,MAAP,CAAc;IAC3CC,MAAM,EAAEf,cAAc,CAACe,MADoB;IAE3Cb,IAAI,EAAEF,cAAc,CAACE,IAFsB;IAG3CK,OAAO,EAAEP,cAAc,CAACO,OAHmB;IAI3CS,QAAQ,EAAEhB,cAAc,CAACgB;GAJI,EAK9BhB,cAAc,CAACW,OALe,CAArB,CAAL,CAMFM,IANE,CAMGpB,QAAQ,IAAI;IAClBY,GAAG,GAAGZ,QAAQ,CAACY,GAAf;IACAD,MAAM,GAAGX,QAAQ,CAACW,MAAlB;;SACK,MAAMU,WAAX,IAA0BrB,QAAQ,CAACU,OAAnC,EAA4C;MACxCA,OAAO,CAACW,WAAW,CAAC,CAAD,CAAZ,CAAP,GAA0BA,WAAW,CAAC,CAAD,CAArC;;;QAEAV,MAAM,KAAK,GAAX,IAAkBA,MAAM,KAAK,GAAjC,EAAsC;;KANpB;;;QAUdR,cAAc,CAACe,MAAf,KAA0B,MAA9B,EAAsC;UAC9BP,MAAM,GAAG,GAAb,EAAkB;;;;YAGZ,IAAIW,yBAAJ,CAAiBtB,QAAQ,CAACuB,UAA1B,EAAsCZ,MAAtC,EAA8C;QAChDD,OADgD;QAEhDI,OAAO,EAAEX;OAFP,CAAN;;;QAKAQ,MAAM,KAAK,GAAf,EAAoB;YACV,IAAIW,yBAAJ,CAAiB,cAAjB,EAAiCX,MAAjC,EAAyC;QAC3CD,OAD2C;QAE3CI,OAAO,EAAEX;OAFP,CAAN;;;QAKAQ,MAAM,IAAI,GAAd,EAAmB;aACRX,QAAQ,CACVwB,IADE,GAEFJ,IAFE,CAEGK,OAAO,IAAI;cACXC,KAAK,GAAG,IAAIJ,yBAAJ,CAAiBG,OAAjB,EAA0Bd,MAA1B,EAAkC;UAC5CD,OAD4C;UAE5CI,OAAO,EAAEX;SAFC,CAAd;;YAII;cACIwB,YAAY,GAAGnB,IAAI,CAACoB,KAAL,CAAWF,KAAK,CAACD,OAAjB,CAAnB;UACAT,MAAM,CAACC,MAAP,CAAcS,KAAd,EAAqBC,YAArB;cACIE,MAAM,GAAGF,YAAY,CAACE,MAA1B,CAHA;;UAKAH,KAAK,CAACD,OAAN,GACIC,KAAK,CAACD,OAAN,GAAgB,IAAhB,GAAuBI,MAAM,CAACC,GAAP,CAAWtB,IAAI,CAACC,SAAhB,EAA2BsB,IAA3B,CAAgC,IAAhC,CAD3B;SALJ,CAQA,OAAOC,CAAP,EAAU;;;cAGJN,KAAN;OAlBG,CAAP;;;UAqBEO,WAAW,GAAGjC,QAAQ,CAACU,OAAT,CAAiBwB,GAAjB,CAAqB,cAArB,CAApB;;QACI,oBAAoBC,IAApB,CAAyBF,WAAzB,CAAJ,EAA2C;aAChCjC,QAAQ,CAACoC,IAAT,EAAP;;;QAEA,CAACH,WAAD,IAAgB,yBAAyBE,IAAzB,CAA8BF,WAA9B,CAApB,EAAgE;aACrDjC,QAAQ,CAACwB,IAAT,EAAP;;;WAEGa,iBAAS,CAACrC,QAAD,CAAhB;GA5DG,EA8DFoB,IA9DE,CA8DGkB,IAAI,IAAI;WACP;MACH3B,MADG;MAEHC,GAFG;MAGHF,OAHG;MAIH4B;KAJJ;GA/DG,EAsEFC,KAtEE,CAsEIb,KAAK,IAAI;QACZA,KAAK,YAAYJ,yBAArB,EAAmC;YACzBI,KAAN;;;UAEE,IAAIJ,yBAAJ,CAAiBI,KAAK,CAACD,OAAvB,EAAgC,GAAhC,EAAqC;MACvCf,OADuC;MAEvCI,OAAO,EAAEX;KAFP,CAAN;GA1EG,CAAP;;;ACZW,SAASqC,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;QACrDC,QAAQ,GAAGF,WAAW,CAACG,QAAZ,CAAqBF,WAArB,CAAjB;;QACMG,MAAM,GAAG,UAAUC,KAAV,EAAiBC,UAAjB,EAA6B;UAClCC,eAAe,GAAGL,QAAQ,CAACM,KAAT,CAAeH,KAAf,EAAsBC,UAAtB,CAAxB;;QACI,CAACC,eAAe,CAAClC,OAAjB,IAA4B,CAACkC,eAAe,CAAClC,OAAhB,CAAwBoC,IAAzD,EAA+D;aACpDhD,YAAY,CAACyC,QAAQ,CAACf,KAAT,CAAeoB,eAAf,CAAD,CAAnB;;;UAEElC,OAAO,GAAG,CAACgC,KAAD,EAAQC,UAAR,KAAuB;aAC5B7C,YAAY,CAACyC,QAAQ,CAACf,KAAT,CAAee,QAAQ,CAACM,KAAT,CAAeH,KAAf,EAAsBC,UAAtB,CAAf,CAAD,CAAnB;KADJ;;IAGA/B,MAAM,CAACC,MAAP,CAAcH,OAAd,EAAuB;MACnB6B,QADmB;MAEnBC,QAAQ,EAAEJ,YAAY,CAACW,IAAb,CAAkB,IAAlB,EAAwBR,QAAxB;KAFd;WAIOK,eAAe,CAAClC,OAAhB,CAAwBoC,IAAxB,CAA6BpC,OAA7B,EAAsCkC,eAAtC,CAAP;GAZJ;;SAcOhC,MAAM,CAACC,MAAP,CAAc4B,MAAd,EAAsB;IACzBF,QADyB;IAEzBC,QAAQ,EAAEJ,YAAY,CAACW,IAAb,CAAkB,IAAlB,EAAwBR,QAAxB;GAFP,CAAP;;;MCbS7B,OAAO,GAAG0B,YAAY,CAACG,iBAAD,EAAW;EAC1CjC,OAAO,EAAE;kBACU,sBAAqBZ,OAAQ,IAAGsD,+BAAY,EAAG;;CAFnC,CAA5B;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/get-buffer-response.js","../dist-src/fetch-wrapper.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.4.12\";\n","export default function getBufferResponse(response) {\n return response.arrayBuffer();\n}\n","import { isPlainObject } from \"is-plain-object\";\nimport nodeFetch from \"node-fetch\";\nimport { RequestError } from \"@octokit/request-error\";\nimport getBuffer from \"./get-buffer-response\";\nexport default function fetchWrapper(requestOptions) {\n if (isPlainObject(requestOptions.body) ||\n Array.isArray(requestOptions.body)) {\n requestOptions.body = JSON.stringify(requestOptions.body);\n }\n let headers = {};\n let status;\n let url;\n const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch;\n return fetch(requestOptions.url, Object.assign({\n method: requestOptions.method,\n body: requestOptions.body,\n headers: requestOptions.headers,\n redirect: requestOptions.redirect,\n }, requestOptions.request))\n .then((response) => {\n url = response.url;\n status = response.status;\n for (const keyAndValue of response.headers) {\n headers[keyAndValue[0]] = keyAndValue[1];\n }\n if (status === 204 || status === 205) {\n return;\n }\n // GitHub API returns 200 for HEAD requests\n if (requestOptions.method === \"HEAD\") {\n if (status < 400) {\n return;\n }\n throw new RequestError(response.statusText, status, {\n headers,\n request: requestOptions,\n });\n }\n if (status === 304) {\n throw new RequestError(\"Not modified\", status, {\n headers,\n request: requestOptions,\n });\n }\n if (status >= 400) {\n return response\n .text()\n .then((message) => {\n const error = new RequestError(message, status, {\n headers,\n request: requestOptions,\n });\n try {\n let responseBody = JSON.parse(error.message);\n Object.assign(error, responseBody);\n let errors = responseBody.errors;\n // Assumption `errors` would always be in Array format\n error.message =\n error.message + \": \" + errors.map(JSON.stringify).join(\", \");\n }\n catch (e) {\n // ignore, see octokit/rest.js#684\n }\n throw error;\n });\n }\n const contentType = response.headers.get(\"content-type\");\n if (/application\\/json/.test(contentType)) {\n return response.json();\n }\n if (!contentType || /^text\\/|charset=utf-8$/.test(contentType)) {\n return response.text();\n }\n return getBuffer(response);\n })\n .then((data) => {\n return {\n status,\n url,\n headers,\n data,\n };\n })\n .catch((error) => {\n if (error instanceof RequestError) {\n throw error;\n }\n throw new RequestError(error.message, 500, {\n headers,\n request: requestOptions,\n });\n });\n}\n","import fetchWrapper from \"./fetch-wrapper\";\nexport default function withDefaults(oldEndpoint, newDefaults) {\n const endpoint = oldEndpoint.defaults(newDefaults);\n const newApi = function (route, parameters) {\n const endpointOptions = endpoint.merge(route, parameters);\n if (!endpointOptions.request || !endpointOptions.request.hook) {\n return fetchWrapper(endpoint.parse(endpointOptions));\n }\n const request = (route, parameters) => {\n return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters)));\n };\n Object.assign(request, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint),\n });\n return endpointOptions.request.hook(request, endpointOptions);\n };\n return Object.assign(newApi, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint),\n });\n}\n","import { endpoint } from \"@octokit/endpoint\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport withDefaults from \"./with-defaults\";\nexport const request = withDefaults(endpoint, {\n headers: {\n \"user-agent\": `octokit-request.js/${VERSION} ${getUserAgent()}`,\n },\n});\n"],"names":["VERSION","getBufferResponse","response","arrayBuffer","fetchWrapper","requestOptions","isPlainObject","body","Array","isArray","JSON","stringify","headers","status","url","fetch","request","nodeFetch","Object","assign","method","redirect","then","keyAndValue","RequestError","statusText","text","message","error","responseBody","parse","errors","map","join","e","contentType","get","test","json","getBuffer","data","catch","withDefaults","oldEndpoint","newDefaults","endpoint","defaults","newApi","route","parameters","endpointOptions","merge","hook","bind","getUserAgent"],"mappings":";;;;;;;;;;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACAQ,SAASC,iBAAT,CAA2BC,QAA3B,EAAqC;AAChD,SAAOA,QAAQ,CAACC,WAAT,EAAP;AACH;;ACEc,SAASC,YAAT,CAAsBC,cAAtB,EAAsC;AACjD,MAAIC,2BAAa,CAACD,cAAc,CAACE,IAAhB,CAAb,IACAC,KAAK,CAACC,OAAN,CAAcJ,cAAc,CAACE,IAA7B,CADJ,EACwC;AACpCF,IAAAA,cAAc,CAACE,IAAf,GAAsBG,IAAI,CAACC,SAAL,CAAeN,cAAc,CAACE,IAA9B,CAAtB;AACH;;AACD,MAAIK,OAAO,GAAG,EAAd;AACA,MAAIC,MAAJ;AACA,MAAIC,GAAJ;AACA,QAAMC,KAAK,GAAIV,cAAc,CAACW,OAAf,IAA0BX,cAAc,CAACW,OAAf,CAAuBD,KAAlD,IAA4DE,SAA1E;AACA,SAAOF,KAAK,CAACV,cAAc,CAACS,GAAhB,EAAqBI,MAAM,CAACC,MAAP,CAAc;AAC3CC,IAAAA,MAAM,EAAEf,cAAc,CAACe,MADoB;AAE3Cb,IAAAA,IAAI,EAAEF,cAAc,CAACE,IAFsB;AAG3CK,IAAAA,OAAO,EAAEP,cAAc,CAACO,OAHmB;AAI3CS,IAAAA,QAAQ,EAAEhB,cAAc,CAACgB;AAJkB,GAAd,EAK9BhB,cAAc,CAACW,OALe,CAArB,CAAL,CAMFM,IANE,CAMIpB,QAAD,IAAc;AACpBY,IAAAA,GAAG,GAAGZ,QAAQ,CAACY,GAAf;AACAD,IAAAA,MAAM,GAAGX,QAAQ,CAACW,MAAlB;;AACA,SAAK,MAAMU,WAAX,IAA0BrB,QAAQ,CAACU,OAAnC,EAA4C;AACxCA,MAAAA,OAAO,CAACW,WAAW,CAAC,CAAD,CAAZ,CAAP,GAA0BA,WAAW,CAAC,CAAD,CAArC;AACH;;AACD,QAAIV,MAAM,KAAK,GAAX,IAAkBA,MAAM,KAAK,GAAjC,EAAsC;AAClC;AACH,KARmB;;;AAUpB,QAAIR,cAAc,CAACe,MAAf,KAA0B,MAA9B,EAAsC;AAClC,UAAIP,MAAM,GAAG,GAAb,EAAkB;AACd;AACH;;AACD,YAAM,IAAIW,yBAAJ,CAAiBtB,QAAQ,CAACuB,UAA1B,EAAsCZ,MAAtC,EAA8C;AAChDD,QAAAA,OADgD;AAEhDI,QAAAA,OAAO,EAAEX;AAFuC,OAA9C,CAAN;AAIH;;AACD,QAAIQ,MAAM,KAAK,GAAf,EAAoB;AAChB,YAAM,IAAIW,yBAAJ,CAAiB,cAAjB,EAAiCX,MAAjC,EAAyC;AAC3CD,QAAAA,OAD2C;AAE3CI,QAAAA,OAAO,EAAEX;AAFkC,OAAzC,CAAN;AAIH;;AACD,QAAIQ,MAAM,IAAI,GAAd,EAAmB;AACf,aAAOX,QAAQ,CACVwB,IADE,GAEFJ,IAFE,CAEIK,OAAD,IAAa;AACnB,cAAMC,KAAK,GAAG,IAAIJ,yBAAJ,CAAiBG,OAAjB,EAA0Bd,MAA1B,EAAkC;AAC5CD,UAAAA,OAD4C;AAE5CI,UAAAA,OAAO,EAAEX;AAFmC,SAAlC,CAAd;;AAIA,YAAI;AACA,cAAIwB,YAAY,GAAGnB,IAAI,CAACoB,KAAL,CAAWF,KAAK,CAACD,OAAjB,CAAnB;AACAT,UAAAA,MAAM,CAACC,MAAP,CAAcS,KAAd,EAAqBC,YAArB;AACA,cAAIE,MAAM,GAAGF,YAAY,CAACE,MAA1B,CAHA;;AAKAH,UAAAA,KAAK,CAACD,OAAN,GACIC,KAAK,CAACD,OAAN,GAAgB,IAAhB,GAAuBI,MAAM,CAACC,GAAP,CAAWtB,IAAI,CAACC,SAAhB,EAA2BsB,IAA3B,CAAgC,IAAhC,CAD3B;AAEH,SAPD,CAQA,OAAOC,CAAP,EAAU;AAET;;AACD,cAAMN,KAAN;AACH,OAnBM,CAAP;AAoBH;;AACD,UAAMO,WAAW,GAAGjC,QAAQ,CAACU,OAAT,CAAiBwB,GAAjB,CAAqB,cAArB,CAApB;;AACA,QAAI,oBAAoBC,IAApB,CAAyBF,WAAzB,CAAJ,EAA2C;AACvC,aAAOjC,QAAQ,CAACoC,IAAT,EAAP;AACH;;AACD,QAAI,CAACH,WAAD,IAAgB,yBAAyBE,IAAzB,CAA8BF,WAA9B,CAApB,EAAgE;AAC5D,aAAOjC,QAAQ,CAACwB,IAAT,EAAP;AACH;;AACD,WAAOa,iBAAS,CAACrC,QAAD,CAAhB;AACH,GA7DM,EA8DFoB,IA9DE,CA8DIkB,IAAD,IAAU;AAChB,WAAO;AACH3B,MAAAA,MADG;AAEHC,MAAAA,GAFG;AAGHF,MAAAA,OAHG;AAIH4B,MAAAA;AAJG,KAAP;AAMH,GArEM,EAsEFC,KAtEE,CAsEKb,KAAD,IAAW;AAClB,QAAIA,KAAK,YAAYJ,yBAArB,EAAmC;AAC/B,YAAMI,KAAN;AACH;;AACD,UAAM,IAAIJ,yBAAJ,CAAiBI,KAAK,CAACD,OAAvB,EAAgC,GAAhC,EAAqC;AACvCf,MAAAA,OADuC;AAEvCI,MAAAA,OAAO,EAAEX;AAF8B,KAArC,CAAN;AAIH,GA9EM,CAAP;AA+EH;;AC3Fc,SAASqC,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;AAC3D,QAAMC,QAAQ,GAAGF,WAAW,CAACG,QAAZ,CAAqBF,WAArB,CAAjB;;AACA,QAAMG,MAAM,GAAG,UAAUC,KAAV,EAAiBC,UAAjB,EAA6B;AACxC,UAAMC,eAAe,GAAGL,QAAQ,CAACM,KAAT,CAAeH,KAAf,EAAsBC,UAAtB,CAAxB;;AACA,QAAI,CAACC,eAAe,CAAClC,OAAjB,IAA4B,CAACkC,eAAe,CAAClC,OAAhB,CAAwBoC,IAAzD,EAA+D;AAC3D,aAAOhD,YAAY,CAACyC,QAAQ,CAACf,KAAT,CAAeoB,eAAf,CAAD,CAAnB;AACH;;AACD,UAAMlC,OAAO,GAAG,CAACgC,KAAD,EAAQC,UAAR,KAAuB;AACnC,aAAO7C,YAAY,CAACyC,QAAQ,CAACf,KAAT,CAAee,QAAQ,CAACM,KAAT,CAAeH,KAAf,EAAsBC,UAAtB,CAAf,CAAD,CAAnB;AACH,KAFD;;AAGA/B,IAAAA,MAAM,CAACC,MAAP,CAAcH,OAAd,EAAuB;AACnB6B,MAAAA,QADmB;AAEnBC,MAAAA,QAAQ,EAAEJ,YAAY,CAACW,IAAb,CAAkB,IAAlB,EAAwBR,QAAxB;AAFS,KAAvB;AAIA,WAAOK,eAAe,CAAClC,OAAhB,CAAwBoC,IAAxB,CAA6BpC,OAA7B,EAAsCkC,eAAtC,CAAP;AACH,GAbD;;AAcA,SAAOhC,MAAM,CAACC,MAAP,CAAc4B,MAAd,EAAsB;AACzBF,IAAAA,QADyB;AAEzBC,IAAAA,QAAQ,EAAEJ,YAAY,CAACW,IAAb,CAAkB,IAAlB,EAAwBR,QAAxB;AAFe,GAAtB,CAAP;AAIH;;MCjBY7B,OAAO,GAAG0B,YAAY,CAACG,iBAAD,EAAW;AAC1CjC,EAAAA,OAAO,EAAE;AACL,kBAAe,sBAAqBZ,OAAQ,IAAGsD,+BAAY,EAAG;AADzD;AADiC,CAAX,CAA5B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/dist-src/fetch-wrapper.js b/node_modules/@octokit/request/dist-src/fetch-wrapper.js index f2b80d7..e4ae1b0 100644 --- a/node_modules/@octokit/request/dist-src/fetch-wrapper.js +++ b/node_modules/@octokit/request/dist-src/fetch-wrapper.js @@ -1,4 +1,4 @@ -import isPlainObject from "is-plain-object"; +import { isPlainObject } from "is-plain-object"; import nodeFetch from "node-fetch"; import { RequestError } from "@octokit/request-error"; import getBuffer from "./get-buffer-response"; @@ -15,9 +15,9 @@ export default function fetchWrapper(requestOptions) { method: requestOptions.method, body: requestOptions.body, headers: requestOptions.headers, - redirect: requestOptions.redirect + redirect: requestOptions.redirect, }, requestOptions.request)) - .then(response => { + .then((response) => { url = response.url; status = response.status; for (const keyAndValue of response.headers) { @@ -26,35 +26,35 @@ export default function fetchWrapper(requestOptions) { if (status === 204 || status === 205) { return; } - // GitHub API returns 200 for HEAD requsets + // GitHub API returns 200 for HEAD requests if (requestOptions.method === "HEAD") { if (status < 400) { return; } throw new RequestError(response.statusText, status, { headers, - request: requestOptions + request: requestOptions, }); } if (status === 304) { throw new RequestError("Not modified", status, { headers, - request: requestOptions + request: requestOptions, }); } if (status >= 400) { return response .text() - .then(message => { + .then((message) => { const error = new RequestError(message, status, { headers, - request: requestOptions + request: requestOptions, }); try { let responseBody = JSON.parse(error.message); Object.assign(error, responseBody); let errors = responseBody.errors; - // Assumption `errors` would always be in Array Fotmat + // Assumption `errors` would always be in Array format error.message = error.message + ": " + errors.map(JSON.stringify).join(", "); } @@ -73,21 +73,21 @@ export default function fetchWrapper(requestOptions) { } return getBuffer(response); }) - .then(data => { + .then((data) => { return { status, url, headers, - data + data, }; }) - .catch(error => { + .catch((error) => { if (error instanceof RequestError) { throw error; } throw new RequestError(error.message, 500, { headers, - request: requestOptions + request: requestOptions, }); }); } diff --git a/node_modules/@octokit/request/dist-src/index.js b/node_modules/@octokit/request/dist-src/index.js index 6a36142..2460e99 100644 --- a/node_modules/@octokit/request/dist-src/index.js +++ b/node_modules/@octokit/request/dist-src/index.js @@ -4,6 +4,6 @@ import { VERSION } from "./version"; import withDefaults from "./with-defaults"; export const request = withDefaults(endpoint, { headers: { - "user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}` - } + "user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}`, + }, }); diff --git a/node_modules/@octokit/request/dist-src/version.js b/node_modules/@octokit/request/dist-src/version.js index 6250d76..7644e77 100644 --- a/node_modules/@octokit/request/dist-src/version.js +++ b/node_modules/@octokit/request/dist-src/version.js @@ -1 +1 @@ -export const VERSION = "5.3.1"; +export const VERSION = "5.4.12"; diff --git a/node_modules/@octokit/request/dist-src/with-defaults.js b/node_modules/@octokit/request/dist-src/with-defaults.js index 8e44f46..e206429 100644 --- a/node_modules/@octokit/request/dist-src/with-defaults.js +++ b/node_modules/@octokit/request/dist-src/with-defaults.js @@ -11,12 +11,12 @@ export default function withDefaults(oldEndpoint, newDefaults) { }; Object.assign(request, { endpoint, - defaults: withDefaults.bind(null, endpoint) + defaults: withDefaults.bind(null, endpoint), }); return endpointOptions.request.hook(request, endpointOptions); }; return Object.assign(newApi, { endpoint, - defaults: withDefaults.bind(null, endpoint) + defaults: withDefaults.bind(null, endpoint), }); } diff --git a/node_modules/@octokit/request/dist-types/fetch-wrapper.d.ts b/node_modules/@octokit/request/dist-types/fetch-wrapper.d.ts index 594bce6..4901c79 100644 --- a/node_modules/@octokit/request/dist-types/fetch-wrapper.d.ts +++ b/node_modules/@octokit/request/dist-types/fetch-wrapper.d.ts @@ -1,6 +1,6 @@ import { EndpointInterface } from "@octokit/types"; export default function fetchWrapper(requestOptions: ReturnType & { - redirect?: string; + redirect?: "error" | "follow" | "manual"; }): Promise<{ status: number; url: string; diff --git a/node_modules/@octokit/request/dist-types/index.d.ts b/node_modules/@octokit/request/dist-types/index.d.ts index cb9c9ba..1030809 100644 --- a/node_modules/@octokit/request/dist-types/index.d.ts +++ b/node_modules/@octokit/request/dist-types/index.d.ts @@ -1 +1 @@ -export declare const request: import("@octokit/types").RequestInterface; +export declare const request: import("@octokit/types").RequestInterface; diff --git a/node_modules/@octokit/request/dist-types/version.d.ts b/node_modules/@octokit/request/dist-types/version.d.ts index c32c7ab..0e4434f 100644 --- a/node_modules/@octokit/request/dist-types/version.d.ts +++ b/node_modules/@octokit/request/dist-types/version.d.ts @@ -1 +1 @@ -export declare const VERSION = "5.3.1"; +export declare const VERSION = "5.4.12"; diff --git a/node_modules/@octokit/request/dist-web/index.js b/node_modules/@octokit/request/dist-web/index.js index 3f51926..46c8625 100644 --- a/node_modules/@octokit/request/dist-web/index.js +++ b/node_modules/@octokit/request/dist-web/index.js @@ -1,10 +1,10 @@ import { endpoint } from '@octokit/endpoint'; import { getUserAgent } from 'universal-user-agent'; -import isPlainObject from 'is-plain-object'; +import { isPlainObject } from 'is-plain-object'; import nodeFetch from 'node-fetch'; import { RequestError } from '@octokit/request-error'; -const VERSION = "5.3.1"; +const VERSION = "5.4.12"; function getBufferResponse(response) { return response.arrayBuffer(); @@ -23,9 +23,9 @@ function fetchWrapper(requestOptions) { method: requestOptions.method, body: requestOptions.body, headers: requestOptions.headers, - redirect: requestOptions.redirect + redirect: requestOptions.redirect, }, requestOptions.request)) - .then(response => { + .then((response) => { url = response.url; status = response.status; for (const keyAndValue of response.headers) { @@ -34,35 +34,35 @@ function fetchWrapper(requestOptions) { if (status === 204 || status === 205) { return; } - // GitHub API returns 200 for HEAD requsets + // GitHub API returns 200 for HEAD requests if (requestOptions.method === "HEAD") { if (status < 400) { return; } throw new RequestError(response.statusText, status, { headers, - request: requestOptions + request: requestOptions, }); } if (status === 304) { throw new RequestError("Not modified", status, { headers, - request: requestOptions + request: requestOptions, }); } if (status >= 400) { return response .text() - .then(message => { + .then((message) => { const error = new RequestError(message, status, { headers, - request: requestOptions + request: requestOptions, }); try { let responseBody = JSON.parse(error.message); Object.assign(error, responseBody); let errors = responseBody.errors; - // Assumption `errors` would always be in Array Fotmat + // Assumption `errors` would always be in Array format error.message = error.message + ": " + errors.map(JSON.stringify).join(", "); } @@ -81,21 +81,21 @@ function fetchWrapper(requestOptions) { } return getBufferResponse(response); }) - .then(data => { + .then((data) => { return { status, url, headers, - data + data, }; }) - .catch(error => { + .catch((error) => { if (error instanceof RequestError) { throw error; } throw new RequestError(error.message, 500, { headers, - request: requestOptions + request: requestOptions, }); }); } @@ -112,20 +112,20 @@ function withDefaults(oldEndpoint, newDefaults) { }; Object.assign(request, { endpoint, - defaults: withDefaults.bind(null, endpoint) + defaults: withDefaults.bind(null, endpoint), }); return endpointOptions.request.hook(request, endpointOptions); }; return Object.assign(newApi, { endpoint, - defaults: withDefaults.bind(null, endpoint) + defaults: withDefaults.bind(null, endpoint), }); } const request = withDefaults(endpoint, { headers: { - "user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}` - } + "user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}`, + }, }); export { request }; diff --git a/node_modules/@octokit/request/dist-web/index.js.map b/node_modules/@octokit/request/dist-web/index.js.map index f4c3084..0bddd0d 100644 --- a/node_modules/@octokit/request/dist-web/index.js.map +++ b/node_modules/@octokit/request/dist-web/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/get-buffer-response.js","../dist-src/fetch-wrapper.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.3.1\";\n","export default function getBufferResponse(response) {\n return response.arrayBuffer();\n}\n","import isPlainObject from \"is-plain-object\";\nimport nodeFetch from \"node-fetch\";\nimport { RequestError } from \"@octokit/request-error\";\nimport getBuffer from \"./get-buffer-response\";\nexport default function fetchWrapper(requestOptions) {\n if (isPlainObject(requestOptions.body) ||\n Array.isArray(requestOptions.body)) {\n requestOptions.body = JSON.stringify(requestOptions.body);\n }\n let headers = {};\n let status;\n let url;\n const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch;\n return fetch(requestOptions.url, Object.assign({\n method: requestOptions.method,\n body: requestOptions.body,\n headers: requestOptions.headers,\n redirect: requestOptions.redirect\n }, requestOptions.request))\n .then(response => {\n url = response.url;\n status = response.status;\n for (const keyAndValue of response.headers) {\n headers[keyAndValue[0]] = keyAndValue[1];\n }\n if (status === 204 || status === 205) {\n return;\n }\n // GitHub API returns 200 for HEAD requsets\n if (requestOptions.method === \"HEAD\") {\n if (status < 400) {\n return;\n }\n throw new RequestError(response.statusText, status, {\n headers,\n request: requestOptions\n });\n }\n if (status === 304) {\n throw new RequestError(\"Not modified\", status, {\n headers,\n request: requestOptions\n });\n }\n if (status >= 400) {\n return response\n .text()\n .then(message => {\n const error = new RequestError(message, status, {\n headers,\n request: requestOptions\n });\n try {\n let responseBody = JSON.parse(error.message);\n Object.assign(error, responseBody);\n let errors = responseBody.errors;\n // Assumption `errors` would always be in Array Fotmat\n error.message =\n error.message + \": \" + errors.map(JSON.stringify).join(\", \");\n }\n catch (e) {\n // ignore, see octokit/rest.js#684\n }\n throw error;\n });\n }\n const contentType = response.headers.get(\"content-type\");\n if (/application\\/json/.test(contentType)) {\n return response.json();\n }\n if (!contentType || /^text\\/|charset=utf-8$/.test(contentType)) {\n return response.text();\n }\n return getBuffer(response);\n })\n .then(data => {\n return {\n status,\n url,\n headers,\n data\n };\n })\n .catch(error => {\n if (error instanceof RequestError) {\n throw error;\n }\n throw new RequestError(error.message, 500, {\n headers,\n request: requestOptions\n });\n });\n}\n","import fetchWrapper from \"./fetch-wrapper\";\nexport default function withDefaults(oldEndpoint, newDefaults) {\n const endpoint = oldEndpoint.defaults(newDefaults);\n const newApi = function (route, parameters) {\n const endpointOptions = endpoint.merge(route, parameters);\n if (!endpointOptions.request || !endpointOptions.request.hook) {\n return fetchWrapper(endpoint.parse(endpointOptions));\n }\n const request = (route, parameters) => {\n return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters)));\n };\n Object.assign(request, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint)\n });\n return endpointOptions.request.hook(request, endpointOptions);\n };\n return Object.assign(newApi, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint)\n });\n}\n","import { endpoint } from \"@octokit/endpoint\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport withDefaults from \"./with-defaults\";\nexport const request = withDefaults(endpoint, {\n headers: {\n \"user-agent\": `octokit-request.js/${VERSION} ${getUserAgent()}`\n }\n});\n"],"names":["getBuffer"],"mappings":";;;;;;AAAO,MAAM,OAAO,GAAG,mBAAmB,CAAC;;ACA5B,SAAS,iBAAiB,CAAC,QAAQ,EAAE;IAChD,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;CACjC;;ACEc,SAAS,YAAY,CAAC,cAAc,EAAE;IACjD,IAAI,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC;QAClC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;QACpC,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;KAC7D;IACD,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,MAAM,CAAC;IACX,IAAI,GAAG,CAAC;IACR,MAAM,KAAK,GAAG,CAAC,cAAc,CAAC,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC;IACpF,OAAO,KAAK,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC;QAC3C,MAAM,EAAE,cAAc,CAAC,MAAM;QAC7B,IAAI,EAAE,cAAc,CAAC,IAAI;QACzB,OAAO,EAAE,cAAc,CAAC,OAAO;QAC/B,QAAQ,EAAE,cAAc,CAAC,QAAQ;KACpC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;SACtB,IAAI,CAAC,QAAQ,IAAI;QAClB,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACnB,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACzB,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,OAAO,EAAE;YACxC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;SAC5C;QACD,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE;YAClC,OAAO;SACV;;QAED,IAAI,cAAc,CAAC,MAAM,KAAK,MAAM,EAAE;YAClC,IAAI,MAAM,GAAG,GAAG,EAAE;gBACd,OAAO;aACV;YACD,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE;gBAChD,OAAO;gBACP,OAAO,EAAE,cAAc;aAC1B,CAAC,CAAC;SACN;QACD,IAAI,MAAM,KAAK,GAAG,EAAE;YAChB,MAAM,IAAI,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE;gBAC3C,OAAO;gBACP,OAAO,EAAE,cAAc;aAC1B,CAAC,CAAC;SACN;QACD,IAAI,MAAM,IAAI,GAAG,EAAE;YACf,OAAO,QAAQ;iBACV,IAAI,EAAE;iBACN,IAAI,CAAC,OAAO,IAAI;gBACjB,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE;oBAC5C,OAAO;oBACP,OAAO,EAAE,cAAc;iBAC1B,CAAC,CAAC;gBACH,IAAI;oBACA,IAAI,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAC7C,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;oBACnC,IAAI,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;;oBAEjC,KAAK,CAAC,OAAO;wBACT,KAAK,CAAC,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACpE;gBACD,OAAO,CAAC,EAAE;;iBAET;gBACD,MAAM,KAAK,CAAC;aACf,CAAC,CAAC;SACN;QACD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACzD,IAAI,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YACvC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC1B;QACD,IAAI,CAAC,WAAW,IAAI,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YAC5D,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC1B;QACD,OAAOA,iBAAS,CAAC,QAAQ,CAAC,CAAC;KAC9B,CAAC;SACG,IAAI,CAAC,IAAI,IAAI;QACd,OAAO;YACH,MAAM;YACN,GAAG;YACH,OAAO;YACP,IAAI;SACP,CAAC;KACL,CAAC;SACG,KAAK,CAAC,KAAK,IAAI;QAChB,IAAI,KAAK,YAAY,YAAY,EAAE;YAC/B,MAAM,KAAK,CAAC;SACf;QACD,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE;YACvC,OAAO;YACP,OAAO,EAAE,cAAc;SAC1B,CAAC,CAAC;KACN,CAAC,CAAC;CACN;;AC3Fc,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;IAC3D,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,UAAU,KAAK,EAAE,UAAU,EAAE;QACxC,MAAM,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC1D,IAAI,CAAC,eAAe,CAAC,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE;YAC3D,OAAO,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;SACxD;QACD,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK;YACnC,OAAO,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;SAC1E,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YACnB,QAAQ;YACR,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;SAC9C,CAAC,CAAC;QACH,OAAO,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;KACjE,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;QACzB,QAAQ;QACR,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;KAC9C,CAAC,CAAC;CACN;;ACjBW,MAAC,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE;IAC1C,OAAO,EAAE;QACL,YAAY,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;KAClE;CACJ,CAAC;;;;"} \ No newline at end of file +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/get-buffer-response.js","../dist-src/fetch-wrapper.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.4.12\";\n","export default function getBufferResponse(response) {\n return response.arrayBuffer();\n}\n","import { isPlainObject } from \"is-plain-object\";\nimport nodeFetch from \"node-fetch\";\nimport { RequestError } from \"@octokit/request-error\";\nimport getBuffer from \"./get-buffer-response\";\nexport default function fetchWrapper(requestOptions) {\n if (isPlainObject(requestOptions.body) ||\n Array.isArray(requestOptions.body)) {\n requestOptions.body = JSON.stringify(requestOptions.body);\n }\n let headers = {};\n let status;\n let url;\n const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch;\n return fetch(requestOptions.url, Object.assign({\n method: requestOptions.method,\n body: requestOptions.body,\n headers: requestOptions.headers,\n redirect: requestOptions.redirect,\n }, requestOptions.request))\n .then((response) => {\n url = response.url;\n status = response.status;\n for (const keyAndValue of response.headers) {\n headers[keyAndValue[0]] = keyAndValue[1];\n }\n if (status === 204 || status === 205) {\n return;\n }\n // GitHub API returns 200 for HEAD requests\n if (requestOptions.method === \"HEAD\") {\n if (status < 400) {\n return;\n }\n throw new RequestError(response.statusText, status, {\n headers,\n request: requestOptions,\n });\n }\n if (status === 304) {\n throw new RequestError(\"Not modified\", status, {\n headers,\n request: requestOptions,\n });\n }\n if (status >= 400) {\n return response\n .text()\n .then((message) => {\n const error = new RequestError(message, status, {\n headers,\n request: requestOptions,\n });\n try {\n let responseBody = JSON.parse(error.message);\n Object.assign(error, responseBody);\n let errors = responseBody.errors;\n // Assumption `errors` would always be in Array format\n error.message =\n error.message + \": \" + errors.map(JSON.stringify).join(\", \");\n }\n catch (e) {\n // ignore, see octokit/rest.js#684\n }\n throw error;\n });\n }\n const contentType = response.headers.get(\"content-type\");\n if (/application\\/json/.test(contentType)) {\n return response.json();\n }\n if (!contentType || /^text\\/|charset=utf-8$/.test(contentType)) {\n return response.text();\n }\n return getBuffer(response);\n })\n .then((data) => {\n return {\n status,\n url,\n headers,\n data,\n };\n })\n .catch((error) => {\n if (error instanceof RequestError) {\n throw error;\n }\n throw new RequestError(error.message, 500, {\n headers,\n request: requestOptions,\n });\n });\n}\n","import fetchWrapper from \"./fetch-wrapper\";\nexport default function withDefaults(oldEndpoint, newDefaults) {\n const endpoint = oldEndpoint.defaults(newDefaults);\n const newApi = function (route, parameters) {\n const endpointOptions = endpoint.merge(route, parameters);\n if (!endpointOptions.request || !endpointOptions.request.hook) {\n return fetchWrapper(endpoint.parse(endpointOptions));\n }\n const request = (route, parameters) => {\n return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters)));\n };\n Object.assign(request, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint),\n });\n return endpointOptions.request.hook(request, endpointOptions);\n };\n return Object.assign(newApi, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint),\n });\n}\n","import { endpoint } from \"@octokit/endpoint\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport withDefaults from \"./with-defaults\";\nexport const request = withDefaults(endpoint, {\n headers: {\n \"user-agent\": `octokit-request.js/${VERSION} ${getUserAgent()}`,\n },\n});\n"],"names":["getBuffer"],"mappings":";;;;;;AAAO,MAAM,OAAO,GAAG,mBAAmB;;ACA3B,SAAS,iBAAiB,CAAC,QAAQ,EAAE;AACpD,IAAI,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;AAClC,CAAC;;ACEc,SAAS,YAAY,CAAC,cAAc,EAAE;AACrD,IAAI,IAAI,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC;AAC1C,QAAQ,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;AAC5C,QAAQ,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AAClE,KAAK;AACL,IAAI,IAAI,OAAO,GAAG,EAAE,CAAC;AACrB,IAAI,IAAI,MAAM,CAAC;AACf,IAAI,IAAI,GAAG,CAAC;AACZ,IAAI,MAAM,KAAK,GAAG,CAAC,cAAc,CAAC,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC;AACxF,IAAI,OAAO,KAAK,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC;AACnD,QAAQ,MAAM,EAAE,cAAc,CAAC,MAAM;AACrC,QAAQ,IAAI,EAAE,cAAc,CAAC,IAAI;AACjC,QAAQ,OAAO,EAAE,cAAc,CAAC,OAAO;AACvC,QAAQ,QAAQ,EAAE,cAAc,CAAC,QAAQ;AACzC,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;AAC/B,SAAS,IAAI,CAAC,CAAC,QAAQ,KAAK;AAC5B,QAAQ,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;AAC3B,QAAQ,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;AACjC,QAAQ,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,OAAO,EAAE;AACpD,YAAY,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AACrD,SAAS;AACT,QAAQ,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE;AAC9C,YAAY,OAAO;AACnB,SAAS;AACT;AACA,QAAQ,IAAI,cAAc,CAAC,MAAM,KAAK,MAAM,EAAE;AAC9C,YAAY,IAAI,MAAM,GAAG,GAAG,EAAE;AAC9B,gBAAgB,OAAO;AACvB,aAAa;AACb,YAAY,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE;AAChE,gBAAgB,OAAO;AACvB,gBAAgB,OAAO,EAAE,cAAc;AACvC,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,IAAI,MAAM,KAAK,GAAG,EAAE;AAC5B,YAAY,MAAM,IAAI,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE;AAC3D,gBAAgB,OAAO;AACvB,gBAAgB,OAAO,EAAE,cAAc;AACvC,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,IAAI,MAAM,IAAI,GAAG,EAAE;AAC3B,YAAY,OAAO,QAAQ;AAC3B,iBAAiB,IAAI,EAAE;AACvB,iBAAiB,IAAI,CAAC,CAAC,OAAO,KAAK;AACnC,gBAAgB,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE;AAChE,oBAAoB,OAAO;AAC3B,oBAAoB,OAAO,EAAE,cAAc;AAC3C,iBAAiB,CAAC,CAAC;AACnB,gBAAgB,IAAI;AACpB,oBAAoB,IAAI,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACjE,oBAAoB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;AACvD,oBAAoB,IAAI,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;AACrD;AACA,oBAAoB,KAAK,CAAC,OAAO;AACjC,wBAAwB,KAAK,CAAC,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACrF,iBAAiB;AACjB,gBAAgB,OAAO,CAAC,EAAE;AAC1B;AACA,iBAAiB;AACjB,gBAAgB,MAAM,KAAK,CAAC;AAC5B,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;AACjE,QAAQ,IAAI,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AACnD,YAAY,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACnC,SAAS;AACT,QAAQ,IAAI,CAAC,WAAW,IAAI,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AACxE,YAAY,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACnC,SAAS;AACT,QAAQ,OAAOA,iBAAS,CAAC,QAAQ,CAAC,CAAC;AACnC,KAAK,CAAC;AACN,SAAS,IAAI,CAAC,CAAC,IAAI,KAAK;AACxB,QAAQ,OAAO;AACf,YAAY,MAAM;AAClB,YAAY,GAAG;AACf,YAAY,OAAO;AACnB,YAAY,IAAI;AAChB,SAAS,CAAC;AACV,KAAK,CAAC;AACN,SAAS,KAAK,CAAC,CAAC,KAAK,KAAK;AAC1B,QAAQ,IAAI,KAAK,YAAY,YAAY,EAAE;AAC3C,YAAY,MAAM,KAAK,CAAC;AACxB,SAAS;AACT,QAAQ,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE;AACnD,YAAY,OAAO;AACnB,YAAY,OAAO,EAAE,cAAc;AACnC,SAAS,CAAC,CAAC;AACX,KAAK,CAAC,CAAC;AACP,CAAC;;AC3Fc,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;AAC/D,IAAI,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AACvD,IAAI,MAAM,MAAM,GAAG,UAAU,KAAK,EAAE,UAAU,EAAE;AAChD,QAAQ,MAAM,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AAClE,QAAQ,IAAI,CAAC,eAAe,CAAC,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE;AACvE,YAAY,OAAO,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;AACjE,SAAS;AACT,QAAQ,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK;AAC/C,YAAY,OAAO,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;AACnF,SAAS,CAAC;AACV,QAAQ,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;AAC/B,YAAY,QAAQ;AACpB,YAAY,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACvD,SAAS,CAAC,CAAC;AACX,QAAQ,OAAO,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AACtE,KAAK,CAAC;AACN,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;AACjC,QAAQ,QAAQ;AAChB,QAAQ,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACnD,KAAK,CAAC,CAAC;AACP,CAAC;;ACjBW,MAAC,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE;AAC9C,IAAI,OAAO,EAAE;AACb,QAAQ,YAAY,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AACvE,KAAK;AACL,CAAC,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/LICENSE.md b/node_modules/@octokit/request/node_modules/universal-user-agent/LICENSE.md deleted file mode 100644 index f105ab0..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/LICENSE.md +++ /dev/null @@ -1,7 +0,0 @@ -# [ISC License](https://spdx.org/licenses/ISC) - -Copyright (c) 2018, Gregor Martynus (https://github.com/gr2m) - -Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/README.md b/node_modules/@octokit/request/node_modules/universal-user-agent/README.md deleted file mode 100644 index d00d14c..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# universal-user-agent - -> Get a user agent string in both browser and node - -[![@latest](https://img.shields.io/npm/v/universal-user-agent.svg)](https://www.npmjs.com/package/universal-user-agent) -[![Build Status](https://travis-ci.com/gr2m/universal-user-agent.svg?branch=master)](https://travis-ci.com/gr2m/universal-user-agent) -[![Greenkeeper](https://badges.greenkeeper.io/gr2m/universal-user-agent.svg)](https://greenkeeper.io/) - -```js -const { getUserAgent } = require("universal-user-agent"); -// or import { getUserAgent } from "universal-user-agent"; - -const userAgent = getUserAgent(); -// userAgent will look like this -// in browser: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:61.0) Gecko/20100101 Firefox/61.0" -// in node: Node.js/v8.9.4 (macOS High Sierra; x64) -``` - -## Credits - -The Node implementation was originally inspired by [default-user-agent](https://www.npmjs.com/package/default-user-agent). - -## License - -[ISC](LICENSE.md) diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js deleted file mode 100644 index 80a0710..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js +++ /dev/null @@ -1,22 +0,0 @@ -'use strict'; - -Object.defineProperty(exports, '__esModule', { value: true }); - -function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } - -var osName = _interopDefault(require('os-name')); - -function getUserAgent() { - try { - return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; - } catch (error) { - if (/wmic os get Caption/.test(error.message)) { - return "Windows "; - } - - throw error; - } -} - -exports.getUserAgent = getUserAgent; -//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js.map b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js.map deleted file mode 100644 index aff09ec..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.js","sources":["../dist-src/node.js"],"sourcesContent":["import osName from \"os-name\";\nexport function getUserAgent() {\n try {\n return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`;\n }\n catch (error) {\n if (/wmic os get Caption/.test(error.message)) {\n return \"Windows \";\n }\n throw error;\n }\n}\n"],"names":["getUserAgent","process","version","substr","osName","arch","error","test","message"],"mappings":";;;;;;;;AACO,SAASA,YAAT,GAAwB;MACvB;WACQ,WAAUC,OAAO,CAACC,OAAR,CAAgBC,MAAhB,CAAuB,CAAvB,CAA0B,KAAIC,MAAM,EAAG,KAAIH,OAAO,CAACI,IAAK,GAA1E;GADJ,CAGA,OAAOC,KAAP,EAAc;QACN,sBAAsBC,IAAtB,CAA2BD,KAAK,CAACE,OAAjC,CAAJ,EAA+C;aACpC,gCAAP;;;UAEEF,KAAN;;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/browser.js b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/browser.js deleted file mode 100644 index 6f52232..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/browser.js +++ /dev/null @@ -1,3 +0,0 @@ -export function getUserAgent() { - return navigator.userAgent; -} diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/index.js b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/index.js deleted file mode 100644 index c6253f5..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/index.js +++ /dev/null @@ -1 +0,0 @@ -export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/node.js b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/node.js deleted file mode 100644 index 8b70a03..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/node.js +++ /dev/null @@ -1,12 +0,0 @@ -import osName from "os-name"; -export function getUserAgent() { - try { - return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; - } - catch (error) { - if (/wmic os get Caption/.test(error.message)) { - return "Windows "; - } - throw error; - } -} diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/browser.d.ts b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/browser.d.ts deleted file mode 100644 index a7bb1c4..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/browser.d.ts +++ /dev/null @@ -1 +0,0 @@ -export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/index.d.ts b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/index.d.ts deleted file mode 100644 index c6253f5..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/index.d.ts +++ /dev/null @@ -1 +0,0 @@ -export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/node.d.ts b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/node.d.ts deleted file mode 100644 index a7bb1c4..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/node.d.ts +++ /dev/null @@ -1 +0,0 @@ -export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js deleted file mode 100644 index 11ec79b..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js +++ /dev/null @@ -1,6 +0,0 @@ -function getUserAgent() { - return navigator.userAgent; -} - -export { getUserAgent }; -//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js.map b/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js.map deleted file mode 100644 index 549407e..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.js","sources":["../dist-src/browser.js"],"sourcesContent":["export function getUserAgent() {\n return navigator.userAgent;\n}\n"],"names":[],"mappings":"AAAO,SAAS,YAAY,GAAG;IAC3B,OAAO,SAAS,CAAC,SAAS,CAAC;CAC9B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/node_modules/universal-user-agent/package.json b/node_modules/@octokit/request/node_modules/universal-user-agent/package.json deleted file mode 100644 index d366be6..0000000 --- a/node_modules/@octokit/request/node_modules/universal-user-agent/package.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "_from": "universal-user-agent@^4.0.0", - "_id": "universal-user-agent@4.0.0", - "_inBundle": false, - "_integrity": "sha512-eM8knLpev67iBDizr/YtqkJsF3GK8gzDc6st/WKzrTuPtcsOKW/0IdL4cnMBsU69pOx0otavLWBDGTwg+dB0aA==", - "_location": "/@octokit/request/universal-user-agent", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "universal-user-agent@^4.0.0", - "name": "universal-user-agent", - "escapedName": "universal-user-agent", - "rawSpec": "^4.0.0", - "saveSpec": null, - "fetchSpec": "^4.0.0" - }, - "_requiredBy": [ - "/@octokit/request" - ], - "_resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-4.0.0.tgz", - "_shasum": "27da2ec87e32769619f68a14996465ea1cb9df16", - "_spec": "universal-user-agent@^4.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/request", - "bugs": { - "url": "https://github.com/gr2m/universal-user-agent/issues" - }, - "bundleDependencies": false, - "dependencies": { - "os-name": "^3.1.0" - }, - "deprecated": false, - "description": "Get a user agent string in both browser and node", - "devDependencies": { - "@gr2m/pika-plugin-build-web": "^0.6.0-issue-84.1", - "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.6.0", - "@pika/plugin-ts-standard-pkg": "^0.6.0", - "@types/jest": "^24.0.18", - "jest": "^24.9.0", - "prettier": "^1.18.2", - "semantic-release": "^15.9.15", - "ts-jest": "^24.0.2", - "typescript": "^3.6.2" - }, - "files": [ - "dist-*/", - "bin/" - ], - "homepage": "https://github.com/gr2m/universal-user-agent#readme", - "keywords": [], - "license": "ISC", - "main": "dist-node/index.js", - "module": "dist-web/index.js", - "name": "universal-user-agent", - "pika": true, - "repository": { - "type": "git", - "url": "git+https://github.com/gr2m/universal-user-agent.git" - }, - "sideEffects": false, - "source": "dist-src/index.js", - "types": "dist-types/index.d.ts", - "version": "4.0.0" -} diff --git a/node_modules/@octokit/request/package.json b/node_modules/@octokit/request/package.json index 192ced4..3f2e55f 100644 --- a/node_modules/@octokit/request/package.json +++ b/node_modules/@octokit/request/package.json @@ -1,68 +1,68 @@ { - "_from": "@octokit/request@^5.0.0", - "_id": "@octokit/request@5.3.1", + "_args": [ + [ + "@octokit/request@5.4.12", + "." + ] + ], + "_from": "@octokit/request@5.4.12", + "_id": "@octokit/request@5.4.12", "_inBundle": false, - "_integrity": "sha512-5/X0AL1ZgoU32fAepTfEoggFinO3rxsMLtzhlUX+RctLrusn/CApJuGFCd0v7GMFhF+8UiCsTTfsu7Fh1HnEJg==", + "_integrity": "sha512-MvWYdxengUWTGFpfpefBBpVmmEYfkwMoxonIB3sUGp5rhdgwjXL1ejo6JbgzG/QD9B/NYt/9cJX1pxXeSIUCkg==", "_location": "/@octokit/request", - "_phantomChildren": { - "os-name": "3.1.0" - }, + "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "@octokit/request@^5.0.0", + "raw": "@octokit/request@5.4.12", "name": "@octokit/request", "escapedName": "@octokit%2frequest", "scope": "@octokit", - "rawSpec": "^5.0.0", + "rawSpec": "5.4.12", "saveSpec": null, - "fetchSpec": "^5.0.0" + "fetchSpec": "5.4.12" }, "_requiredBy": [ - "/@octokit/graphql", - "/@octokit/rest" + "/@octokit/core", + "/@octokit/graphql" ], - "_resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.3.1.tgz", - "_shasum": "3a1ace45e6f88b1be4749c5da963b3a3b4a2f120", - "_spec": "@octokit/request@^5.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/graphql", + "_resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.12.tgz", + "_spec": "5.4.12", + "_where": ".", "bugs": { "url": "https://github.com/octokit/request.js/issues" }, - "bundleDependencies": false, - "deno": "dist-web/index.js", "dependencies": { - "@octokit/endpoint": "^5.5.0", - "@octokit/request-error": "^1.0.1", - "@octokit/types": "^2.0.0", + "@octokit/endpoint": "^6.0.1", + "@octokit/request-error": "^2.0.0", + "@octokit/types": "^6.0.3", "deprecation": "^2.0.0", - "is-plain-object": "^3.0.0", - "node-fetch": "^2.3.0", + "is-plain-object": "^5.0.0", + "node-fetch": "^2.6.1", "once": "^1.4.0", - "universal-user-agent": "^4.0.0" + "universal-user-agent": "^6.0.0" }, - "deprecated": false, "description": "Send parameterized requests to GitHub’s APIs with sensible defaults in browsers and Node", "devDependencies": { "@octokit/auth-app": "^2.1.2", "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.7.0", - "@pika/plugin-build-web": "^0.7.0", - "@pika/plugin-ts-standard-pkg": "^0.7.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", "@types/fetch-mock": "^7.2.4", - "@types/jest": "^24.0.12", - "@types/lolex": "^3.1.1", - "@types/node": "^12.0.3", + "@types/jest": "^26.0.0", + "@types/lolex": "^5.1.0", + "@types/node": "^14.0.0", "@types/node-fetch": "^2.3.3", "@types/once": "^1.4.0", - "fetch-mock": "^7.2.0", - "jest": "^24.7.1", - "lolex": "^5.0.0", - "prettier": "^1.17.0", - "semantic-release": "^15.13.27", + "fetch-mock": "^9.3.1", + "jest": "^26.0.1", + "lolex": "^6.0.0", + "prettier": "^2.0.1", + "semantic-release": "^17.0.0", "semantic-release-plugin-update-version-in-files": "^1.0.0", - "ts-jest": "^24.0.2", - "typescript": "^3.4.5" + "ts-jest": "^26.1.0", + "typescript": "^4.0.2" }, "files": [ "dist-*/", @@ -77,6 +77,7 @@ ], "license": "MIT", "main": "dist-node/index.js", + "module": "dist-web/index.js", "name": "@octokit/request", "pika": true, "publishConfig": { @@ -89,5 +90,5 @@ "sideEffects": false, "source": "dist-src/index.js", "types": "dist-types/index.d.ts", - "version": "5.3.1" + "version": "5.4.12" } diff --git a/node_modules/@octokit/rest/LICENSE b/node_modules/@octokit/rest/LICENSE deleted file mode 100644 index 4c0d268..0000000 --- a/node_modules/@octokit/rest/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -The MIT License - -Copyright (c) 2012 Cloud9 IDE, Inc. (Mike de Boer) -Copyright (c) 2017-2018 Octokit contributors - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/node_modules/@octokit/rest/README.md b/node_modules/@octokit/rest/README.md deleted file mode 100644 index 2a31824..0000000 --- a/node_modules/@octokit/rest/README.md +++ /dev/null @@ -1,46 +0,0 @@ -# rest.js - -> GitHub REST API client for JavaScript - -[![@latest](https://img.shields.io/npm/v/@octokit/rest.svg)](https://www.npmjs.com/package/@octokit/rest) -![Build Status](https://github.com/octokit/rest.js/workflows/Test/badge.svg) -[![Greenkeeper](https://badges.greenkeeper.io/octokit/rest.js.svg)](https://greenkeeper.io/) - -## Installation - -```shell -npm install @octokit/rest -``` - -## Usage - -```js -const Octokit = require("@octokit/rest"); -const octokit = new Octokit(); - -// Compare: https://developer.github.com/v3/repos/#list-organization-repositories -octokit.repos - .listForOrg({ - org: "octokit", - type: "public" - }) - .then(({ data }) => { - // handle data - }); -``` - -See https://octokit.github.io/rest.js/ for full documentation. - -## Contributing - -We would love you to contribute to `@octokit/rest`, pull requests are very welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information. - -## Credits - -`@octokit/rest` was originally created as [`node-github`](https://www.npmjs.com/package/github) in 2012 by Mike de Boer from Cloud9 IDE, Inc. - -It was adopted and renamed by GitHub in 2017 - -## LICENSE - -[MIT](LICENSE) diff --git a/node_modules/@octokit/rest/index.d.ts b/node_modules/@octokit/rest/index.d.ts deleted file mode 100644 index a455028..0000000 --- a/node_modules/@octokit/rest/index.d.ts +++ /dev/null @@ -1,36064 +0,0 @@ -/** - * This file is generated based on https://github.com/octokit/routes/ & "npm run build:ts". - * - * DO NOT EDIT MANUALLY. - */ - -/** - * This declaration file requires TypeScript 3.1 or above. - */ - -/// - -import * as http from "http"; - -declare namespace Octokit { - type json = any; - type date = string; - - export interface Static { - plugin(plugin: Plugin): Static; - new (options?: Octokit.Options): Octokit; - } - - export interface Response { - /** This is the data you would see in https://developer.github.com/v3/ */ - data: T; - - /** Response status number */ - status: number; - - /** Response headers */ - headers: { - date: string; - "x-ratelimit-limit": string; - "x-ratelimit-remaining": string; - "x-ratelimit-reset": string; - "x-Octokit-request-id": string; - "x-Octokit-media-type": string; - link: string; - "last-modified": string; - etag: string; - status: string; - }; - - [Symbol.iterator](): Iterator; - } - - export type AnyResponse = Response; - - export interface EmptyParams {} - - export interface Options { - auth?: - | string - | { username: string; password: string; on2fa: () => Promise } - | { clientId: string; clientSecret: string } - | { (): string | Promise }; - userAgent?: string; - previews?: string[]; - baseUrl?: string; - log?: { - debug?: (message: string, info?: object) => void; - info?: (message: string, info?: object) => void; - warn?: (message: string, info?: object) => void; - error?: (message: string, info?: object) => void; - }; - request?: { - agent?: http.Agent; - timeout?: number; - }; - timeout?: number; // Deprecated - headers?: { [header: string]: any }; // Deprecated - agent?: http.Agent; // Deprecated - [option: string]: any; - } - - export type RequestMethod = - | "DELETE" - | "GET" - | "HEAD" - | "PATCH" - | "POST" - | "PUT"; - - export interface EndpointOptions { - baseUrl?: string; - method?: RequestMethod; - url?: string; - headers?: { [header: string]: any }; - data?: any; - request?: { [option: string]: any }; - [parameter: string]: any; - } - - export interface RequestOptions { - method?: RequestMethod; - url?: string; - headers?: RequestHeaders; - body?: any; - request?: OctokitRequestOptions; - /** - * Media type options, see {@link https://developer.github.com/v3/media/|GitHub Developer Guide} - */ - mediaType?: { - /** - * `json` by default. Can be `raw`, `text`, `html`, `full`, `diff`, `patch`, `sha`, `base64`. Depending on endpoint - */ - format?: string; - - /** - * Custom media type names of {@link https://developer.github.com/v3/media/|API Previews} without the `-preview` suffix. - * Example for single preview: `['squirrel-girl']`. - * Example for multiple previews: `['squirrel-girl', 'mister-fantastic']`. - */ - previews?: string[]; - }; - } - - export type RequestHeaders = { - /** - * Avoid setting `accept`, use `mediaFormat.{format|previews}` instead. - */ - accept?: string; - /** - * Use `authorization` to send authenticated request, remember `token ` / `bearer ` prefixes. Example: `token 1234567890abcdef1234567890abcdef12345678` - */ - authorization?: string; - /** - * `user-agent` is set do a default and can be overwritten as needed. - */ - "user-agent"?: string; - - [header: string]: string | number | undefined; - }; - - export type OctokitRequestOptions = { - /** - * Node only. Useful for custom proxy, certificate, or dns lookup. - */ - agent?: http.Agent; - /** - * Custom replacement for built-in fetch method. Useful for testing or request hooks. - */ - fetch?: any; - /** - * Use an `AbortController` instance to cancel a request. In node you can only cancel streamed requests. - */ - signal?: any; - /** - * Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). `options.request.signal` is recommended instead. - */ - timeout?: number; - - [option: string]: any; - }; - - export interface Log { - debug: (message: string, additionalInfo?: object) => void; - info: (message: string, additionalInfo?: object) => void; - warn: (message: string, additionalInfo?: object) => void; - error: (message: string, additionalInfo?: object) => void; - } - - export interface Endpoint { - ( - Route: string, - EndpointOptions?: Octokit.EndpointOptions - ): Octokit.RequestOptions; - (EndpointOptions: Octokit.EndpointOptions): Octokit.RequestOptions; - /** - * Current default options - */ - DEFAULTS: Octokit.EndpointOptions; - /** - * Get the defaulted endpoint options, but without parsing them into request options: - */ - merge( - Route: string, - EndpointOptions?: Octokit.EndpointOptions - ): Octokit.RequestOptions; - merge(EndpointOptions: Octokit.EndpointOptions): Octokit.RequestOptions; - /** - * Stateless method to turn endpoint options into request options. Calling endpoint(options) is the same as calling endpoint.parse(endpoint.merge(options)). - */ - parse(EndpointOptions: Octokit.EndpointOptions): Octokit.RequestOptions; - /** - * Merges existing defaults with passed options and returns new endpoint() method with new defaults - */ - defaults(EndpointOptions: Octokit.EndpointOptions): Octokit.Endpoint; - } - - export interface Request { - (Route: string, EndpointOptions?: Octokit.EndpointOptions): Promise< - Octokit.AnyResponse - >; - (EndpointOptions: Octokit.EndpointOptions): Promise; - endpoint: Octokit.Endpoint; - } - - export interface AuthBasic { - type: "basic"; - username: string; - password: string; - } - - export interface AuthOAuthToken { - type: "oauth"; - token: string; - } - - export interface AuthOAuthSecret { - type: "oauth"; - key: string; - secret: string; - } - - export interface AuthUserToken { - type: "token"; - token: string; - } - - export interface AuthJWT { - type: "app"; - token: string; - } - - export type Link = { link: string } | { headers: { link: string } } | string; - - export interface Callback { - (error: Error | null, result: T): any; - } - - export type Plugin = (octokit: Octokit, options: Octokit.Options) => void; - - // See https://github.com/octokit/request.js#request - export type HookOptions = { - baseUrl: string; - headers: { [header: string]: string }; - method: string; - url: string; - data: any; - // See https://github.com/bitinn/node-fetch#options - request: { - follow?: number; - timeout?: number; - compress?: boolean; - size?: number; - agent?: string | null; - }; - [index: string]: any; - }; - - export type HookError = Error & { - status: number; - headers: { [header: string]: string }; - documentation_url?: string; - errors?: [ - { - resource: string; - field: string; - code: string; - } - ]; - }; - - export interface Paginate { - ( - Route: string, - EndpointOptions?: Octokit.EndpointOptions, - callback?: (response: Octokit.AnyResponse, done: () => void) => any - ): Promise; - ( - EndpointOptions: Octokit.EndpointOptions, - callback?: (response: Octokit.AnyResponse, done: () => void) => any - ): Promise; - iterator: ( - EndpointOptions: Octokit.EndpointOptions - ) => AsyncIterableIterator; - } - - // response types - type UsersUpdateAuthenticatedResponsePlan = { - collaborators: number; - name: string; - private_repos: number; - space: number; - }; - type UsersUpdateAuthenticatedResponse = { - avatar_url: string; - bio: string; - blog: string; - collaborators: number; - company: string; - created_at: string; - disk_usage: number; - email: string; - events_url: string; - followers: number; - followers_url: string; - following: number; - following_url: string; - gists_url: string; - gravatar_id: string; - hireable: boolean; - html_url: string; - id: number; - location: string; - login: string; - name: string; - node_id: string; - organizations_url: string; - owned_private_repos: number; - plan: UsersUpdateAuthenticatedResponsePlan; - private_gists: number; - public_gists: number; - public_repos: number; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - total_private_repos: number; - two_factor_authentication: boolean; - type: string; - updated_at: string; - url: string; - }; - type UsersTogglePrimaryEmailVisibilityResponseItem = { - email: string; - primary: boolean; - verified: boolean; - visibility: string; - }; - type UsersListPublicKeysForUserResponseItem = { id: number; key: string }; - type UsersListPublicKeysResponseItem = { - created_at: string; - id: number; - key: string; - read_only: boolean; - title: string; - url: string; - verified: boolean; - }; - type UsersListPublicEmailsResponseItem = { - email: string; - primary: boolean; - verified: boolean; - visibility: string; - }; - type UsersListGpgKeysForUserResponseItemSubkeysItem = { - can_certify: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; - can_sign: boolean; - created_at: string; - emails: Array; - expires_at: null; - id: number; - key_id: string; - primary_key_id: number; - public_key: string; - subkeys: Array; - }; - type UsersListGpgKeysForUserResponseItemEmailsItem = { - email: string; - verified: boolean; - }; - type UsersListGpgKeysForUserResponseItem = { - can_certify: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; - can_sign: boolean; - created_at: string; - emails: Array; - expires_at: null; - id: number; - key_id: string; - primary_key_id: null; - public_key: string; - subkeys: Array; - }; - type UsersListGpgKeysResponseItemSubkeysItem = { - can_certify: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; - can_sign: boolean; - created_at: string; - emails: Array; - expires_at: null; - id: number; - key_id: string; - primary_key_id: number; - public_key: string; - subkeys: Array; - }; - type UsersListGpgKeysResponseItemEmailsItem = { - email: string; - verified: boolean; - }; - type UsersListGpgKeysResponseItem = { - can_certify: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; - can_sign: boolean; - created_at: string; - emails: Array; - expires_at: null; - id: number; - key_id: string; - primary_key_id: null; - public_key: string; - subkeys: Array; - }; - type UsersListFollowingForUserResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type UsersListFollowingForAuthenticatedUserResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type UsersListFollowersForUserResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type UsersListFollowersForAuthenticatedUserResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type UsersListEmailsResponseItem = { - email: string; - primary: boolean; - verified: boolean; - visibility: string; - }; - type UsersListBlockedResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type UsersListResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type UsersGetPublicKeyResponse = { - created_at: string; - id: number; - key: string; - read_only: boolean; - title: string; - url: string; - verified: boolean; - }; - type UsersGetGpgKeyResponseSubkeysItem = { - can_certify: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; - can_sign: boolean; - created_at: string; - emails: Array; - expires_at: null; - id: number; - key_id: string; - primary_key_id: number; - public_key: string; - subkeys: Array; - }; - type UsersGetGpgKeyResponseEmailsItem = { email: string; verified: boolean }; - type UsersGetGpgKeyResponse = { - can_certify: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; - can_sign: boolean; - created_at: string; - emails: Array; - expires_at: null; - id: number; - key_id: string; - primary_key_id: null; - public_key: string; - subkeys: Array; - }; - type UsersGetContextForUserResponseContextsItem = { - message: string; - octicon: string; - }; - type UsersGetContextForUserResponse = { - contexts: Array; - }; - type UsersGetByUsernameResponsePlan = { - collaborators: number; - name: string; - private_repos: number; - space: number; - }; - type UsersGetByUsernameResponse = { - avatar_url: string; - bio: string; - blog: string; - company: string; - created_at: string; - email: string; - events_url: string; - followers: number; - followers_url: string; - following: number; - following_url: string; - gists_url: string; - gravatar_id: string; - hireable: boolean; - html_url: string; - id: number; - location: string; - login: string; - name: string; - node_id: string; - organizations_url: string; - public_gists: number; - public_repos: number; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - updated_at: string; - url: string; - plan?: UsersGetByUsernameResponsePlan; - }; - type UsersGetAuthenticatedResponsePlan = { - collaborators: number; - name: string; - private_repos: number; - space: number; - }; - type UsersGetAuthenticatedResponse = { - avatar_url: string; - bio: string; - blog: string; - collaborators?: number; - company: string; - created_at: string; - disk_usage?: number; - email: string; - events_url: string; - followers: number; - followers_url: string; - following: number; - following_url: string; - gists_url: string; - gravatar_id: string; - hireable: boolean; - html_url: string; - id: number; - location: string; - login: string; - name: string; - node_id: string; - organizations_url: string; - owned_private_repos?: number; - plan?: UsersGetAuthenticatedResponsePlan; - private_gists?: number; - public_gists: number; - public_repos: number; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - total_private_repos?: number; - two_factor_authentication?: boolean; - type: string; - updated_at: string; - url: string; - }; - type UsersCreatePublicKeyResponse = { - created_at: string; - id: number; - key: string; - read_only: boolean; - title: string; - url: string; - verified: boolean; - }; - type UsersCreateGpgKeyResponseSubkeysItem = { - can_certify: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; - can_sign: boolean; - created_at: string; - emails: Array; - expires_at: null; - id: number; - key_id: string; - primary_key_id: number; - public_key: string; - subkeys: Array; - }; - type UsersCreateGpgKeyResponseEmailsItem = { - email: string; - verified: boolean; - }; - type UsersCreateGpgKeyResponse = { - can_certify: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; - can_sign: boolean; - created_at: string; - emails: Array; - expires_at: null; - id: number; - key_id: string; - primary_key_id: null; - public_key: string; - subkeys: Array; - }; - type UsersAddEmailsResponseItem = { - email: string; - primary: boolean; - verified: boolean; - visibility: string | null; - }; - type TeamsUpdateDiscussionCommentResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; - }; - type TeamsUpdateDiscussionCommentResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsUpdateDiscussionCommentResponse = { - author: TeamsUpdateDiscussionCommentResponseAuthor; - body: string; - body_html: string; - body_version: string; - created_at: string; - discussion_url: string; - html_url: string; - last_edited_at: string; - node_id: string; - number: number; - reactions: TeamsUpdateDiscussionCommentResponseReactions; - updated_at: string; - url: string; - }; - type TeamsUpdateDiscussionResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; - }; - type TeamsUpdateDiscussionResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsUpdateDiscussionResponse = { - author: TeamsUpdateDiscussionResponseAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; - comments_url: string; - created_at: string; - html_url: string; - last_edited_at: string; - node_id: string; - number: number; - pinned: boolean; - private: boolean; - reactions: TeamsUpdateDiscussionResponseReactions; - team_url: string; - title: string; - updated_at: string; - url: string; - }; - type TeamsUpdateResponseOrganization = { - avatar_url: string; - blog: string; - company: string; - created_at: string; - description: string; - email: string; - events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; - hooks_url: string; - html_url: string; - id: number; - is_verified: boolean; - issues_url: string; - location: string; - login: string; - members_url: string; - name: string; - node_id: string; - public_gists: number; - public_members_url: string; - public_repos: number; - repos_url: string; - type: string; - url: string; - }; - type TeamsUpdateResponse = { - created_at: string; - description: string; - html_url: string; - id: number; - members_count: number; - members_url: string; - name: string; - node_id: string; - organization: TeamsUpdateResponseOrganization; - parent: null; - permission: string; - privacy: string; - repos_count: number; - repositories_url: string; - slug: string; - updated_at: string; - url: string; - }; - type TeamsReviewProjectResponsePermissions = { - admin: boolean; - read: boolean; - write: boolean; - }; - type TeamsReviewProjectResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsReviewProjectResponse = { - body: string; - columns_url: string; - created_at: string; - creator: TeamsReviewProjectResponseCreator; - html_url: string; - id: number; - name: string; - node_id: string; - number: number; - organization_permission: string; - owner_url: string; - permissions: TeamsReviewProjectResponsePermissions; - private: boolean; - state: string; - updated_at: string; - url: string; - }; - type TeamsListReposResponseItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type TeamsListReposResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsListReposResponseItemLicense = { - key: string; - name: string; - node_id: string; - spdx_id: string; - url: string; - }; - type TeamsListReposResponseItem = { - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - license: TeamsListReposResponseItemLicense; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: TeamsListReposResponseItemOwner; - permissions: TeamsListReposResponseItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type TeamsListProjectsResponseItemPermissions = { - admin: boolean; - read: boolean; - write: boolean; - }; - type TeamsListProjectsResponseItemCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsListProjectsResponseItem = { - body: string; - columns_url: string; - created_at: string; - creator: TeamsListProjectsResponseItemCreator; - html_url: string; - id: number; - name: string; - node_id: string; - number: number; - organization_permission: string; - owner_url: string; - permissions: TeamsListProjectsResponseItemPermissions; - private: boolean; - state: string; - updated_at: string; - url: string; - }; - type TeamsListPendingInvitationsResponseItemInviter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsListPendingInvitationsResponseItem = { - created_at: string; - email: string; - id: number; - invitation_team_url: string; - inviter: TeamsListPendingInvitationsResponseItemInviter; - login: string; - role: string; - team_count: number; - }; - type TeamsListMembersResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsListForAuthenticatedUserResponseItemOrganization = { - avatar_url: string; - blog: string; - company: string; - created_at: string; - description: string; - email: string; - events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; - hooks_url: string; - html_url: string; - id: number; - is_verified: boolean; - issues_url: string; - location: string; - login: string; - members_url: string; - name: string; - node_id: string; - public_gists: number; - public_members_url: string; - public_repos: number; - repos_url: string; - type: string; - url: string; - }; - type TeamsListForAuthenticatedUserResponseItem = { - created_at: string; - description: string; - html_url: string; - id: number; - members_count: number; - members_url: string; - name: string; - node_id: string; - organization: TeamsListForAuthenticatedUserResponseItemOrganization; - parent: null; - permission: string; - privacy: string; - repos_count: number; - repositories_url: string; - slug: string; - updated_at: string; - url: string; - }; - type TeamsListDiscussionsResponseItemReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; - }; - type TeamsListDiscussionsResponseItemAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsListDiscussionsResponseItem = { - author: TeamsListDiscussionsResponseItemAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; - comments_url: string; - created_at: string; - html_url: string; - last_edited_at: null; - node_id: string; - number: number; - pinned: boolean; - private: boolean; - reactions: TeamsListDiscussionsResponseItemReactions; - team_url: string; - title: string; - updated_at: string; - url: string; - }; - type TeamsListDiscussionCommentsResponseItemReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; - }; - type TeamsListDiscussionCommentsResponseItemAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsListDiscussionCommentsResponseItem = { - author: TeamsListDiscussionCommentsResponseItemAuthor; - body: string; - body_html: string; - body_version: string; - created_at: string; - discussion_url: string; - html_url: string; - last_edited_at: null; - node_id: string; - number: number; - reactions: TeamsListDiscussionCommentsResponseItemReactions; - updated_at: string; - url: string; - }; - type TeamsListChildResponseItemParent = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type TeamsListChildResponseItem = { - description: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: TeamsListChildResponseItemParent; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type TeamsListResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type TeamsGetMembershipResponse = { - role: string; - state: string; - url: string; - }; - type TeamsGetDiscussionCommentResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; - }; - type TeamsGetDiscussionCommentResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsGetDiscussionCommentResponse = { - author: TeamsGetDiscussionCommentResponseAuthor; - body: string; - body_html: string; - body_version: string; - created_at: string; - discussion_url: string; - html_url: string; - last_edited_at: null; - node_id: string; - number: number; - reactions: TeamsGetDiscussionCommentResponseReactions; - updated_at: string; - url: string; - }; - type TeamsGetDiscussionResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; - }; - type TeamsGetDiscussionResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsGetDiscussionResponse = { - author: TeamsGetDiscussionResponseAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; - comments_url: string; - created_at: string; - html_url: string; - last_edited_at: null; - node_id: string; - number: number; - pinned: boolean; - private: boolean; - reactions: TeamsGetDiscussionResponseReactions; - team_url: string; - title: string; - updated_at: string; - url: string; - }; - type TeamsGetByNameResponseOrganization = { - avatar_url: string; - blog: string; - company: string; - created_at: string; - description: string; - email: string; - events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; - hooks_url: string; - html_url: string; - id: number; - is_verified: boolean; - issues_url: string; - location: string; - login: string; - members_url: string; - name: string; - node_id: string; - public_gists: number; - public_members_url: string; - public_repos: number; - repos_url: string; - type: string; - url: string; - }; - type TeamsGetByNameResponse = { - created_at: string; - description: string; - html_url: string; - id: number; - members_count: number; - members_url: string; - name: string; - node_id: string; - organization: TeamsGetByNameResponseOrganization; - parent: null; - permission: string; - privacy: string; - repos_count: number; - repositories_url: string; - slug: string; - updated_at: string; - url: string; - }; - type TeamsGetResponseOrganization = { - avatar_url: string; - blog: string; - company: string; - created_at: string; - description: string; - email: string; - events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; - hooks_url: string; - html_url: string; - id: number; - is_verified: boolean; - issues_url: string; - location: string; - login: string; - members_url: string; - name: string; - node_id: string; - public_gists: number; - public_members_url: string; - public_repos: number; - repos_url: string; - type: string; - url: string; - }; - type TeamsGetResponse = { - created_at: string; - description: string; - html_url: string; - id: number; - members_count: number; - members_url: string; - name: string; - node_id: string; - organization: TeamsGetResponseOrganization; - parent: null; - permission: string; - privacy: string; - repos_count: number; - repositories_url: string; - slug: string; - updated_at: string; - url: string; - }; - type TeamsCreateDiscussionCommentResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; - }; - type TeamsCreateDiscussionCommentResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsCreateDiscussionCommentResponse = { - author: TeamsCreateDiscussionCommentResponseAuthor; - body: string; - body_html: string; - body_version: string; - created_at: string; - discussion_url: string; - html_url: string; - last_edited_at: null; - node_id: string; - number: number; - reactions: TeamsCreateDiscussionCommentResponseReactions; - updated_at: string; - url: string; - }; - type TeamsCreateDiscussionResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; - }; - type TeamsCreateDiscussionResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsCreateDiscussionResponse = { - author: TeamsCreateDiscussionResponseAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; - comments_url: string; - created_at: string; - html_url: string; - last_edited_at: null; - node_id: string; - number: number; - pinned: boolean; - private: boolean; - reactions: TeamsCreateDiscussionResponseReactions; - team_url: string; - title: string; - updated_at: string; - url: string; - }; - type TeamsCreateResponseOrganization = { - avatar_url: string; - blog: string; - company: string; - created_at: string; - description: string; - email: string; - events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; - hooks_url: string; - html_url: string; - id: number; - is_verified: boolean; - issues_url: string; - location: string; - login: string; - members_url: string; - name: string; - node_id: string; - public_gists: number; - public_members_url: string; - public_repos: number; - repos_url: string; - type: string; - url: string; - }; - type TeamsCreateResponse = { - created_at: string; - description: string; - html_url: string; - id: number; - members_count: number; - members_url: string; - name: string; - node_id: string; - organization: TeamsCreateResponseOrganization; - parent: null; - permission: string; - privacy: string; - repos_count: number; - repositories_url: string; - slug: string; - updated_at: string; - url: string; - }; - type TeamsCheckManagesRepoResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type TeamsCheckManagesRepoResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type TeamsCheckManagesRepoResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: TeamsCheckManagesRepoResponseOwner; - permissions: TeamsCheckManagesRepoResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type TeamsAddOrUpdateProjectResponse = { - documentation_url: string; - message: string; - }; - type TeamsAddOrUpdateMembershipResponse = { - role: string; - state: string; - url: string; - }; - type TeamsAddMemberResponseErrorsItem = { - code: string; - field: string; - resource: string; - }; - type TeamsAddMemberResponse = { - errors: Array; - message: string; - }; - type SearchUsersResponseItemsItem = { - avatar_url: string; - followers_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - score: number; - subscriptions_url: string; - type: string; - url: string; - }; - type SearchUsersResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; - }; - type SearchTopicsResponseItemsItem = { - created_at: string; - created_by: string; - curated: boolean; - description: string; - display_name: string; - featured: boolean; - name: string; - released: string; - score: number; - short_description: string; - updated_at: string; - }; - type SearchTopicsResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; - }; - type SearchReposResponseItemsItemOwner = { - avatar_url: string; - gravatar_id: string; - id: number; - login: string; - node_id: string; - received_events_url: string; - type: string; - url: string; - }; - type SearchReposResponseItemsItem = { - created_at: string; - default_branch: string; - description: string; - fork: boolean; - forks_count: number; - full_name: string; - homepage: string; - html_url: string; - id: number; - language: string; - master_branch: string; - name: string; - node_id: string; - open_issues_count: number; - owner: SearchReposResponseItemsItemOwner; - private: boolean; - pushed_at: string; - score: number; - size: number; - stargazers_count: number; - updated_at: string; - url: string; - watchers_count: number; - }; - type SearchReposResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; - }; - type SearchLabelsResponseItemsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - score: number; - url: string; - }; - type SearchLabelsResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; - }; - type SearchIssuesAndPullRequestsResponseItemsItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type SearchIssuesAndPullRequestsResponseItemsItemPullRequest = { - diff_url: null; - html_url: null; - patch_url: null; - }; - type SearchIssuesAndPullRequestsResponseItemsItemLabelsItem = { - color: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type SearchIssuesAndPullRequestsResponseItemsItem = { - assignee: null; - body: string; - closed_at: null; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - milestone: null; - node_id: string; - number: number; - pull_request: SearchIssuesAndPullRequestsResponseItemsItemPullRequest; - repository_url: string; - score: number; - state: string; - title: string; - updated_at: string; - url: string; - user: SearchIssuesAndPullRequestsResponseItemsItemUser; - }; - type SearchIssuesAndPullRequestsResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; - }; - type SearchIssuesResponseItemsItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type SearchIssuesResponseItemsItemPullRequest = { - diff_url: null; - html_url: null; - patch_url: null; - }; - type SearchIssuesResponseItemsItemLabelsItem = { - color: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type SearchIssuesResponseItemsItem = { - assignee: null; - body: string; - closed_at: null; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - milestone: null; - node_id: string; - number: number; - pull_request: SearchIssuesResponseItemsItemPullRequest; - repository_url: string; - score: number; - state: string; - title: string; - updated_at: string; - url: string; - user: SearchIssuesResponseItemsItemUser; - }; - type SearchIssuesResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; - }; - type SearchCommitsResponseItemsItemRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type SearchCommitsResponseItemsItemRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - hooks_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: SearchCommitsResponseItemsItemRepositoryOwner; - private: boolean; - pulls_url: string; - releases_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; - }; - type SearchCommitsResponseItemsItemParentsItem = { - html_url: string; - sha: string; - url: string; - }; - type SearchCommitsResponseItemsItemCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type SearchCommitsResponseItemsItemCommitTree = { sha: string; url: string }; - type SearchCommitsResponseItemsItemCommitCommitter = { - date: string; - email: string; - name: string; - }; - type SearchCommitsResponseItemsItemCommitAuthor = { - date: string; - email: string; - name: string; - }; - type SearchCommitsResponseItemsItemCommit = { - author: SearchCommitsResponseItemsItemCommitAuthor; - comment_count: number; - committer: SearchCommitsResponseItemsItemCommitCommitter; - message: string; - tree: SearchCommitsResponseItemsItemCommitTree; - url: string; - }; - type SearchCommitsResponseItemsItemAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type SearchCommitsResponseItemsItem = { - author: SearchCommitsResponseItemsItemAuthor; - comments_url: string; - commit: SearchCommitsResponseItemsItemCommit; - committer: SearchCommitsResponseItemsItemCommitter; - html_url: string; - parents: Array; - repository: SearchCommitsResponseItemsItemRepository; - score: number; - sha: string; - url: string; - }; - type SearchCommitsResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; - }; - type SearchCodeResponseItemsItemRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type SearchCodeResponseItemsItemRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - hooks_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: SearchCodeResponseItemsItemRepositoryOwner; - private: boolean; - pulls_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; - }; - type SearchCodeResponseItemsItem = { - git_url: string; - html_url: string; - name: string; - path: string; - repository: SearchCodeResponseItemsItemRepository; - score: number; - sha: string; - url: string; - }; - type SearchCodeResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; - }; - type ReposUploadReleaseAssetResponseValueUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUploadReleaseAssetResponseValue = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposUploadReleaseAssetResponseValueUploader; - url: string; - }; - type ReposUploadReleaseAssetResponse = { - value: ReposUploadReleaseAssetResponseValue; - }; - type ReposUpdateReleaseAssetResponseUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateReleaseAssetResponse = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposUpdateReleaseAssetResponseUploader; - url: string; - }; - type ReposUpdateReleaseResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateReleaseResponseAssetsItemUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateReleaseResponseAssetsItem = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposUpdateReleaseResponseAssetsItemUploader; - url: string; - }; - type ReposUpdateReleaseResponse = { - assets: Array; - assets_url: string; - author: ReposUpdateReleaseResponseAuthor; - body: string; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string; - node_id: string; - prerelease: boolean; - published_at: string; - tag_name: string; - tarball_url: string; - target_commitish: string; - upload_url: string; - url: string; - zipball_url: string; - }; - type ReposUpdateProtectedBranchRequiredStatusChecksResponse = { - contexts: Array; - contexts_url: string; - strict: boolean; - url: string; - }; - type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions = { - teams: Array< - ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem - >; - teams_url: string; - url: string; - users: Array< - ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem - >; - users_url: string; - }; - type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponse = { - dismiss_stale_reviews: boolean; - dismissal_restrictions: ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions; - require_code_owner_reviews: boolean; - required_approving_review_count: number; - url: string; - }; - type ReposUpdateInvitationResponseRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateInvitationResponseRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: ReposUpdateInvitationResponseRepositoryOwner; - private: boolean; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; - }; - type ReposUpdateInvitationResponseInviter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateInvitationResponseInvitee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateInvitationResponse = { - created_at: string; - html_url: string; - id: number; - invitee: ReposUpdateInvitationResponseInvitee; - inviter: ReposUpdateInvitationResponseInviter; - permissions: string; - repository: ReposUpdateInvitationResponseRepository; - url: string; - }; - type ReposUpdateHookResponseLastResponse = { - code: null; - message: null; - status: string; - }; - type ReposUpdateHookResponseConfig = { - content_type: string; - insecure_ssl: string; - url: string; - }; - type ReposUpdateHookResponse = { - active: boolean; - config: ReposUpdateHookResponseConfig; - created_at: string; - events: Array; - id: number; - last_response: ReposUpdateHookResponseLastResponse; - name: string; - ping_url: string; - test_url: string; - type: string; - updated_at: string; - url: string; - }; - type ReposUpdateFileResponseContentLinks = { - git: string; - html: string; - self: string; - }; - type ReposUpdateFileResponseContent = { - _links: ReposUpdateFileResponseContentLinks; - download_url: string; - git_url: string; - html_url: string; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; - }; - type ReposUpdateFileResponseCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type ReposUpdateFileResponseCommitTree = { sha: string; url: string }; - type ReposUpdateFileResponseCommitParentsItem = { - html_url: string; - sha: string; - url: string; - }; - type ReposUpdateFileResponseCommitCommitter = { - date: string; - email: string; - name: string; - }; - type ReposUpdateFileResponseCommitAuthor = { - date: string; - email: string; - name: string; - }; - type ReposUpdateFileResponseCommit = { - author: ReposUpdateFileResponseCommitAuthor; - committer: ReposUpdateFileResponseCommitCommitter; - html_url: string; - message: string; - node_id: string; - parents: Array; - sha: string; - tree: ReposUpdateFileResponseCommitTree; - url: string; - verification: ReposUpdateFileResponseCommitVerification; - }; - type ReposUpdateFileResponse = { - commit: ReposUpdateFileResponseCommit; - content: ReposUpdateFileResponseContent; - }; - type ReposUpdateCommitCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateCommitCommentResponse = { - body: string; - commit_id: string; - created_at: string; - html_url: string; - id: number; - line: number; - node_id: string; - path: string; - position: number; - updated_at: string; - url: string; - user: ReposUpdateCommitCommentResponseUser; - }; - type ReposUpdateBranchProtectionResponseRestrictionsUsersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateBranchProtectionResponseRestrictionsTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposUpdateBranchProtectionResponseRestrictionsAppsItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ReposUpdateBranchProtectionResponseRestrictionsAppsItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ReposUpdateBranchProtectionResponseRestrictionsAppsItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposUpdateBranchProtectionResponseRestrictionsAppsItemOwner; - permissions: ReposUpdateBranchProtectionResponseRestrictionsAppsItemPermissions; - slug: string; - updated_at: string; - }; - type ReposUpdateBranchProtectionResponseRestrictions = { - apps: Array; - apps_url: string; - teams: Array; - teams_url: string; - url: string; - users: Array; - users_url: string; - }; - type ReposUpdateBranchProtectionResponseRequiredStatusChecks = { - contexts: Array; - contexts_url: string; - strict: boolean; - url: string; - }; - type ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions = { - teams: Array< - ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem - >; - teams_url: string; - url: string; - users: Array< - ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem - >; - users_url: string; - }; - type ReposUpdateBranchProtectionResponseRequiredPullRequestReviews = { - dismiss_stale_reviews: boolean; - dismissal_restrictions: ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions; - require_code_owner_reviews: boolean; - required_approving_review_count: number; - url: string; - }; - type ReposUpdateBranchProtectionResponseEnforceAdmins = { - enabled: boolean; - url: string; - }; - type ReposUpdateBranchProtectionResponse = { - enforce_admins: ReposUpdateBranchProtectionResponseEnforceAdmins; - required_pull_request_reviews: ReposUpdateBranchProtectionResponseRequiredPullRequestReviews; - required_status_checks: ReposUpdateBranchProtectionResponseRequiredStatusChecks; - restrictions: ReposUpdateBranchProtectionResponseRestrictions; - url: string; - }; - type ReposUpdateResponseSourcePermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposUpdateResponseSourceOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateResponseSource = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposUpdateResponseSourceOwner; - permissions: ReposUpdateResponseSourcePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposUpdateResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposUpdateResponseParentPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposUpdateResponseParentOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateResponseParent = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposUpdateResponseParentOwner; - permissions: ReposUpdateResponseParentPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposUpdateResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateResponseOrganization = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposUpdateResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - organization: ReposUpdateResponseOrganization; - owner: ReposUpdateResponseOwner; - parent: ReposUpdateResponseParent; - permissions: ReposUpdateResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - source: ReposUpdateResponseSource; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposTransferResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposTransferResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposTransferResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposTransferResponseOwner; - permissions: ReposTransferResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposRetrieveCommunityProfileMetricsResponseFilesReadme = { - html_url: string; - url: string; - }; - type ReposRetrieveCommunityProfileMetricsResponseFilesPullRequestTemplate = { - html_url: string; - url: string; - }; - type ReposRetrieveCommunityProfileMetricsResponseFilesLicense = { - html_url: string; - key: string; - name: string; - spdx_id: string; - url: string; - }; - type ReposRetrieveCommunityProfileMetricsResponseFilesIssueTemplate = { - html_url: string; - url: string; - }; - type ReposRetrieveCommunityProfileMetricsResponseFilesContributing = { - html_url: string; - url: string; - }; - type ReposRetrieveCommunityProfileMetricsResponseFilesCodeOfConduct = { - html_url: string; - key: string; - name: string; - url: string; - }; - type ReposRetrieveCommunityProfileMetricsResponseFiles = { - code_of_conduct: ReposRetrieveCommunityProfileMetricsResponseFilesCodeOfConduct; - contributing: ReposRetrieveCommunityProfileMetricsResponseFilesContributing; - issue_template: ReposRetrieveCommunityProfileMetricsResponseFilesIssueTemplate; - license: ReposRetrieveCommunityProfileMetricsResponseFilesLicense; - pull_request_template: ReposRetrieveCommunityProfileMetricsResponseFilesPullRequestTemplate; - readme: ReposRetrieveCommunityProfileMetricsResponseFilesReadme; - }; - type ReposRetrieveCommunityProfileMetricsResponse = { - description: string; - documentation: boolean; - files: ReposRetrieveCommunityProfileMetricsResponseFiles; - health_percentage: number; - updated_at: string; - }; - type ReposRequestPageBuildResponse = { status: string; url: string }; - type ReposReplaceTopicsResponse = { names: Array }; - type ReposReplaceProtectedBranchUserRestrictionsResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposReplaceProtectedBranchTeamRestrictionsResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposReplaceProtectedBranchAppRestrictionsResponseItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ReposReplaceProtectedBranchAppRestrictionsResponseItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ReposReplaceProtectedBranchAppRestrictionsResponseItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposReplaceProtectedBranchAppRestrictionsResponseItemOwner; - permissions: ReposReplaceProtectedBranchAppRestrictionsResponseItemPermissions; - slug: string; - updated_at: string; - }; - type ReposRemoveProtectedBranchUserRestrictionsResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposRemoveProtectedBranchTeamRestrictionsResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposRemoveProtectedBranchAppRestrictionsResponseItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ReposRemoveProtectedBranchAppRestrictionsResponseItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ReposRemoveProtectedBranchAppRestrictionsResponseItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposRemoveProtectedBranchAppRestrictionsResponseItemOwner; - permissions: ReposRemoveProtectedBranchAppRestrictionsResponseItemPermissions; - slug: string; - updated_at: string; - }; - type ReposMergeResponseParentsItem = { sha: string; url: string }; - type ReposMergeResponseCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposMergeResponseCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type ReposMergeResponseCommitTree = { sha: string; url: string }; - type ReposMergeResponseCommitCommitter = { - date: string; - email: string; - name: string; - }; - type ReposMergeResponseCommitAuthor = { - date: string; - email: string; - name: string; - }; - type ReposMergeResponseCommit = { - author: ReposMergeResponseCommitAuthor; - comment_count: number; - committer: ReposMergeResponseCommitCommitter; - message: string; - tree: ReposMergeResponseCommitTree; - url: string; - verification: ReposMergeResponseCommitVerification; - }; - type ReposMergeResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposMergeResponse = { - author: ReposMergeResponseAuthor; - comments_url: string; - commit: ReposMergeResponseCommit; - committer: ReposMergeResponseCommitter; - html_url: string; - node_id: string; - parents: Array; - sha: string; - url: string; - }; - type ReposListUsersWithAccessToProtectedBranchResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListTopicsResponse = { names: Array }; - type ReposListTeamsWithAccessToProtectedBranchResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposListTeamsResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposListTagsResponseItemCommit = { sha: string; url: string }; - type ReposListTagsResponseItem = { - commit: ReposListTagsResponseItemCommit; - name: string; - tarball_url: string; - zipball_url: string; - }; - type ReposListStatusesForRefResponseItemCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListStatusesForRefResponseItem = { - avatar_url: string; - context: string; - created_at: string; - creator: ReposListStatusesForRefResponseItemCreator; - description: string; - id: number; - node_id: string; - state: string; - target_url: string; - updated_at: string; - url: string; - }; - type ReposListReleasesResponseItemAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListReleasesResponseItemAssetsItemUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListReleasesResponseItemAssetsItem = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposListReleasesResponseItemAssetsItemUploader; - url: string; - }; - type ReposListReleasesResponseItem = { - assets: Array; - assets_url: string; - author: ReposListReleasesResponseItemAuthor; - body: string; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string; - node_id: string; - prerelease: boolean; - published_at: string; - tag_name: string; - tarball_url: string; - target_commitish: string; - upload_url: string; - url: string; - zipball_url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemRequestedTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemRequestedReviewersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: ReposListPullRequestsAssociatedWithCommitResponseItemMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemHeadUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner; - permissions: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemHead = { - label: string; - ref: string; - repo: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepo; - sha: string; - user: ReposListPullRequestsAssociatedWithCommitResponseItemHeadUser; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemBaseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner; - permissions: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemBase = { - label: string; - ref: string; - repo: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepo; - sha: string; - user: ReposListPullRequestsAssociatedWithCommitResponseItemBaseUser; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemLinksStatuses = { - href: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemLinksSelf = { - href: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComments = { - href: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComment = { - href: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemLinksIssue = { - href: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemLinksHtml = { - href: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemLinksCommits = { - href: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemLinksComments = { - href: string; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItemLinks = { - comments: ReposListPullRequestsAssociatedWithCommitResponseItemLinksComments; - commits: ReposListPullRequestsAssociatedWithCommitResponseItemLinksCommits; - html: ReposListPullRequestsAssociatedWithCommitResponseItemLinksHtml; - issue: ReposListPullRequestsAssociatedWithCommitResponseItemLinksIssue; - review_comment: ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComment; - review_comments: ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComments; - self: ReposListPullRequestsAssociatedWithCommitResponseItemLinksSelf; - statuses: ReposListPullRequestsAssociatedWithCommitResponseItemLinksStatuses; - }; - type ReposListPullRequestsAssociatedWithCommitResponseItem = { - _links: ReposListPullRequestsAssociatedWithCommitResponseItemLinks; - active_lock_reason: string; - assignee: ReposListPullRequestsAssociatedWithCommitResponseItemAssignee; - assignees: Array< - ReposListPullRequestsAssociatedWithCommitResponseItemAssigneesItem - >; - author_association: string; - base: ReposListPullRequestsAssociatedWithCommitResponseItemBase; - body: string; - closed_at: string; - comments_url: string; - commits_url: string; - created_at: string; - diff_url: string; - draft: boolean; - head: ReposListPullRequestsAssociatedWithCommitResponseItemHead; - html_url: string; - id: number; - issue_url: string; - labels: Array< - ReposListPullRequestsAssociatedWithCommitResponseItemLabelsItem - >; - locked: boolean; - merge_commit_sha: string; - merged_at: string; - milestone: ReposListPullRequestsAssociatedWithCommitResponseItemMilestone; - node_id: string; - number: number; - patch_url: string; - requested_reviewers: Array< - ReposListPullRequestsAssociatedWithCommitResponseItemRequestedReviewersItem - >; - requested_teams: Array< - ReposListPullRequestsAssociatedWithCommitResponseItemRequestedTeamsItem - >; - review_comment_url: string; - review_comments_url: string; - state: string; - statuses_url: string; - title: string; - updated_at: string; - url: string; - user: ReposListPullRequestsAssociatedWithCommitResponseItemUser; - }; - type ReposListPublicResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListPublicResponseItem = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: ReposListPublicResponseItemOwner; - private: boolean; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; - }; - type ReposListProtectedBranchUserRestrictionsResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListProtectedBranchTeamRestrictionsResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposListPagesBuildsResponseItemPusher = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListPagesBuildsResponseItemError = { message: null }; - type ReposListPagesBuildsResponseItem = { - commit: string; - created_at: string; - duration: number; - error: ReposListPagesBuildsResponseItemError; - pusher: ReposListPagesBuildsResponseItemPusher; - status: string; - updated_at: string; - url: string; - }; - type ReposListLanguagesResponse = { C: number; Python: number }; - type ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListInvitationsForAuthenticatedUserResponseItemRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner; - private: boolean; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; - }; - type ReposListInvitationsForAuthenticatedUserResponseItemInviter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListInvitationsForAuthenticatedUserResponseItemInvitee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListInvitationsForAuthenticatedUserResponseItem = { - created_at: string; - html_url: string; - id: number; - invitee: ReposListInvitationsForAuthenticatedUserResponseItemInvitee; - inviter: ReposListInvitationsForAuthenticatedUserResponseItemInviter; - permissions: string; - repository: ReposListInvitationsForAuthenticatedUserResponseItemRepository; - url: string; - }; - type ReposListInvitationsResponseItemRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListInvitationsResponseItemRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: ReposListInvitationsResponseItemRepositoryOwner; - private: boolean; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; - }; - type ReposListInvitationsResponseItemInviter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListInvitationsResponseItemInvitee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListInvitationsResponseItem = { - created_at: string; - html_url: string; - id: number; - invitee: ReposListInvitationsResponseItemInvitee; - inviter: ReposListInvitationsResponseItemInviter; - permissions: string; - repository: ReposListInvitationsResponseItemRepository; - url: string; - }; - type ReposListHooksResponseItemLastResponse = { - code: null; - message: null; - status: string; - }; - type ReposListHooksResponseItemConfig = { - content_type: string; - insecure_ssl: string; - url: string; - }; - type ReposListHooksResponseItem = { - active: boolean; - config: ReposListHooksResponseItemConfig; - created_at: string; - events: Array; - id: number; - last_response: ReposListHooksResponseItemLastResponse; - name: string; - ping_url: string; - test_url: string; - type: string; - updated_at: string; - url: string; - }; - type ReposListForksResponseItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposListForksResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListForksResponseItemLicense = { - key: string; - name: string; - node_id: string; - spdx_id: string; - url: string; - }; - type ReposListForksResponseItem = { - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - license: ReposListForksResponseItemLicense; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposListForksResponseItemOwner; - permissions: ReposListForksResponseItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposListForOrgResponseItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposListForOrgResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListForOrgResponseItemLicense = { - key: string; - name: string; - node_id: string; - spdx_id: string; - url: string; - }; - type ReposListForOrgResponseItem = { - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - license: ReposListForOrgResponseItemLicense; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposListForOrgResponseItemOwner; - permissions: ReposListForOrgResponseItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposListDownloadsResponseItem = { - content_type: string; - description: string; - download_count: number; - html_url: string; - id: number; - name: string; - size: number; - url: string; - }; - type ReposListDeploymentsResponseItemPayload = { deploy: string }; - type ReposListDeploymentsResponseItemCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListDeploymentsResponseItem = { - created_at: string; - creator: ReposListDeploymentsResponseItemCreator; - description: string; - environment: string; - id: number; - node_id: string; - original_environment: string; - payload: ReposListDeploymentsResponseItemPayload; - production_environment: boolean; - ref: string; - repository_url: string; - sha: string; - statuses_url: string; - task: string; - transient_environment: boolean; - updated_at: string; - url: string; - }; - type ReposListDeploymentStatusesResponseItemCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListDeploymentStatusesResponseItem = { - created_at: string; - creator: ReposListDeploymentStatusesResponseItemCreator; - deployment_url: string; - description: string; - environment: string; - environment_url: string; - id: number; - log_url: string; - node_id: string; - repository_url: string; - state: string; - target_url: string; - updated_at: string; - url: string; - }; - type ReposListDeployKeysResponseItem = { - created_at: string; - id: number; - key: string; - read_only: boolean; - title: string; - url: string; - verified: boolean; - }; - type ReposListContributorsResponseItem = { - avatar_url: string; - contributions: number; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListCommitsResponseItemParentsItem = { sha: string; url: string }; - type ReposListCommitsResponseItemCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListCommitsResponseItemCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type ReposListCommitsResponseItemCommitTree = { sha: string; url: string }; - type ReposListCommitsResponseItemCommitCommitter = { - date: string; - email: string; - name: string; - }; - type ReposListCommitsResponseItemCommitAuthor = { - date: string; - email: string; - name: string; - }; - type ReposListCommitsResponseItemCommit = { - author: ReposListCommitsResponseItemCommitAuthor; - comment_count: number; - committer: ReposListCommitsResponseItemCommitCommitter; - message: string; - tree: ReposListCommitsResponseItemCommitTree; - url: string; - verification: ReposListCommitsResponseItemCommitVerification; - }; - type ReposListCommitsResponseItemAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListCommitsResponseItem = { - author: ReposListCommitsResponseItemAuthor; - comments_url: string; - commit: ReposListCommitsResponseItemCommit; - committer: ReposListCommitsResponseItemCommitter; - html_url: string; - node_id: string; - parents: Array; - sha: string; - url: string; - }; - type ReposListCommitCommentsResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListCommitCommentsResponseItem = { - body: string; - commit_id: string; - created_at: string; - html_url: string; - id: number; - line: number; - node_id: string; - path: string; - position: number; - updated_at: string; - url: string; - user: ReposListCommitCommentsResponseItemUser; - }; - type ReposListCommentsForCommitResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListCommentsForCommitResponseItem = { - body: string; - commit_id: string; - created_at: string; - html_url: string; - id: number; - line: number; - node_id: string; - path: string; - position: number; - updated_at: string; - url: string; - user: ReposListCommentsForCommitResponseItemUser; - }; - type ReposListCollaboratorsResponseItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposListCollaboratorsResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - permissions: ReposListCollaboratorsResponseItemPermissions; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListBranchesForHeadCommitResponseItemCommit = { - sha: string; - url: string; - }; - type ReposListBranchesForHeadCommitResponseItem = { - commit: ReposListBranchesForHeadCommitResponseItemCommit; - name: string; - protected: string; - }; - type ReposListBranchesResponseItemProtectionRequiredStatusChecks = { - contexts: Array; - enforcement_level: string; - }; - type ReposListBranchesResponseItemProtection = { - enabled: boolean; - required_status_checks: ReposListBranchesResponseItemProtectionRequiredStatusChecks; - }; - type ReposListBranchesResponseItemCommit = { sha: string; url: string }; - type ReposListBranchesResponseItem = { - commit: ReposListBranchesResponseItemCommit; - name: string; - protected: boolean; - protection: ReposListBranchesResponseItemProtection; - protection_url: string; - }; - type ReposListAssetsForReleaseResponseItemUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposListAssetsForReleaseResponseItem = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposListAssetsForReleaseResponseItemUploader; - url: string; - }; - type ReposListAppsWithAccessToProtectedBranchResponseItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ReposListAppsWithAccessToProtectedBranchResponseItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ReposListAppsWithAccessToProtectedBranchResponseItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposListAppsWithAccessToProtectedBranchResponseItemOwner; - permissions: ReposListAppsWithAccessToProtectedBranchResponseItemPermissions; - slug: string; - updated_at: string; - }; - type ReposGetViewsResponseViewsItem = { - count: number; - timestamp: string; - uniques: number; - }; - type ReposGetViewsResponse = { - count: number; - uniques: number; - views: Array; - }; - type ReposGetUsersWithAccessToProtectedBranchResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetTopReferrersResponseItem = { - count: number; - referrer: string; - uniques: number; - }; - type ReposGetTopPathsResponseItem = { - count: number; - path: string; - title: string; - uniques: number; - }; - type ReposGetTeamsWithAccessToProtectedBranchResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposGetReleaseByTagResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetReleaseByTagResponseAssetsItemUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetReleaseByTagResponseAssetsItem = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposGetReleaseByTagResponseAssetsItemUploader; - url: string; - }; - type ReposGetReleaseByTagResponse = { - assets: Array; - assets_url: string; - author: ReposGetReleaseByTagResponseAuthor; - body: string; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string; - node_id: string; - prerelease: boolean; - published_at: string; - tag_name: string; - tarball_url: string; - target_commitish: string; - upload_url: string; - url: string; - zipball_url: string; - }; - type ReposGetReleaseAssetResponseUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetReleaseAssetResponse = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposGetReleaseAssetResponseUploader; - url: string; - }; - type ReposGetReleaseResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetReleaseResponseAssetsItemUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetReleaseResponseAssetsItem = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposGetReleaseResponseAssetsItemUploader; - url: string; - }; - type ReposGetReleaseResponse = { - assets: Array; - assets_url: string; - author: ReposGetReleaseResponseAuthor; - body: string; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string; - node_id: string; - prerelease: boolean; - published_at: string; - tag_name: string; - tarball_url: string; - target_commitish: string; - upload_url: string; - url: string; - zipball_url: string; - }; - type ReposGetReadmeResponseLinks = { - git: string; - html: string; - self: string; - }; - type ReposGetReadmeResponse = { - _links: ReposGetReadmeResponseLinks; - content: string; - download_url: string; - encoding: string; - git_url: string; - html_url: string; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; - }; - type ReposGetProtectedBranchRestrictionsResponseUsersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetProtectedBranchRestrictionsResponseTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposGetProtectedBranchRestrictionsResponseAppsItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ReposGetProtectedBranchRestrictionsResponseAppsItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ReposGetProtectedBranchRestrictionsResponseAppsItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposGetProtectedBranchRestrictionsResponseAppsItemOwner; - permissions: ReposGetProtectedBranchRestrictionsResponseAppsItemPermissions; - slug: string; - updated_at: string; - }; - type ReposGetProtectedBranchRestrictionsResponse = { - apps: Array; - apps_url: string; - teams: Array; - teams_url: string; - url: string; - users: Array; - users_url: string; - }; - type ReposGetProtectedBranchRequiredStatusChecksResponse = { - contexts: Array; - contexts_url: string; - strict: boolean; - url: string; - }; - type ReposGetProtectedBranchRequiredSignaturesResponse = { - enabled: boolean; - url: string; - }; - type ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions = { - teams: Array< - ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem - >; - teams_url: string; - url: string; - users: Array< - ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem - >; - users_url: string; - }; - type ReposGetProtectedBranchPullRequestReviewEnforcementResponse = { - dismiss_stale_reviews: boolean; - dismissal_restrictions: ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions; - require_code_owner_reviews: boolean; - required_approving_review_count: number; - url: string; - }; - type ReposGetProtectedBranchAdminEnforcementResponse = { - enabled: boolean; - url: string; - }; - type ReposGetParticipationStatsResponse = { - all: Array; - owner: Array; - }; - type ReposGetPagesBuildResponsePusher = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetPagesBuildResponseError = { message: null }; - type ReposGetPagesBuildResponse = { - commit: string; - created_at: string; - duration: number; - error: ReposGetPagesBuildResponseError; - pusher: ReposGetPagesBuildResponsePusher; - status: string; - updated_at: string; - url: string; - }; - type ReposGetPagesResponseSource = { branch: string; directory: string }; - type ReposGetPagesResponse = { - cname: string; - custom_404: boolean; - html_url: string; - source: ReposGetPagesResponseSource; - status: string; - url: string; - }; - type ReposGetLatestReleaseResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetLatestReleaseResponseAssetsItemUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetLatestReleaseResponseAssetsItem = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposGetLatestReleaseResponseAssetsItemUploader; - url: string; - }; - type ReposGetLatestReleaseResponse = { - assets: Array; - assets_url: string; - author: ReposGetLatestReleaseResponseAuthor; - body: string; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string; - node_id: string; - prerelease: boolean; - published_at: string; - tag_name: string; - tarball_url: string; - target_commitish: string; - upload_url: string; - url: string; - zipball_url: string; - }; - type ReposGetLatestPagesBuildResponsePusher = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetLatestPagesBuildResponseError = { message: null }; - type ReposGetLatestPagesBuildResponse = { - commit: string; - created_at: string; - duration: number; - error: ReposGetLatestPagesBuildResponseError; - pusher: ReposGetLatestPagesBuildResponsePusher; - status: string; - updated_at: string; - url: string; - }; - type ReposGetHookResponseLastResponse = { - code: null; - message: null; - status: string; - }; - type ReposGetHookResponseConfig = { - content_type: string; - insecure_ssl: string; - url: string; - }; - type ReposGetHookResponse = { - active: boolean; - config: ReposGetHookResponseConfig; - created_at: string; - events: Array; - id: number; - last_response: ReposGetHookResponseLastResponse; - name: string; - ping_url: string; - test_url: string; - type: string; - updated_at: string; - url: string; - }; - type ReposGetDownloadResponse = { - content_type: string; - description: string; - download_count: number; - html_url: string; - id: number; - name: string; - size: number; - url: string; - }; - type ReposGetDeploymentStatusResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetDeploymentStatusResponse = { - created_at: string; - creator: ReposGetDeploymentStatusResponseCreator; - deployment_url: string; - description: string; - environment: string; - environment_url: string; - id: number; - log_url: string; - node_id: string; - repository_url: string; - state: string; - target_url: string; - updated_at: string; - url: string; - }; - type ReposGetDeploymentResponsePayload = { deploy: string }; - type ReposGetDeploymentResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetDeploymentResponse = { - created_at: string; - creator: ReposGetDeploymentResponseCreator; - description: string; - environment: string; - id: number; - node_id: string; - original_environment: string; - payload: ReposGetDeploymentResponsePayload; - production_environment: boolean; - ref: string; - repository_url: string; - sha: string; - statuses_url: string; - task: string; - transient_environment: boolean; - updated_at: string; - url: string; - }; - type ReposGetDeployKeyResponse = { - created_at: string; - id: number; - key: string; - read_only: boolean; - title: string; - url: string; - verified: boolean; - }; - type ReposGetContributorsStatsResponseItemWeeksItem = { - a: number; - c: number; - d: number; - w: string; - }; - type ReposGetContributorsStatsResponseItemAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetContributorsStatsResponseItem = { - author: ReposGetContributorsStatsResponseItemAuthor; - total: number; - weeks: Array; - }; - type ReposGetContentsResponseItemLinks = { - git: string; - html: string; - self: string; - }; - type ReposGetContentsResponseItem = { - _links: ReposGetContentsResponseItemLinks; - download_url: string | null; - git_url: string; - html_url: string; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; - }; - type ReposGetContentsResponseLinks = { - git: string; - html: string; - self: string; - }; - type ReposGetContentsResponse = - | { - _links: ReposGetContentsResponseLinks; - content?: string; - download_url: string | null; - encoding?: string; - git_url: string; - html_url: string; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; - target?: string; - submodule_git_url?: string; - } - | Array; - type ReposGetCommitCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetCommitCommentResponse = { - body: string; - commit_id: string; - created_at: string; - html_url: string; - id: number; - line: number; - node_id: string; - path: string; - position: number; - updated_at: string; - url: string; - user: ReposGetCommitCommentResponseUser; - }; - type ReposGetCommitActivityStatsResponseItem = { - days: Array; - total: number; - week: number; - }; - type ReposGetCommitResponseStats = { - additions: number; - deletions: number; - total: number; - }; - type ReposGetCommitResponseParentsItem = { sha: string; url: string }; - type ReposGetCommitResponseFilesItem = { - additions: number; - blob_url: string; - changes: number; - deletions: number; - filename: string; - patch: string; - raw_url: string; - status: string; - }; - type ReposGetCommitResponseCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetCommitResponseCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type ReposGetCommitResponseCommitTree = { sha: string; url: string }; - type ReposGetCommitResponseCommitCommitter = { - date: string; - email: string; - name: string; - }; - type ReposGetCommitResponseCommitAuthor = { - date: string; - email: string; - name: string; - }; - type ReposGetCommitResponseCommit = { - author: ReposGetCommitResponseCommitAuthor; - comment_count: number; - committer: ReposGetCommitResponseCommitCommitter; - message: string; - tree: ReposGetCommitResponseCommitTree; - url: string; - verification: ReposGetCommitResponseCommitVerification; - }; - type ReposGetCommitResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetCommitResponse = { - author: ReposGetCommitResponseAuthor; - comments_url: string; - commit: ReposGetCommitResponseCommit; - committer: ReposGetCommitResponseCommitter; - files: Array; - html_url: string; - node_id: string; - parents: Array; - sha: string; - stats: ReposGetCommitResponseStats; - url: string; - }; - type ReposGetCombinedStatusForRefResponseStatusesItem = { - avatar_url: string; - context: string; - created_at: string; - description: string; - id: number; - node_id: string; - state: string; - target_url: string; - updated_at: string; - url: string; - }; - type ReposGetCombinedStatusForRefResponseRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetCombinedStatusForRefResponseRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: ReposGetCombinedStatusForRefResponseRepositoryOwner; - private: boolean; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; - }; - type ReposGetCombinedStatusForRefResponse = { - commit_url: string; - repository: ReposGetCombinedStatusForRefResponseRepository; - sha: string; - state: string; - statuses: Array; - total_count: number; - url: string; - }; - type ReposGetCollaboratorPermissionLevelResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetCollaboratorPermissionLevelResponse = { - permission: string; - user: ReposGetCollaboratorPermissionLevelResponseUser; - }; - type ReposGetClonesResponseClonesItem = { - count: number; - timestamp: string; - uniques: number; - }; - type ReposGetClonesResponse = { - clones: Array; - count: number; - uniques: number; - }; - type ReposGetBranchProtectionResponseRestrictionsUsersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetBranchProtectionResponseRestrictionsTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposGetBranchProtectionResponseRestrictionsAppsItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ReposGetBranchProtectionResponseRestrictionsAppsItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ReposGetBranchProtectionResponseRestrictionsAppsItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposGetBranchProtectionResponseRestrictionsAppsItemOwner; - permissions: ReposGetBranchProtectionResponseRestrictionsAppsItemPermissions; - slug: string; - updated_at: string; - }; - type ReposGetBranchProtectionResponseRestrictions = { - apps: Array; - apps_url: string; - teams: Array; - teams_url: string; - url: string; - users: Array; - users_url: string; - }; - type ReposGetBranchProtectionResponseRequiredStatusChecks = { - contexts: Array; - contexts_url: string; - strict: boolean; - url: string; - }; - type ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions = { - teams: Array< - ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem - >; - teams_url: string; - url: string; - users: Array< - ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem - >; - users_url: string; - }; - type ReposGetBranchProtectionResponseRequiredPullRequestReviews = { - dismiss_stale_reviews: boolean; - dismissal_restrictions: ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions; - require_code_owner_reviews: boolean; - required_approving_review_count: number; - url: string; - }; - type ReposGetBranchProtectionResponseEnforceAdmins = { - enabled: boolean; - url: string; - }; - type ReposGetBranchProtectionResponse = { - enforce_admins: ReposGetBranchProtectionResponseEnforceAdmins; - required_pull_request_reviews: ReposGetBranchProtectionResponseRequiredPullRequestReviews; - required_status_checks: ReposGetBranchProtectionResponseRequiredStatusChecks; - restrictions: ReposGetBranchProtectionResponseRestrictions; - url: string; - }; - type ReposGetBranchResponseProtectionRequiredStatusChecks = { - contexts: Array; - enforcement_level: string; - }; - type ReposGetBranchResponseProtection = { - enabled: boolean; - required_status_checks: ReposGetBranchResponseProtectionRequiredStatusChecks; - }; - type ReposGetBranchResponseCommitParentsItem = { sha: string; url: string }; - type ReposGetBranchResponseCommitCommitter = { - avatar_url: string; - gravatar_id: string; - id: number; - login: string; - url: string; - }; - type ReposGetBranchResponseCommitCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type ReposGetBranchResponseCommitCommitTree = { sha: string; url: string }; - type ReposGetBranchResponseCommitCommitCommitter = { - date: string; - email: string; - name: string; - }; - type ReposGetBranchResponseCommitCommitAuthor = { - date: string; - email: string; - name: string; - }; - type ReposGetBranchResponseCommitCommit = { - author: ReposGetBranchResponseCommitCommitAuthor; - committer: ReposGetBranchResponseCommitCommitCommitter; - message: string; - tree: ReposGetBranchResponseCommitCommitTree; - url: string; - verification: ReposGetBranchResponseCommitCommitVerification; - }; - type ReposGetBranchResponseCommitAuthor = { - avatar_url: string; - gravatar_id: string; - id: number; - login: string; - url: string; - }; - type ReposGetBranchResponseCommit = { - author: ReposGetBranchResponseCommitAuthor; - commit: ReposGetBranchResponseCommitCommit; - committer: ReposGetBranchResponseCommitCommitter; - node_id: string; - parents: Array; - sha: string; - url: string; - }; - type ReposGetBranchResponseLinks = { html: string; self: string }; - type ReposGetBranchResponse = { - _links: ReposGetBranchResponseLinks; - commit: ReposGetBranchResponseCommit; - name: string; - protected: boolean; - protection: ReposGetBranchResponseProtection; - protection_url: string; - }; - type ReposGetAppsWithAccessToProtectedBranchResponseItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ReposGetAppsWithAccessToProtectedBranchResponseItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ReposGetAppsWithAccessToProtectedBranchResponseItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposGetAppsWithAccessToProtectedBranchResponseItemOwner; - permissions: ReposGetAppsWithAccessToProtectedBranchResponseItemPermissions; - slug: string; - updated_at: string; - }; - type ReposGetResponseSourcePermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposGetResponseSourceOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetResponseSource = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposGetResponseSourceOwner; - permissions: ReposGetResponseSourcePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposGetResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposGetResponseParentPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposGetResponseParentOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetResponseParent = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposGetResponseParentOwner; - permissions: ReposGetResponseParentPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposGetResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetResponseOrganization = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposGetResponseLicense = { - key: string; - name: string; - node_id: string; - spdx_id: string; - url: string; - }; - type ReposGetResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - license: ReposGetResponseLicense; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - organization: ReposGetResponseOrganization; - owner: ReposGetResponseOwner; - parent: ReposGetResponseParent; - permissions: ReposGetResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - source: ReposGetResponseSource; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposEnablePagesSiteResponseSource = { - branch: string; - directory: string; - }; - type ReposEnablePagesSiteResponse = { - cname: string; - custom_404: boolean; - html_url: string; - source: ReposEnablePagesSiteResponseSource; - status: string; - url: string; - }; - type ReposDeleteFileResponseCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type ReposDeleteFileResponseCommitTree = { sha: string; url: string }; - type ReposDeleteFileResponseCommitParentsItem = { - html_url: string; - sha: string; - url: string; - }; - type ReposDeleteFileResponseCommitCommitter = { - date: string; - email: string; - name: string; - }; - type ReposDeleteFileResponseCommitAuthor = { - date: string; - email: string; - name: string; - }; - type ReposDeleteFileResponseCommit = { - author: ReposDeleteFileResponseCommitAuthor; - committer: ReposDeleteFileResponseCommitCommitter; - html_url: string; - message: string; - node_id: string; - parents: Array; - sha: string; - tree: ReposDeleteFileResponseCommitTree; - url: string; - verification: ReposDeleteFileResponseCommitVerification; - }; - type ReposDeleteFileResponse = { - commit: ReposDeleteFileResponseCommit; - content: null; - }; - type ReposDeleteResponse = { documentation_url: string; message: string }; - type ReposCreateUsingTemplateResponseTemplateRepositoryPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposCreateUsingTemplateResponseTemplateRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCreateUsingTemplateResponseTemplateRepository = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposCreateUsingTemplateResponseTemplateRepositoryOwner; - permissions: ReposCreateUsingTemplateResponseTemplateRepositoryPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposCreateUsingTemplateResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposCreateUsingTemplateResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCreateUsingTemplateResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposCreateUsingTemplateResponseOwner; - permissions: ReposCreateUsingTemplateResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: ReposCreateUsingTemplateResponseTemplateRepository; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposCreateStatusResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCreateStatusResponse = { - avatar_url: string; - context: string; - created_at: string; - creator: ReposCreateStatusResponseCreator; - description: string; - id: number; - node_id: string; - state: string; - target_url: string; - updated_at: string; - url: string; - }; - type ReposCreateReleaseResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCreateReleaseResponse = { - assets: Array; - assets_url: string; - author: ReposCreateReleaseResponseAuthor; - body: string; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string; - node_id: string; - prerelease: boolean; - published_at: string; - tag_name: string; - tarball_url: string; - target_commitish: string; - upload_url: string; - url: string; - zipball_url: string; - }; - type ReposCreateOrUpdateFileResponseContentLinks = { - git: string; - html: string; - self: string; - }; - type ReposCreateOrUpdateFileResponseContent = { - _links: ReposCreateOrUpdateFileResponseContentLinks; - download_url: string; - git_url: string; - html_url: string; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; - }; - type ReposCreateOrUpdateFileResponseCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type ReposCreateOrUpdateFileResponseCommitTree = { sha: string; url: string }; - type ReposCreateOrUpdateFileResponseCommitParentsItem = { - html_url: string; - sha: string; - url: string; - }; - type ReposCreateOrUpdateFileResponseCommitCommitter = { - date: string; - email: string; - name: string; - }; - type ReposCreateOrUpdateFileResponseCommitAuthor = { - date: string; - email: string; - name: string; - }; - type ReposCreateOrUpdateFileResponseCommit = { - author: ReposCreateOrUpdateFileResponseCommitAuthor; - committer: ReposCreateOrUpdateFileResponseCommitCommitter; - html_url: string; - message: string; - node_id: string; - parents: Array; - sha: string; - tree: ReposCreateOrUpdateFileResponseCommitTree; - url: string; - verification: ReposCreateOrUpdateFileResponseCommitVerification; - }; - type ReposCreateOrUpdateFileResponse = { - commit: ReposCreateOrUpdateFileResponseCommit; - content: ReposCreateOrUpdateFileResponseContent; - }; - type ReposCreateInOrgResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposCreateInOrgResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCreateInOrgResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposCreateInOrgResponseOwner; - permissions: ReposCreateInOrgResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposCreateHookResponseLastResponse = { - code: null; - message: null; - status: string; - }; - type ReposCreateHookResponseConfig = { - content_type: string; - insecure_ssl: string; - url: string; - }; - type ReposCreateHookResponse = { - active: boolean; - config: ReposCreateHookResponseConfig; - created_at: string; - events: Array; - id: number; - last_response: ReposCreateHookResponseLastResponse; - name: string; - ping_url: string; - test_url: string; - type: string; - updated_at: string; - url: string; - }; - type ReposCreateForkResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposCreateForkResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCreateForkResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposCreateForkResponseOwner; - permissions: ReposCreateForkResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposCreateForAuthenticatedUserResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ReposCreateForAuthenticatedUserResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCreateForAuthenticatedUserResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposCreateForAuthenticatedUserResponseOwner; - permissions: ReposCreateForAuthenticatedUserResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ReposCreateFileResponseContentLinks = { - git: string; - html: string; - self: string; - }; - type ReposCreateFileResponseContent = { - _links: ReposCreateFileResponseContentLinks; - download_url: string; - git_url: string; - html_url: string; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; - }; - type ReposCreateFileResponseCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type ReposCreateFileResponseCommitTree = { sha: string; url: string }; - type ReposCreateFileResponseCommitParentsItem = { - html_url: string; - sha: string; - url: string; - }; - type ReposCreateFileResponseCommitCommitter = { - date: string; - email: string; - name: string; - }; - type ReposCreateFileResponseCommitAuthor = { - date: string; - email: string; - name: string; - }; - type ReposCreateFileResponseCommit = { - author: ReposCreateFileResponseCommitAuthor; - committer: ReposCreateFileResponseCommitCommitter; - html_url: string; - message: string; - node_id: string; - parents: Array; - sha: string; - tree: ReposCreateFileResponseCommitTree; - url: string; - verification: ReposCreateFileResponseCommitVerification; - }; - type ReposCreateFileResponse = { - commit: ReposCreateFileResponseCommit; - content: ReposCreateFileResponseContent; - }; - type ReposCreateDeploymentStatusResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCreateDeploymentStatusResponse = { - created_at: string; - creator: ReposCreateDeploymentStatusResponseCreator; - deployment_url: string; - description: string; - environment: string; - environment_url: string; - id: number; - log_url: string; - node_id: string; - repository_url: string; - state: string; - target_url: string; - updated_at: string; - url: string; - }; - type ReposCreateDeploymentResponsePayload = { deploy: string }; - type ReposCreateDeploymentResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCreateDeploymentResponse = { - created_at: string; - creator: ReposCreateDeploymentResponseCreator; - description: string; - environment: string; - id: number; - node_id: string; - original_environment: string; - payload: ReposCreateDeploymentResponsePayload; - production_environment: boolean; - ref: string; - repository_url: string; - sha: string; - statuses_url: string; - task: string; - transient_environment: boolean; - updated_at: string; - url: string; - }; - type ReposCreateCommitCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCreateCommitCommentResponse = { - body: string; - commit_id: string; - created_at: string; - html_url: string; - id: number; - line: number; - node_id: string; - path: string; - position: number; - updated_at: string; - url: string; - user: ReposCreateCommitCommentResponseUser; - }; - type ReposCompareCommitsResponseMergeBaseCommitParentsItem = { - sha: string; - url: string; - }; - type ReposCompareCommitsResponseMergeBaseCommitCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCompareCommitsResponseMergeBaseCommitCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type ReposCompareCommitsResponseMergeBaseCommitCommitTree = { - sha: string; - url: string; - }; - type ReposCompareCommitsResponseMergeBaseCommitCommitCommitter = { - date: string; - email: string; - name: string; - }; - type ReposCompareCommitsResponseMergeBaseCommitCommitAuthor = { - date: string; - email: string; - name: string; - }; - type ReposCompareCommitsResponseMergeBaseCommitCommit = { - author: ReposCompareCommitsResponseMergeBaseCommitCommitAuthor; - comment_count: number; - committer: ReposCompareCommitsResponseMergeBaseCommitCommitCommitter; - message: string; - tree: ReposCompareCommitsResponseMergeBaseCommitCommitTree; - url: string; - verification: ReposCompareCommitsResponseMergeBaseCommitCommitVerification; - }; - type ReposCompareCommitsResponseMergeBaseCommitAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCompareCommitsResponseMergeBaseCommit = { - author: ReposCompareCommitsResponseMergeBaseCommitAuthor; - comments_url: string; - commit: ReposCompareCommitsResponseMergeBaseCommitCommit; - committer: ReposCompareCommitsResponseMergeBaseCommitCommitter; - html_url: string; - node_id: string; - parents: Array; - sha: string; - url: string; - }; - type ReposCompareCommitsResponseFilesItem = { - additions: number; - blob_url: string; - changes: number; - contents_url: string; - deletions: number; - filename: string; - patch: string; - raw_url: string; - sha: string; - status: string; - }; - type ReposCompareCommitsResponseCommitsItemParentsItem = { - sha: string; - url: string; - }; - type ReposCompareCommitsResponseCommitsItemCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCompareCommitsResponseCommitsItemCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type ReposCompareCommitsResponseCommitsItemCommitTree = { - sha: string; - url: string; - }; - type ReposCompareCommitsResponseCommitsItemCommitCommitter = { - date: string; - email: string; - name: string; - }; - type ReposCompareCommitsResponseCommitsItemCommitAuthor = { - date: string; - email: string; - name: string; - }; - type ReposCompareCommitsResponseCommitsItemCommit = { - author: ReposCompareCommitsResponseCommitsItemCommitAuthor; - comment_count: number; - committer: ReposCompareCommitsResponseCommitsItemCommitCommitter; - message: string; - tree: ReposCompareCommitsResponseCommitsItemCommitTree; - url: string; - verification: ReposCompareCommitsResponseCommitsItemCommitVerification; - }; - type ReposCompareCommitsResponseCommitsItemAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCompareCommitsResponseCommitsItem = { - author: ReposCompareCommitsResponseCommitsItemAuthor; - comments_url: string; - commit: ReposCompareCommitsResponseCommitsItemCommit; - committer: ReposCompareCommitsResponseCommitsItemCommitter; - html_url: string; - node_id: string; - parents: Array; - sha: string; - url: string; - }; - type ReposCompareCommitsResponseBaseCommitParentsItem = { - sha: string; - url: string; - }; - type ReposCompareCommitsResponseBaseCommitCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCompareCommitsResponseBaseCommitCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type ReposCompareCommitsResponseBaseCommitCommitTree = { - sha: string; - url: string; - }; - type ReposCompareCommitsResponseBaseCommitCommitCommitter = { - date: string; - email: string; - name: string; - }; - type ReposCompareCommitsResponseBaseCommitCommitAuthor = { - date: string; - email: string; - name: string; - }; - type ReposCompareCommitsResponseBaseCommitCommit = { - author: ReposCompareCommitsResponseBaseCommitCommitAuthor; - comment_count: number; - committer: ReposCompareCommitsResponseBaseCommitCommitCommitter; - message: string; - tree: ReposCompareCommitsResponseBaseCommitCommitTree; - url: string; - verification: ReposCompareCommitsResponseBaseCommitCommitVerification; - }; - type ReposCompareCommitsResponseBaseCommitAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposCompareCommitsResponseBaseCommit = { - author: ReposCompareCommitsResponseBaseCommitAuthor; - comments_url: string; - commit: ReposCompareCommitsResponseBaseCommitCommit; - committer: ReposCompareCommitsResponseBaseCommitCommitter; - html_url: string; - node_id: string; - parents: Array; - sha: string; - url: string; - }; - type ReposCompareCommitsResponse = { - ahead_by: number; - base_commit: ReposCompareCommitsResponseBaseCommit; - behind_by: number; - commits: Array; - diff_url: string; - files: Array; - html_url: string; - merge_base_commit: ReposCompareCommitsResponseMergeBaseCommit; - patch_url: string; - permalink_url: string; - status: string; - total_commits: number; - url: string; - }; - type ReposAddProtectedBranchUserRestrictionsResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposAddProtectedBranchTeamRestrictionsResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type ReposAddProtectedBranchRequiredSignaturesResponse = { - enabled: boolean; - url: string; - }; - type ReposAddProtectedBranchAppRestrictionsResponseItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ReposAddProtectedBranchAppRestrictionsResponseItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ReposAddProtectedBranchAppRestrictionsResponseItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposAddProtectedBranchAppRestrictionsResponseItemOwner; - permissions: ReposAddProtectedBranchAppRestrictionsResponseItemPermissions; - slug: string; - updated_at: string; - }; - type ReposAddProtectedBranchAdminEnforcementResponse = { - enabled: boolean; - url: string; - }; - type ReposAddDeployKeyResponse = { - created_at: string; - id: number; - key: string; - read_only: boolean; - title: string; - url: string; - verified: boolean; - }; - type ReposAddCollaboratorResponseRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposAddCollaboratorResponseRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: ReposAddCollaboratorResponseRepositoryOwner; - private: boolean; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; - }; - type ReposAddCollaboratorResponseInviter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposAddCollaboratorResponseInvitee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReposAddCollaboratorResponse = { - created_at: string; - html_url: string; - id: number; - invitee: ReposAddCollaboratorResponseInvitee; - inviter: ReposAddCollaboratorResponseInviter; - permissions: string; - repository: ReposAddCollaboratorResponseRepository; - url: string; - }; - type ReactionsListForTeamDiscussionCommentResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReactionsListForTeamDiscussionCommentResponseItem = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsListForTeamDiscussionCommentResponseItemUser; - }; - type ReactionsListForTeamDiscussionResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReactionsListForTeamDiscussionResponseItem = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsListForTeamDiscussionResponseItemUser; - }; - type ReactionsListForPullRequestReviewCommentResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReactionsListForPullRequestReviewCommentResponseItem = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsListForPullRequestReviewCommentResponseItemUser; - }; - type ReactionsListForIssueCommentResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReactionsListForIssueCommentResponseItem = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsListForIssueCommentResponseItemUser; - }; - type ReactionsListForIssueResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReactionsListForIssueResponseItem = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsListForIssueResponseItemUser; - }; - type ReactionsListForCommitCommentResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReactionsListForCommitCommentResponseItem = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsListForCommitCommentResponseItemUser; - }; - type ReactionsCreateForTeamDiscussionCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReactionsCreateForTeamDiscussionCommentResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForTeamDiscussionCommentResponseUser; - }; - type ReactionsCreateForTeamDiscussionResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReactionsCreateForTeamDiscussionResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForTeamDiscussionResponseUser; - }; - type ReactionsCreateForPullRequestReviewCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReactionsCreateForPullRequestReviewCommentResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForPullRequestReviewCommentResponseUser; - }; - type ReactionsCreateForIssueCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReactionsCreateForIssueCommentResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForIssueCommentResponseUser; - }; - type ReactionsCreateForIssueResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReactionsCreateForIssueResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForIssueResponseUser; - }; - type ReactionsCreateForCommitCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ReactionsCreateForCommitCommentResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForCommitCommentResponseUser; - }; - type RateLimitGetResponseResourcesSearch = { - limit: number; - remaining: number; - reset: number; - }; - type RateLimitGetResponseResourcesIntegrationManifest = { - limit: number; - remaining: number; - reset: number; - }; - type RateLimitGetResponseResourcesGraphql = { - limit: number; - remaining: number; - reset: number; - }; - type RateLimitGetResponseResourcesCore = { - limit: number; - remaining: number; - reset: number; - }; - type RateLimitGetResponseResources = { - core: RateLimitGetResponseResourcesCore; - graphql: RateLimitGetResponseResourcesGraphql; - integration_manifest: RateLimitGetResponseResourcesIntegrationManifest; - search: RateLimitGetResponseResourcesSearch; - }; - type RateLimitGetResponseRate = { - limit: number; - remaining: number; - reset: number; - }; - type RateLimitGetResponse = { - rate: RateLimitGetResponseRate; - resources: RateLimitGetResponseResources; - }; - type PullsUpdateReviewResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsUpdateReviewResponseLinksPullRequest = { href: string }; - type PullsUpdateReviewResponseLinksHtml = { href: string }; - type PullsUpdateReviewResponseLinks = { - html: PullsUpdateReviewResponseLinksHtml; - pull_request: PullsUpdateReviewResponseLinksPullRequest; - }; - type PullsUpdateReviewResponse = { - _links: PullsUpdateReviewResponseLinks; - body: string; - commit_id: string; - html_url: string; - id: number; - node_id: string; - pull_request_url: string; - state: string; - user: PullsUpdateReviewResponseUser; - }; - type PullsUpdateCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsUpdateCommentResponseLinksSelf = { href: string }; - type PullsUpdateCommentResponseLinksPullRequest = { href: string }; - type PullsUpdateCommentResponseLinksHtml = { href: string }; - type PullsUpdateCommentResponseLinks = { - html: PullsUpdateCommentResponseLinksHtml; - pull_request: PullsUpdateCommentResponseLinksPullRequest; - self: PullsUpdateCommentResponseLinksSelf; - }; - type PullsUpdateCommentResponse = { - _links: PullsUpdateCommentResponseLinks; - author_association: string; - body: string; - commit_id: string; - created_at: string; - diff_hunk: string; - html_url: string; - id: number; - in_reply_to_id: number; - line: number; - node_id: string; - original_commit_id: string; - original_line: number; - original_position: number; - original_start_line: number; - path: string; - position: number; - pull_request_review_id: number; - pull_request_url: string; - side: string; - start_line: number; - start_side: string; - updated_at: string; - url: string; - user: PullsUpdateCommentResponseUser; - }; - type PullsUpdateBranchResponse = { message: string; url: string }; - type PullsUpdateResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsUpdateResponseRequestedTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type PullsUpdateResponseRequestedReviewersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsUpdateResponseMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsUpdateResponseMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: PullsUpdateResponseMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type PullsUpdateResponseMergedBy = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsUpdateResponseLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type PullsUpdateResponseHeadUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsUpdateResponseHeadRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type PullsUpdateResponseHeadRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsUpdateResponseHeadRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsUpdateResponseHeadRepoOwner; - permissions: PullsUpdateResponseHeadRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type PullsUpdateResponseHead = { - label: string; - ref: string; - repo: PullsUpdateResponseHeadRepo; - sha: string; - user: PullsUpdateResponseHeadUser; - }; - type PullsUpdateResponseBaseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsUpdateResponseBaseRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type PullsUpdateResponseBaseRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsUpdateResponseBaseRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsUpdateResponseBaseRepoOwner; - permissions: PullsUpdateResponseBaseRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type PullsUpdateResponseBase = { - label: string; - ref: string; - repo: PullsUpdateResponseBaseRepo; - sha: string; - user: PullsUpdateResponseBaseUser; - }; - type PullsUpdateResponseAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsUpdateResponseAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsUpdateResponseLinksStatuses = { href: string }; - type PullsUpdateResponseLinksSelf = { href: string }; - type PullsUpdateResponseLinksReviewComments = { href: string }; - type PullsUpdateResponseLinksReviewComment = { href: string }; - type PullsUpdateResponseLinksIssue = { href: string }; - type PullsUpdateResponseLinksHtml = { href: string }; - type PullsUpdateResponseLinksCommits = { href: string }; - type PullsUpdateResponseLinksComments = { href: string }; - type PullsUpdateResponseLinks = { - comments: PullsUpdateResponseLinksComments; - commits: PullsUpdateResponseLinksCommits; - html: PullsUpdateResponseLinksHtml; - issue: PullsUpdateResponseLinksIssue; - review_comment: PullsUpdateResponseLinksReviewComment; - review_comments: PullsUpdateResponseLinksReviewComments; - self: PullsUpdateResponseLinksSelf; - statuses: PullsUpdateResponseLinksStatuses; - }; - type PullsUpdateResponse = { - _links: PullsUpdateResponseLinks; - active_lock_reason: string; - additions: number; - assignee: PullsUpdateResponseAssignee; - assignees: Array; - author_association: string; - base: PullsUpdateResponseBase; - body: string; - changed_files: number; - closed_at: string; - comments: number; - comments_url: string; - commits: number; - commits_url: string; - created_at: string; - deletions: number; - diff_url: string; - draft: boolean; - head: PullsUpdateResponseHead; - html_url: string; - id: number; - issue_url: string; - labels: Array; - locked: boolean; - maintainer_can_modify: boolean; - merge_commit_sha: string; - mergeable: boolean; - mergeable_state: string; - merged: boolean; - merged_at: string; - merged_by: PullsUpdateResponseMergedBy; - milestone: PullsUpdateResponseMilestone; - node_id: string; - number: number; - patch_url: string; - rebaseable: boolean; - requested_reviewers: Array; - requested_teams: Array; - review_comment_url: string; - review_comments: number; - review_comments_url: string; - state: string; - statuses_url: string; - title: string; - updated_at: string; - url: string; - user: PullsUpdateResponseUser; - }; - type PullsSubmitReviewResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsSubmitReviewResponseLinksPullRequest = { href: string }; - type PullsSubmitReviewResponseLinksHtml = { href: string }; - type PullsSubmitReviewResponseLinks = { - html: PullsSubmitReviewResponseLinksHtml; - pull_request: PullsSubmitReviewResponseLinksPullRequest; - }; - type PullsSubmitReviewResponse = { - _links: PullsSubmitReviewResponseLinks; - body: string; - commit_id: string; - html_url: string; - id: number; - node_id: string; - pull_request_url: string; - state: string; - user: PullsSubmitReviewResponseUser; - }; - type PullsMergeResponse = { merged: boolean; message: string; sha: string }; - type PullsListReviewsResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListReviewsResponseItemLinksPullRequest = { href: string }; - type PullsListReviewsResponseItemLinksHtml = { href: string }; - type PullsListReviewsResponseItemLinks = { - html: PullsListReviewsResponseItemLinksHtml; - pull_request: PullsListReviewsResponseItemLinksPullRequest; - }; - type PullsListReviewsResponseItem = { - _links: PullsListReviewsResponseItemLinks; - body: string; - commit_id: string; - html_url: string; - id: number; - node_id: string; - pull_request_url: string; - state: string; - user: PullsListReviewsResponseItemUser; - }; - type PullsListReviewRequestsResponseUsersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListReviewRequestsResponseTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type PullsListReviewRequestsResponse = { - teams: Array; - users: Array; - }; - type PullsListFilesResponseItem = { - additions: number; - blob_url: string; - changes: number; - contents_url: string; - deletions: number; - filename: string; - patch: string; - raw_url: string; - sha: string; - status: string; - }; - type PullsListCommitsResponseItemParentsItem = { sha: string; url: string }; - type PullsListCommitsResponseItemCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListCommitsResponseItemCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type PullsListCommitsResponseItemCommitTree = { sha: string; url: string }; - type PullsListCommitsResponseItemCommitCommitter = { - date: string; - email: string; - name: string; - }; - type PullsListCommitsResponseItemCommitAuthor = { - date: string; - email: string; - name: string; - }; - type PullsListCommitsResponseItemCommit = { - author: PullsListCommitsResponseItemCommitAuthor; - comment_count: number; - committer: PullsListCommitsResponseItemCommitCommitter; - message: string; - tree: PullsListCommitsResponseItemCommitTree; - url: string; - verification: PullsListCommitsResponseItemCommitVerification; - }; - type PullsListCommitsResponseItemAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListCommitsResponseItem = { - author: PullsListCommitsResponseItemAuthor; - comments_url: string; - commit: PullsListCommitsResponseItemCommit; - committer: PullsListCommitsResponseItemCommitter; - html_url: string; - node_id: string; - parents: Array; - sha: string; - url: string; - }; - type PullsListCommentsForRepoResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListCommentsForRepoResponseItemLinksSelf = { href: string }; - type PullsListCommentsForRepoResponseItemLinksPullRequest = { href: string }; - type PullsListCommentsForRepoResponseItemLinksHtml = { href: string }; - type PullsListCommentsForRepoResponseItemLinks = { - html: PullsListCommentsForRepoResponseItemLinksHtml; - pull_request: PullsListCommentsForRepoResponseItemLinksPullRequest; - self: PullsListCommentsForRepoResponseItemLinksSelf; - }; - type PullsListCommentsForRepoResponseItem = { - _links: PullsListCommentsForRepoResponseItemLinks; - author_association: string; - body: string; - commit_id: string; - created_at: string; - diff_hunk: string; - html_url: string; - id: number; - in_reply_to_id: number; - line: number; - node_id: string; - original_commit_id: string; - original_line: number; - original_position: number; - original_start_line: number; - path: string; - position: number; - pull_request_review_id: number; - pull_request_url: string; - side: string; - start_line: number; - start_side: string; - updated_at: string; - url: string; - user: PullsListCommentsForRepoResponseItemUser; - }; - type PullsListCommentsResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListCommentsResponseItemLinksSelf = { href: string }; - type PullsListCommentsResponseItemLinksPullRequest = { href: string }; - type PullsListCommentsResponseItemLinksHtml = { href: string }; - type PullsListCommentsResponseItemLinks = { - html: PullsListCommentsResponseItemLinksHtml; - pull_request: PullsListCommentsResponseItemLinksPullRequest; - self: PullsListCommentsResponseItemLinksSelf; - }; - type PullsListCommentsResponseItem = { - _links: PullsListCommentsResponseItemLinks; - author_association: string; - body: string; - commit_id: string; - created_at: string; - diff_hunk: string; - html_url: string; - id: number; - in_reply_to_id: number; - line: number; - node_id: string; - original_commit_id: string; - original_line: number; - original_position: number; - original_start_line: number; - path: string; - position: number; - pull_request_review_id: number; - pull_request_url: string; - side: string; - start_line: number; - start_side: string; - updated_at: string; - url: string; - user: PullsListCommentsResponseItemUser; - }; - type PullsListResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListResponseItemRequestedTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type PullsListResponseItemRequestedReviewersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListResponseItemMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListResponseItemMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: PullsListResponseItemMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type PullsListResponseItemLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type PullsListResponseItemHeadUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListResponseItemHeadRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type PullsListResponseItemHeadRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListResponseItemHeadRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsListResponseItemHeadRepoOwner; - permissions: PullsListResponseItemHeadRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type PullsListResponseItemHead = { - label: string; - ref: string; - repo: PullsListResponseItemHeadRepo; - sha: string; - user: PullsListResponseItemHeadUser; - }; - type PullsListResponseItemBaseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListResponseItemBaseRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type PullsListResponseItemBaseRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListResponseItemBaseRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsListResponseItemBaseRepoOwner; - permissions: PullsListResponseItemBaseRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type PullsListResponseItemBase = { - label: string; - ref: string; - repo: PullsListResponseItemBaseRepo; - sha: string; - user: PullsListResponseItemBaseUser; - }; - type PullsListResponseItemAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListResponseItemAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsListResponseItemLinksStatuses = { href: string }; - type PullsListResponseItemLinksSelf = { href: string }; - type PullsListResponseItemLinksReviewComments = { href: string }; - type PullsListResponseItemLinksReviewComment = { href: string }; - type PullsListResponseItemLinksIssue = { href: string }; - type PullsListResponseItemLinksHtml = { href: string }; - type PullsListResponseItemLinksCommits = { href: string }; - type PullsListResponseItemLinksComments = { href: string }; - type PullsListResponseItemLinks = { - comments: PullsListResponseItemLinksComments; - commits: PullsListResponseItemLinksCommits; - html: PullsListResponseItemLinksHtml; - issue: PullsListResponseItemLinksIssue; - review_comment: PullsListResponseItemLinksReviewComment; - review_comments: PullsListResponseItemLinksReviewComments; - self: PullsListResponseItemLinksSelf; - statuses: PullsListResponseItemLinksStatuses; - }; - type PullsListResponseItem = { - _links: PullsListResponseItemLinks; - active_lock_reason: string; - assignee: PullsListResponseItemAssignee; - assignees: Array; - author_association: string; - base: PullsListResponseItemBase; - body: string; - closed_at: string; - comments_url: string; - commits_url: string; - created_at: string; - diff_url: string; - draft: boolean; - head: PullsListResponseItemHead; - html_url: string; - id: number; - issue_url: string; - labels: Array; - locked: boolean; - merge_commit_sha: string; - merged_at: string; - milestone: PullsListResponseItemMilestone; - node_id: string; - number: number; - patch_url: string; - requested_reviewers: Array; - requested_teams: Array; - review_comment_url: string; - review_comments_url: string; - state: string; - statuses_url: string; - title: string; - updated_at: string; - url: string; - user: PullsListResponseItemUser; - }; - type PullsGetReviewResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetReviewResponseLinksPullRequest = { href: string }; - type PullsGetReviewResponseLinksHtml = { href: string }; - type PullsGetReviewResponseLinks = { - html: PullsGetReviewResponseLinksHtml; - pull_request: PullsGetReviewResponseLinksPullRequest; - }; - type PullsGetReviewResponse = { - _links: PullsGetReviewResponseLinks; - body: string; - commit_id: string; - html_url: string; - id: number; - node_id: string; - pull_request_url: string; - state: string; - user: PullsGetReviewResponseUser; - }; - type PullsGetCommentsForReviewResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetCommentsForReviewResponseItemLinksSelf = { href: string }; - type PullsGetCommentsForReviewResponseItemLinksPullRequest = { href: string }; - type PullsGetCommentsForReviewResponseItemLinksHtml = { href: string }; - type PullsGetCommentsForReviewResponseItemLinks = { - html: PullsGetCommentsForReviewResponseItemLinksHtml; - pull_request: PullsGetCommentsForReviewResponseItemLinksPullRequest; - self: PullsGetCommentsForReviewResponseItemLinksSelf; - }; - type PullsGetCommentsForReviewResponseItem = { - _links: PullsGetCommentsForReviewResponseItemLinks; - author_association: string; - body: string; - commit_id: string; - created_at: string; - diff_hunk: string; - html_url: string; - id: number; - in_reply_to_id: number; - node_id: string; - original_commit_id: string; - original_position: number; - path: string; - position: number; - pull_request_review_id: number; - pull_request_url: string; - updated_at: string; - url: string; - user: PullsGetCommentsForReviewResponseItemUser; - }; - type PullsGetCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetCommentResponseLinksSelf = { href: string }; - type PullsGetCommentResponseLinksPullRequest = { href: string }; - type PullsGetCommentResponseLinksHtml = { href: string }; - type PullsGetCommentResponseLinks = { - html: PullsGetCommentResponseLinksHtml; - pull_request: PullsGetCommentResponseLinksPullRequest; - self: PullsGetCommentResponseLinksSelf; - }; - type PullsGetCommentResponse = { - _links: PullsGetCommentResponseLinks; - author_association: string; - body: string; - commit_id: string; - created_at: string; - diff_hunk: string; - html_url: string; - id: number; - in_reply_to_id: number; - line: number; - node_id: string; - original_commit_id: string; - original_line: number; - original_position: number; - original_start_line: number; - path: string; - position: number; - pull_request_review_id: number; - pull_request_url: string; - side: string; - start_line: number; - start_side: string; - updated_at: string; - url: string; - user: PullsGetCommentResponseUser; - }; - type PullsGetResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetResponseRequestedTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type PullsGetResponseRequestedReviewersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetResponseMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetResponseMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: PullsGetResponseMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type PullsGetResponseMergedBy = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetResponseLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type PullsGetResponseHeadUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetResponseHeadRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type PullsGetResponseHeadRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetResponseHeadRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsGetResponseHeadRepoOwner; - permissions: PullsGetResponseHeadRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type PullsGetResponseHead = { - label: string; - ref: string; - repo: PullsGetResponseHeadRepo; - sha: string; - user: PullsGetResponseHeadUser; - }; - type PullsGetResponseBaseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetResponseBaseRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type PullsGetResponseBaseRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetResponseBaseRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsGetResponseBaseRepoOwner; - permissions: PullsGetResponseBaseRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type PullsGetResponseBase = { - label: string; - ref: string; - repo: PullsGetResponseBaseRepo; - sha: string; - user: PullsGetResponseBaseUser; - }; - type PullsGetResponseAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetResponseAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsGetResponseLinksStatuses = { href: string }; - type PullsGetResponseLinksSelf = { href: string }; - type PullsGetResponseLinksReviewComments = { href: string }; - type PullsGetResponseLinksReviewComment = { href: string }; - type PullsGetResponseLinksIssue = { href: string }; - type PullsGetResponseLinksHtml = { href: string }; - type PullsGetResponseLinksCommits = { href: string }; - type PullsGetResponseLinksComments = { href: string }; - type PullsGetResponseLinks = { - comments: PullsGetResponseLinksComments; - commits: PullsGetResponseLinksCommits; - html: PullsGetResponseLinksHtml; - issue: PullsGetResponseLinksIssue; - review_comment: PullsGetResponseLinksReviewComment; - review_comments: PullsGetResponseLinksReviewComments; - self: PullsGetResponseLinksSelf; - statuses: PullsGetResponseLinksStatuses; - }; - type PullsGetResponse = { - _links: PullsGetResponseLinks; - active_lock_reason: string; - additions: number; - assignee: PullsGetResponseAssignee; - assignees: Array; - author_association: string; - base: PullsGetResponseBase; - body: string; - changed_files: number; - closed_at: string; - comments: number; - comments_url: string; - commits: number; - commits_url: string; - created_at: string; - deletions: number; - diff_url: string; - draft: boolean; - head: PullsGetResponseHead; - html_url: string; - id: number; - issue_url: string; - labels: Array; - locked: boolean; - maintainer_can_modify: boolean; - merge_commit_sha: string; - mergeable: boolean; - mergeable_state: string; - merged: boolean; - merged_at: string; - merged_by: PullsGetResponseMergedBy; - milestone: PullsGetResponseMilestone; - node_id: string; - number: number; - patch_url: string; - rebaseable: boolean; - requested_reviewers: Array; - requested_teams: Array; - review_comment_url: string; - review_comments: number; - review_comments_url: string; - state: string; - statuses_url: string; - title: string; - updated_at: string; - url: string; - user: PullsGetResponseUser; - }; - type PullsDismissReviewResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsDismissReviewResponseLinksPullRequest = { href: string }; - type PullsDismissReviewResponseLinksHtml = { href: string }; - type PullsDismissReviewResponseLinks = { - html: PullsDismissReviewResponseLinksHtml; - pull_request: PullsDismissReviewResponseLinksPullRequest; - }; - type PullsDismissReviewResponse = { - _links: PullsDismissReviewResponseLinks; - body: string; - commit_id: string; - html_url: string; - id: number; - node_id: string; - pull_request_url: string; - state: string; - user: PullsDismissReviewResponseUser; - }; - type PullsDeletePendingReviewResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsDeletePendingReviewResponseLinksPullRequest = { href: string }; - type PullsDeletePendingReviewResponseLinksHtml = { href: string }; - type PullsDeletePendingReviewResponseLinks = { - html: PullsDeletePendingReviewResponseLinksHtml; - pull_request: PullsDeletePendingReviewResponseLinksPullRequest; - }; - type PullsDeletePendingReviewResponse = { - _links: PullsDeletePendingReviewResponseLinks; - body: string; - commit_id: string; - html_url: string; - id: number; - node_id: string; - pull_request_url: string; - state: string; - user: PullsDeletePendingReviewResponseUser; - }; - type PullsCreateReviewRequestResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateReviewRequestResponseRequestedTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type PullsCreateReviewRequestResponseRequestedReviewersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateReviewRequestResponseMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateReviewRequestResponseMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: PullsCreateReviewRequestResponseMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type PullsCreateReviewRequestResponseLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type PullsCreateReviewRequestResponseHeadUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateReviewRequestResponseHeadRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type PullsCreateReviewRequestResponseHeadRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateReviewRequestResponseHeadRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsCreateReviewRequestResponseHeadRepoOwner; - permissions: PullsCreateReviewRequestResponseHeadRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type PullsCreateReviewRequestResponseHead = { - label: string; - ref: string; - repo: PullsCreateReviewRequestResponseHeadRepo; - sha: string; - user: PullsCreateReviewRequestResponseHeadUser; - }; - type PullsCreateReviewRequestResponseBaseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateReviewRequestResponseBaseRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type PullsCreateReviewRequestResponseBaseRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateReviewRequestResponseBaseRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsCreateReviewRequestResponseBaseRepoOwner; - permissions: PullsCreateReviewRequestResponseBaseRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type PullsCreateReviewRequestResponseBase = { - label: string; - ref: string; - repo: PullsCreateReviewRequestResponseBaseRepo; - sha: string; - user: PullsCreateReviewRequestResponseBaseUser; - }; - type PullsCreateReviewRequestResponseAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateReviewRequestResponseAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateReviewRequestResponseLinksStatuses = { href: string }; - type PullsCreateReviewRequestResponseLinksSelf = { href: string }; - type PullsCreateReviewRequestResponseLinksReviewComments = { href: string }; - type PullsCreateReviewRequestResponseLinksReviewComment = { href: string }; - type PullsCreateReviewRequestResponseLinksIssue = { href: string }; - type PullsCreateReviewRequestResponseLinksHtml = { href: string }; - type PullsCreateReviewRequestResponseLinksCommits = { href: string }; - type PullsCreateReviewRequestResponseLinksComments = { href: string }; - type PullsCreateReviewRequestResponseLinks = { - comments: PullsCreateReviewRequestResponseLinksComments; - commits: PullsCreateReviewRequestResponseLinksCommits; - html: PullsCreateReviewRequestResponseLinksHtml; - issue: PullsCreateReviewRequestResponseLinksIssue; - review_comment: PullsCreateReviewRequestResponseLinksReviewComment; - review_comments: PullsCreateReviewRequestResponseLinksReviewComments; - self: PullsCreateReviewRequestResponseLinksSelf; - statuses: PullsCreateReviewRequestResponseLinksStatuses; - }; - type PullsCreateReviewRequestResponse = { - _links: PullsCreateReviewRequestResponseLinks; - active_lock_reason: string; - assignee: PullsCreateReviewRequestResponseAssignee; - assignees: Array; - author_association: string; - base: PullsCreateReviewRequestResponseBase; - body: string; - closed_at: string; - comments_url: string; - commits_url: string; - created_at: string; - diff_url: string; - draft: boolean; - head: PullsCreateReviewRequestResponseHead; - html_url: string; - id: number; - issue_url: string; - labels: Array; - locked: boolean; - merge_commit_sha: string; - merged_at: string; - milestone: PullsCreateReviewRequestResponseMilestone; - node_id: string; - number: number; - patch_url: string; - requested_reviewers: Array< - PullsCreateReviewRequestResponseRequestedReviewersItem - >; - requested_teams: Array; - review_comment_url: string; - review_comments_url: string; - state: string; - statuses_url: string; - title: string; - updated_at: string; - url: string; - user: PullsCreateReviewRequestResponseUser; - }; - type PullsCreateReviewCommentReplyResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateReviewCommentReplyResponseLinksSelf = { href: string }; - type PullsCreateReviewCommentReplyResponseLinksPullRequest = { href: string }; - type PullsCreateReviewCommentReplyResponseLinksHtml = { href: string }; - type PullsCreateReviewCommentReplyResponseLinks = { - html: PullsCreateReviewCommentReplyResponseLinksHtml; - pull_request: PullsCreateReviewCommentReplyResponseLinksPullRequest; - self: PullsCreateReviewCommentReplyResponseLinksSelf; - }; - type PullsCreateReviewCommentReplyResponse = { - _links: PullsCreateReviewCommentReplyResponseLinks; - author_association: string; - body: string; - commit_id: string; - created_at: string; - diff_hunk: string; - html_url: string; - id: number; - node_id: string; - original_commit_id: string; - original_position: number; - path: string; - position: number; - pull_request_review_id: number; - pull_request_url: string; - updated_at: string; - url: string; - user: PullsCreateReviewCommentReplyResponseUser; - }; - type PullsCreateReviewResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateReviewResponseLinksPullRequest = { href: string }; - type PullsCreateReviewResponseLinksHtml = { href: string }; - type PullsCreateReviewResponseLinks = { - html: PullsCreateReviewResponseLinksHtml; - pull_request: PullsCreateReviewResponseLinksPullRequest; - }; - type PullsCreateReviewResponse = { - _links: PullsCreateReviewResponseLinks; - body: string; - commit_id: string; - html_url: string; - id: number; - node_id: string; - pull_request_url: string; - state: string; - user: PullsCreateReviewResponseUser; - }; - type PullsCreateFromIssueResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateFromIssueResponseRequestedTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type PullsCreateFromIssueResponseRequestedReviewersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateFromIssueResponseMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateFromIssueResponseMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: PullsCreateFromIssueResponseMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type PullsCreateFromIssueResponseMergedBy = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateFromIssueResponseLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type PullsCreateFromIssueResponseHeadUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateFromIssueResponseHeadRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type PullsCreateFromIssueResponseHeadRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateFromIssueResponseHeadRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsCreateFromIssueResponseHeadRepoOwner; - permissions: PullsCreateFromIssueResponseHeadRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type PullsCreateFromIssueResponseHead = { - label: string; - ref: string; - repo: PullsCreateFromIssueResponseHeadRepo; - sha: string; - user: PullsCreateFromIssueResponseHeadUser; - }; - type PullsCreateFromIssueResponseBaseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateFromIssueResponseBaseRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type PullsCreateFromIssueResponseBaseRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateFromIssueResponseBaseRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsCreateFromIssueResponseBaseRepoOwner; - permissions: PullsCreateFromIssueResponseBaseRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type PullsCreateFromIssueResponseBase = { - label: string; - ref: string; - repo: PullsCreateFromIssueResponseBaseRepo; - sha: string; - user: PullsCreateFromIssueResponseBaseUser; - }; - type PullsCreateFromIssueResponseAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateFromIssueResponseAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateFromIssueResponseLinksStatuses = { href: string }; - type PullsCreateFromIssueResponseLinksSelf = { href: string }; - type PullsCreateFromIssueResponseLinksReviewComments = { href: string }; - type PullsCreateFromIssueResponseLinksReviewComment = { href: string }; - type PullsCreateFromIssueResponseLinksIssue = { href: string }; - type PullsCreateFromIssueResponseLinksHtml = { href: string }; - type PullsCreateFromIssueResponseLinksCommits = { href: string }; - type PullsCreateFromIssueResponseLinksComments = { href: string }; - type PullsCreateFromIssueResponseLinks = { - comments: PullsCreateFromIssueResponseLinksComments; - commits: PullsCreateFromIssueResponseLinksCommits; - html: PullsCreateFromIssueResponseLinksHtml; - issue: PullsCreateFromIssueResponseLinksIssue; - review_comment: PullsCreateFromIssueResponseLinksReviewComment; - review_comments: PullsCreateFromIssueResponseLinksReviewComments; - self: PullsCreateFromIssueResponseLinksSelf; - statuses: PullsCreateFromIssueResponseLinksStatuses; - }; - type PullsCreateFromIssueResponse = { - _links: PullsCreateFromIssueResponseLinks; - active_lock_reason: string; - additions: number; - assignee: PullsCreateFromIssueResponseAssignee; - assignees: Array; - author_association: string; - base: PullsCreateFromIssueResponseBase; - body: string; - changed_files: number; - closed_at: string; - comments: number; - comments_url: string; - commits: number; - commits_url: string; - created_at: string; - deletions: number; - diff_url: string; - draft: boolean; - head: PullsCreateFromIssueResponseHead; - html_url: string; - id: number; - issue_url: string; - labels: Array; - locked: boolean; - maintainer_can_modify: boolean; - merge_commit_sha: string; - mergeable: boolean; - mergeable_state: string; - merged: boolean; - merged_at: string; - merged_by: PullsCreateFromIssueResponseMergedBy; - milestone: PullsCreateFromIssueResponseMilestone; - node_id: string; - number: number; - patch_url: string; - rebaseable: boolean; - requested_reviewers: Array< - PullsCreateFromIssueResponseRequestedReviewersItem - >; - requested_teams: Array; - review_comment_url: string; - review_comments: number; - review_comments_url: string; - state: string; - statuses_url: string; - title: string; - updated_at: string; - url: string; - user: PullsCreateFromIssueResponseUser; - }; - type PullsCreateCommentReplyResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateCommentReplyResponseLinksSelf = { href: string }; - type PullsCreateCommentReplyResponseLinksPullRequest = { href: string }; - type PullsCreateCommentReplyResponseLinksHtml = { href: string }; - type PullsCreateCommentReplyResponseLinks = { - html: PullsCreateCommentReplyResponseLinksHtml; - pull_request: PullsCreateCommentReplyResponseLinksPullRequest; - self: PullsCreateCommentReplyResponseLinksSelf; - }; - type PullsCreateCommentReplyResponse = { - _links: PullsCreateCommentReplyResponseLinks; - author_association: string; - body: string; - commit_id: string; - created_at: string; - diff_hunk: string; - html_url: string; - id: number; - in_reply_to_id: number; - line: number; - node_id: string; - original_commit_id: string; - original_line: number; - original_position: number; - original_start_line: number; - path: string; - position: number; - pull_request_review_id: number; - pull_request_url: string; - side: string; - start_line: number; - start_side: string; - updated_at: string; - url: string; - user: PullsCreateCommentReplyResponseUser; - }; - type PullsCreateCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateCommentResponseLinksSelf = { href: string }; - type PullsCreateCommentResponseLinksPullRequest = { href: string }; - type PullsCreateCommentResponseLinksHtml = { href: string }; - type PullsCreateCommentResponseLinks = { - html: PullsCreateCommentResponseLinksHtml; - pull_request: PullsCreateCommentResponseLinksPullRequest; - self: PullsCreateCommentResponseLinksSelf; - }; - type PullsCreateCommentResponse = { - _links: PullsCreateCommentResponseLinks; - author_association: string; - body: string; - commit_id: string; - created_at: string; - diff_hunk: string; - html_url: string; - id: number; - in_reply_to_id: number; - line: number; - node_id: string; - original_commit_id: string; - original_line: number; - original_position: number; - original_start_line: number; - path: string; - position: number; - pull_request_review_id: number; - pull_request_url: string; - side: string; - start_line: number; - start_side: string; - updated_at: string; - url: string; - user: PullsCreateCommentResponseUser; - }; - type PullsCreateResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateResponseRequestedTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type PullsCreateResponseRequestedReviewersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateResponseMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateResponseMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: PullsCreateResponseMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type PullsCreateResponseMergedBy = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateResponseLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type PullsCreateResponseHeadUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateResponseHeadRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type PullsCreateResponseHeadRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateResponseHeadRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsCreateResponseHeadRepoOwner; - permissions: PullsCreateResponseHeadRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type PullsCreateResponseHead = { - label: string; - ref: string; - repo: PullsCreateResponseHeadRepo; - sha: string; - user: PullsCreateResponseHeadUser; - }; - type PullsCreateResponseBaseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateResponseBaseRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type PullsCreateResponseBaseRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateResponseBaseRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsCreateResponseBaseRepoOwner; - permissions: PullsCreateResponseBaseRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type PullsCreateResponseBase = { - label: string; - ref: string; - repo: PullsCreateResponseBaseRepo; - sha: string; - user: PullsCreateResponseBaseUser; - }; - type PullsCreateResponseAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateResponseAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type PullsCreateResponseLinksStatuses = { href: string }; - type PullsCreateResponseLinksSelf = { href: string }; - type PullsCreateResponseLinksReviewComments = { href: string }; - type PullsCreateResponseLinksReviewComment = { href: string }; - type PullsCreateResponseLinksIssue = { href: string }; - type PullsCreateResponseLinksHtml = { href: string }; - type PullsCreateResponseLinksCommits = { href: string }; - type PullsCreateResponseLinksComments = { href: string }; - type PullsCreateResponseLinks = { - comments: PullsCreateResponseLinksComments; - commits: PullsCreateResponseLinksCommits; - html: PullsCreateResponseLinksHtml; - issue: PullsCreateResponseLinksIssue; - review_comment: PullsCreateResponseLinksReviewComment; - review_comments: PullsCreateResponseLinksReviewComments; - self: PullsCreateResponseLinksSelf; - statuses: PullsCreateResponseLinksStatuses; - }; - type PullsCreateResponse = { - _links: PullsCreateResponseLinks; - active_lock_reason: string; - additions: number; - assignee: PullsCreateResponseAssignee; - assignees: Array; - author_association: string; - base: PullsCreateResponseBase; - body: string; - changed_files: number; - closed_at: string; - comments: number; - comments_url: string; - commits: number; - commits_url: string; - created_at: string; - deletions: number; - diff_url: string; - draft: boolean; - head: PullsCreateResponseHead; - html_url: string; - id: number; - issue_url: string; - labels: Array; - locked: boolean; - maintainer_can_modify: boolean; - merge_commit_sha: string; - mergeable: boolean; - mergeable_state: string; - merged: boolean; - merged_at: string; - merged_by: PullsCreateResponseMergedBy; - milestone: PullsCreateResponseMilestone; - node_id: string; - number: number; - patch_url: string; - rebaseable: boolean; - requested_reviewers: Array; - requested_teams: Array; - review_comment_url: string; - review_comments: number; - review_comments_url: string; - state: string; - statuses_url: string; - title: string; - updated_at: string; - url: string; - user: PullsCreateResponseUser; - }; - type ProjectsUpdateColumnResponse = { - cards_url: string; - created_at: string; - id: number; - name: string; - node_id: string; - project_url: string; - updated_at: string; - url: string; - }; - type ProjectsUpdateCardResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsUpdateCardResponse = { - archived: boolean; - column_url: string; - content_url: string; - created_at: string; - creator: ProjectsUpdateCardResponseCreator; - id: number; - node_id: string; - note: string; - project_url: string; - updated_at: string; - url: string; - }; - type ProjectsUpdateResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsUpdateResponse = { - body: string; - columns_url: string; - created_at: string; - creator: ProjectsUpdateResponseCreator; - html_url: string; - id: number; - name: string; - node_id: string; - number: number; - owner_url: string; - state: string; - updated_at: string; - url: string; - }; - type ProjectsReviewUserPermissionLevelResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsReviewUserPermissionLevelResponse = { - permission: string; - user: ProjectsReviewUserPermissionLevelResponseUser; - }; - type ProjectsListForUserResponseItemCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsListForUserResponseItem = { - body: string; - columns_url: string; - created_at: string; - creator: ProjectsListForUserResponseItemCreator; - html_url: string; - id: number; - name: string; - node_id: string; - number: number; - owner_url: string; - state: string; - updated_at: string; - url: string; - }; - type ProjectsListForRepoResponseItemCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsListForRepoResponseItem = { - body: string; - columns_url: string; - created_at: string; - creator: ProjectsListForRepoResponseItemCreator; - html_url: string; - id: number; - name: string; - node_id: string; - number: number; - owner_url: string; - state: string; - updated_at: string; - url: string; - }; - type ProjectsListForOrgResponseItemCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsListForOrgResponseItem = { - body: string; - columns_url: string; - created_at: string; - creator: ProjectsListForOrgResponseItemCreator; - html_url: string; - id: number; - name: string; - node_id: string; - number: number; - owner_url: string; - state: string; - updated_at: string; - url: string; - }; - type ProjectsListColumnsResponseItem = { - cards_url: string; - created_at: string; - id: number; - name: string; - node_id: string; - project_url: string; - updated_at: string; - url: string; - }; - type ProjectsListCollaboratorsResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsListCardsResponseItemCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsListCardsResponseItem = { - archived: boolean; - column_url: string; - content_url: string; - created_at: string; - creator: ProjectsListCardsResponseItemCreator; - id: number; - node_id: string; - note: string; - project_url: string; - updated_at: string; - url: string; - }; - type ProjectsGetColumnResponse = { - cards_url: string; - created_at: string; - id: number; - name: string; - node_id: string; - project_url: string; - updated_at: string; - url: string; - }; - type ProjectsGetCardResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsGetCardResponse = { - archived: boolean; - column_url: string; - content_url: string; - created_at: string; - creator: ProjectsGetCardResponseCreator; - id: number; - node_id: string; - note: string; - project_url: string; - updated_at: string; - url: string; - }; - type ProjectsGetResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsGetResponse = { - body: string; - columns_url: string; - created_at: string; - creator: ProjectsGetResponseCreator; - html_url: string; - id: number; - name: string; - node_id: string; - number: number; - owner_url: string; - state: string; - updated_at: string; - url: string; - }; - type ProjectsCreateForRepoResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsCreateForRepoResponse = { - body: string; - columns_url: string; - created_at: string; - creator: ProjectsCreateForRepoResponseCreator; - html_url: string; - id: number; - name: string; - node_id: string; - number: number; - owner_url: string; - state: string; - updated_at: string; - url: string; - }; - type ProjectsCreateForOrgResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsCreateForOrgResponse = { - body: string; - columns_url: string; - created_at: string; - creator: ProjectsCreateForOrgResponseCreator; - html_url: string; - id: number; - name: string; - node_id: string; - number: number; - owner_url: string; - state: string; - updated_at: string; - url: string; - }; - type ProjectsCreateForAuthenticatedUserResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsCreateForAuthenticatedUserResponse = { - body: string; - columns_url: string; - created_at: string; - creator: ProjectsCreateForAuthenticatedUserResponseCreator; - html_url: string; - id: number; - name: string; - node_id: string; - number: number; - owner_url: string; - state: string; - updated_at: string; - url: string; - }; - type ProjectsCreateColumnResponse = { - cards_url: string; - created_at: string; - id: number; - name: string; - node_id: string; - project_url: string; - updated_at: string; - url: string; - }; - type ProjectsCreateCardResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ProjectsCreateCardResponse = { - archived: boolean; - column_url: string; - content_url: string; - created_at: string; - creator: ProjectsCreateCardResponseCreator; - id: number; - node_id: string; - note: string; - project_url: string; - updated_at: string; - url: string; - }; - type OrgsUpdateMembershipResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OrgsUpdateMembershipResponseOrganization = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type OrgsUpdateMembershipResponse = { - organization: OrgsUpdateMembershipResponseOrganization; - organization_url: string; - role: string; - state: string; - url: string; - user: OrgsUpdateMembershipResponseUser; - }; - type OrgsUpdateHookResponseConfig = { content_type: string; url: string }; - type OrgsUpdateHookResponse = { - active: boolean; - config: OrgsUpdateHookResponseConfig; - created_at: string; - events: Array; - id: number; - name: string; - ping_url: string; - updated_at: string; - url: string; - }; - type OrgsUpdateResponsePlan = { - name: string; - private_repos: number; - space: number; - }; - type OrgsUpdateResponse = { - avatar_url: string; - billing_email: string; - blog: string; - collaborators: number; - company: string; - created_at: string; - default_repository_settings: string; - description: string; - disk_usage: number; - email: string; - events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; - hooks_url: string; - html_url: string; - id: number; - is_verified: boolean; - issues_url: string; - location: string; - login: string; - members_allowed_repository_creation_type: string; - members_can_create_repositories: boolean; - members_url: string; - name: string; - node_id: string; - owned_private_repos: number; - plan: OrgsUpdateResponsePlan; - private_gists: number; - public_gists: number; - public_members_url: string; - public_repos: number; - repos_url: string; - total_private_repos: number; - two_factor_requirement_enabled: boolean; - type: string; - url: string; - }; - type OrgsRemoveOutsideCollaboratorResponse = { - documentation_url: string; - message: string; - }; - type OrgsListPublicMembersResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OrgsListPendingInvitationsResponseItemInviter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OrgsListPendingInvitationsResponseItem = { - created_at: string; - email: string; - id: number; - invitation_team_url: string; - inviter: OrgsListPendingInvitationsResponseItemInviter; - login: string; - role: string; - team_count: number; - }; - type OrgsListOutsideCollaboratorsResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OrgsListMembershipsResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OrgsListMembershipsResponseItemOrganization = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type OrgsListMembershipsResponseItem = { - organization: OrgsListMembershipsResponseItemOrganization; - organization_url: string; - role: string; - state: string; - url: string; - user: OrgsListMembershipsResponseItemUser; - }; - type OrgsListMembersResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OrgsListInvitationTeamsResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; - }; - type OrgsListInstallationsResponseInstallationsItemPermissions = { - deployments: string; - metadata: string; - pull_requests: string; - statuses: string; - }; - type OrgsListInstallationsResponseInstallationsItemAccount = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OrgsListInstallationsResponseInstallationsItem = { - access_tokens_url: string; - account: OrgsListInstallationsResponseInstallationsItemAccount; - app_id: number; - created_at: string; - events: Array; - html_url: string; - id: number; - permissions: OrgsListInstallationsResponseInstallationsItemPermissions; - repositories_url: string; - repository_selection: string; - single_file_name: null; - target_id: number; - target_type: string; - updated_at: string; - }; - type OrgsListInstallationsResponse = { - installations: Array; - total_count: number; - }; - type OrgsListHooksResponseItemConfig = { content_type: string; url: string }; - type OrgsListHooksResponseItem = { - active: boolean; - config: OrgsListHooksResponseItemConfig; - created_at: string; - events: Array; - id: number; - name: string; - ping_url: string; - updated_at: string; - url: string; - }; - type OrgsListForUserResponseItem = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type OrgsListForAuthenticatedUserResponseItem = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type OrgsListBlockedUsersResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OrgsListResponseItem = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type OrgsGetMembershipForAuthenticatedUserResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OrgsGetMembershipForAuthenticatedUserResponseOrganization = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type OrgsGetMembershipForAuthenticatedUserResponse = { - organization: OrgsGetMembershipForAuthenticatedUserResponseOrganization; - organization_url: string; - role: string; - state: string; - url: string; - user: OrgsGetMembershipForAuthenticatedUserResponseUser; - }; - type OrgsGetMembershipResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OrgsGetMembershipResponseOrganization = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type OrgsGetMembershipResponse = { - organization: OrgsGetMembershipResponseOrganization; - organization_url: string; - role: string; - state: string; - url: string; - user: OrgsGetMembershipResponseUser; - }; - type OrgsGetHookResponseConfig = { content_type: string; url: string }; - type OrgsGetHookResponse = { - active: boolean; - config: OrgsGetHookResponseConfig; - created_at: string; - events: Array; - id: number; - name: string; - ping_url: string; - updated_at: string; - url: string; - }; - type OrgsGetResponsePlan = { - name: string; - private_repos: number; - space: number; - filled_seats?: number; - seats?: number; - }; - type OrgsGetResponse = { - avatar_url: string; - billing_email?: string; - blog: string; - collaborators?: number; - company: string; - created_at: string; - default_repository_settings?: string; - description: string; - disk_usage?: number; - email: string; - events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; - hooks_url: string; - html_url: string; - id: number; - is_verified: boolean; - issues_url: string; - location: string; - login: string; - members_allowed_repository_creation_type?: string; - members_can_create_repositories?: boolean; - members_url: string; - name: string; - node_id: string; - owned_private_repos?: number; - plan: OrgsGetResponsePlan; - private_gists?: number; - public_gists: number; - public_members_url: string; - public_repos: number; - repos_url: string; - total_private_repos?: number; - two_factor_requirement_enabled?: boolean; - type: string; - url: string; - }; - type OrgsCreateInvitationResponseInviter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OrgsCreateInvitationResponse = { - created_at: string; - email: string; - id: number; - invitation_team_url: string; - inviter: OrgsCreateInvitationResponseInviter; - login: string; - role: string; - team_count: number; - }; - type OrgsCreateHookResponseConfig = { content_type: string; url: string }; - type OrgsCreateHookResponse = { - active: boolean; - config: OrgsCreateHookResponseConfig; - created_at: string; - events: Array; - id: number; - name: string; - ping_url: string; - updated_at: string; - url: string; - }; - type OrgsConvertMemberToOutsideCollaboratorResponse = { - documentation_url: string; - message: string; - }; - type OrgsAddOrUpdateMembershipResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OrgsAddOrUpdateMembershipResponseOrganization = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type OrgsAddOrUpdateMembershipResponse = { - organization: OrgsAddOrUpdateMembershipResponseOrganization; - organization_url: string; - role: string; - state: string; - url: string; - user: OrgsAddOrUpdateMembershipResponseUser; - }; - type OauthAuthorizationsUpdateAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; - }; - type OauthAuthorizationsUpdateAuthorizationResponse = { - app: OauthAuthorizationsUpdateAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - }; - type OauthAuthorizationsResetAuthorizationResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OauthAuthorizationsResetAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; - }; - type OauthAuthorizationsResetAuthorizationResponse = { - app: OauthAuthorizationsResetAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - user: OauthAuthorizationsResetAuthorizationResponseUser; - }; - type OauthAuthorizationsListGrantsResponseItemApp = { - client_id: string; - name: string; - url: string; - }; - type OauthAuthorizationsListGrantsResponseItem = { - app: OauthAuthorizationsListGrantsResponseItemApp; - created_at: string; - id: number; - scopes: Array; - updated_at: string; - url: string; - }; - type OauthAuthorizationsListAuthorizationsResponseItemApp = { - client_id: string; - name: string; - url: string; - }; - type OauthAuthorizationsListAuthorizationsResponseItem = { - app: OauthAuthorizationsListAuthorizationsResponseItemApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - }; - type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponseApp = { - client_id: string; - name: string; - url: string; - }; - type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponse = { - app: OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - }; - type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseApp = { - client_id: string; - name: string; - url: string; - }; - type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse = { - app: OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - }; - type OauthAuthorizationsGetOrCreateAuthorizationForAppResponseApp = { - client_id: string; - name: string; - url: string; - }; - type OauthAuthorizationsGetOrCreateAuthorizationForAppResponse = { - app: OauthAuthorizationsGetOrCreateAuthorizationForAppResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - }; - type OauthAuthorizationsGetGrantResponseApp = { - client_id: string; - name: string; - url: string; - }; - type OauthAuthorizationsGetGrantResponse = { - app: OauthAuthorizationsGetGrantResponseApp; - created_at: string; - id: number; - scopes: Array; - updated_at: string; - url: string; - }; - type OauthAuthorizationsGetAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; - }; - type OauthAuthorizationsGetAuthorizationResponse = { - app: OauthAuthorizationsGetAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - }; - type OauthAuthorizationsCreateAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; - }; - type OauthAuthorizationsCreateAuthorizationResponse = { - app: OauthAuthorizationsCreateAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - }; - type OauthAuthorizationsCheckAuthorizationResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type OauthAuthorizationsCheckAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; - }; - type OauthAuthorizationsCheckAuthorizationResponse = { - app: OauthAuthorizationsCheckAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - user: OauthAuthorizationsCheckAuthorizationResponseUser; - }; - type MigrationsUpdateImportResponse = { - authors_url: string; - html_url: string; - repository_url: string; - status: string; - url: string; - use_lfs: string; - vcs: string; - vcs_url: string; - authors_count?: number; - commit_count?: number; - has_large_files?: boolean; - large_files_count?: number; - large_files_size?: number; - percent?: number; - status_text?: string; - tfvc_project?: string; - }; - type MigrationsStartImportResponse = { - authors_count: number; - authors_url: string; - commit_count: number; - has_large_files: boolean; - html_url: string; - large_files_count: number; - large_files_size: number; - percent: number; - repository_url: string; - status: string; - status_text: string; - url: string; - use_lfs: string; - vcs: string; - vcs_url: string; - }; - type MigrationsStartForOrgResponseRepositoriesItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type MigrationsStartForOrgResponseRepositoriesItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type MigrationsStartForOrgResponseRepositoriesItem = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: MigrationsStartForOrgResponseRepositoriesItemOwner; - permissions: MigrationsStartForOrgResponseRepositoriesItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type MigrationsStartForOrgResponseOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type MigrationsStartForOrgResponse = { - created_at: string; - exclude_attachments: boolean; - guid: string; - id: number; - lock_repositories: boolean; - owner: MigrationsStartForOrgResponseOwner; - repositories: Array; - state: string; - updated_at: string; - url: string; - }; - type MigrationsStartForAuthenticatedUserResponseRepositoriesItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type MigrationsStartForAuthenticatedUserResponseRepositoriesItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type MigrationsStartForAuthenticatedUserResponseRepositoriesItem = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: MigrationsStartForAuthenticatedUserResponseRepositoriesItemOwner; - permissions: MigrationsStartForAuthenticatedUserResponseRepositoriesItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type MigrationsStartForAuthenticatedUserResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type MigrationsStartForAuthenticatedUserResponse = { - created_at: string; - exclude_attachments: boolean; - guid: string; - id: number; - lock_repositories: boolean; - owner: MigrationsStartForAuthenticatedUserResponseOwner; - repositories: Array< - MigrationsStartForAuthenticatedUserResponseRepositoriesItem - >; - state: string; - updated_at: string; - url: string; - }; - type MigrationsSetLfsPreferenceResponse = { - authors_count: number; - authors_url: string; - has_large_files: boolean; - html_url: string; - large_files_count: number; - large_files_size: number; - repository_url: string; - status: string; - status_text: string; - url: string; - use_lfs: string; - vcs: string; - vcs_url: string; - }; - type MigrationsMapCommitAuthorResponse = { - email: string; - id: number; - import_url: string; - name: string; - remote_id: string; - remote_name: string; - url: string; - }; - type MigrationsListForOrgResponseItemRepositoriesItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type MigrationsListForOrgResponseItemRepositoriesItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type MigrationsListForOrgResponseItemRepositoriesItem = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: MigrationsListForOrgResponseItemRepositoriesItemOwner; - permissions: MigrationsListForOrgResponseItemRepositoriesItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type MigrationsListForOrgResponseItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type MigrationsListForOrgResponseItem = { - created_at: string; - exclude_attachments: boolean; - guid: string; - id: number; - lock_repositories: boolean; - owner: MigrationsListForOrgResponseItemOwner; - repositories: Array; - state: string; - updated_at: string; - url: string; - }; - type MigrationsListForAuthenticatedUserResponseItemRepositoriesItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type MigrationsListForAuthenticatedUserResponseItemRepositoriesItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type MigrationsListForAuthenticatedUserResponseItemRepositoriesItem = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: MigrationsListForAuthenticatedUserResponseItemRepositoriesItemOwner; - permissions: MigrationsListForAuthenticatedUserResponseItemRepositoriesItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type MigrationsListForAuthenticatedUserResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type MigrationsListForAuthenticatedUserResponseItem = { - created_at: string; - exclude_attachments: boolean; - guid: string; - id: number; - lock_repositories: boolean; - owner: MigrationsListForAuthenticatedUserResponseItemOwner; - repositories: Array< - MigrationsListForAuthenticatedUserResponseItemRepositoriesItem - >; - state: string; - updated_at: string; - url: string; - }; - type MigrationsGetStatusForOrgResponseRepositoriesItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type MigrationsGetStatusForOrgResponseRepositoriesItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type MigrationsGetStatusForOrgResponseRepositoriesItem = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: MigrationsGetStatusForOrgResponseRepositoriesItemOwner; - permissions: MigrationsGetStatusForOrgResponseRepositoriesItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type MigrationsGetStatusForOrgResponseOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type MigrationsGetStatusForOrgResponse = { - created_at: string; - exclude_attachments: boolean; - guid: string; - id: number; - lock_repositories: boolean; - owner: MigrationsGetStatusForOrgResponseOwner; - repositories: Array; - state: string; - updated_at: string; - url: string; - }; - type MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItem = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemOwner; - permissions: MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type MigrationsGetStatusForAuthenticatedUserResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type MigrationsGetStatusForAuthenticatedUserResponse = { - created_at: string; - exclude_attachments: boolean; - guid: string; - id: number; - lock_repositories: boolean; - owner: MigrationsGetStatusForAuthenticatedUserResponseOwner; - repositories: Array< - MigrationsGetStatusForAuthenticatedUserResponseRepositoriesItem - >; - state: string; - updated_at: string; - url: string; - }; - type MigrationsGetLargeFilesResponseItem = { - oid: string; - path: string; - ref_name: string; - size: number; - }; - type MigrationsGetImportProgressResponse = { - authors_count: number; - authors_url: string; - has_large_files: boolean; - html_url: string; - large_files_count: number; - large_files_size: number; - repository_url: string; - status: string; - status_text: string; - url: string; - use_lfs: string; - vcs: string; - vcs_url: string; - }; - type MigrationsGetCommitAuthorsResponseItem = { - email: string; - id: number; - import_url: string; - name: string; - remote_id: string; - remote_name: string; - url: string; - }; - type MetaGetResponse = { - git: Array; - hooks: Array; - importer: Array; - pages: Array; - verifiable_password_authentication: boolean; - }; - type LicensesListCommonlyUsedResponseItem = { - key: string; - name: string; - node_id?: string; - spdx_id: string; - url: string; - }; - type LicensesListResponseItem = { - key: string; - name: string; - node_id?: string; - spdx_id: string; - url: string; - }; - type LicensesGetForRepoResponseLicense = { - key: string; - name: string; - node_id: string; - spdx_id: string; - url: string; - }; - type LicensesGetForRepoResponseLinks = { - git: string; - html: string; - self: string; - }; - type LicensesGetForRepoResponse = { - _links: LicensesGetForRepoResponseLinks; - content: string; - download_url: string; - encoding: string; - git_url: string; - html_url: string; - license: LicensesGetForRepoResponseLicense; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; - }; - type LicensesGetResponse = { - body: string; - conditions: Array; - description: string; - featured: boolean; - html_url: string; - implementation: string; - key: string; - limitations: Array; - name: string; - node_id: string; - permissions: Array; - spdx_id: string; - url: string; - }; - type IssuesUpdateMilestoneResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesUpdateMilestoneResponse = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesUpdateMilestoneResponseCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesUpdateLabelResponse = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesUpdateCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesUpdateCommentResponse = { - body: string; - created_at: string; - html_url: string; - id: number; - node_id: string; - updated_at: string; - url: string; - user: IssuesUpdateCommentResponseUser; - }; - type IssuesUpdateResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesUpdateResponsePullRequest = { - diff_url: string; - html_url: string; - patch_url: string; - url: string; - }; - type IssuesUpdateResponseMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesUpdateResponseMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesUpdateResponseMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesUpdateResponseLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesUpdateResponseClosedBy = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesUpdateResponseAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesUpdateResponseAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesUpdateResponse = { - active_lock_reason: string; - assignee: IssuesUpdateResponseAssignee; - assignees: Array; - body: string; - closed_at: null; - closed_by: IssuesUpdateResponseClosedBy; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - locked: boolean; - milestone: IssuesUpdateResponseMilestone; - node_id: string; - number: number; - pull_request: IssuesUpdateResponsePullRequest; - repository_url: string; - state: string; - title: string; - updated_at: string; - url: string; - user: IssuesUpdateResponseUser; - }; - type IssuesReplaceLabelsResponseItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesRemoveLabelResponseItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesRemoveAssigneesResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesRemoveAssigneesResponsePullRequest = { - diff_url: string; - html_url: string; - patch_url: string; - url: string; - }; - type IssuesRemoveAssigneesResponseMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesRemoveAssigneesResponseMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesRemoveAssigneesResponseMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesRemoveAssigneesResponseLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesRemoveAssigneesResponseAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesRemoveAssigneesResponseAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesRemoveAssigneesResponse = { - active_lock_reason: string; - assignee: IssuesRemoveAssigneesResponseAssignee; - assignees: Array; - body: string; - closed_at: null; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - locked: boolean; - milestone: IssuesRemoveAssigneesResponseMilestone; - node_id: string; - number: number; - pull_request: IssuesRemoveAssigneesResponsePullRequest; - repository_url: string; - state: string; - title: string; - updated_at: string; - url: string; - user: IssuesRemoveAssigneesResponseUser; - }; - type IssuesListMilestonesForRepoResponseItemCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListMilestonesForRepoResponseItem = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesListMilestonesForRepoResponseItemCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesListLabelsOnIssueResponseItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesListLabelsForRepoResponseItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesListLabelsForMilestoneResponseItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesListForRepoResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForRepoResponseItemPullRequest = { - diff_url: string; - html_url: string; - patch_url: string; - url: string; - }; - type IssuesListForRepoResponseItemMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForRepoResponseItemMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesListForRepoResponseItemMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesListForRepoResponseItemLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesListForRepoResponseItemAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForRepoResponseItemAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForRepoResponseItem = { - active_lock_reason: string; - assignee: IssuesListForRepoResponseItemAssignee; - assignees: Array; - body: string; - closed_at: null; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - locked: boolean; - milestone: IssuesListForRepoResponseItemMilestone; - node_id: string; - number: number; - pull_request: IssuesListForRepoResponseItemPullRequest; - repository_url: string; - state: string; - title: string; - updated_at: string; - url: string; - user: IssuesListForRepoResponseItemUser; - }; - type IssuesListForOrgResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForOrgResponseItemRepositoryPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type IssuesListForOrgResponseItemRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForOrgResponseItemRepository = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: IssuesListForOrgResponseItemRepositoryOwner; - permissions: IssuesListForOrgResponseItemRepositoryPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type IssuesListForOrgResponseItemPullRequest = { - diff_url: string; - html_url: string; - patch_url: string; - url: string; - }; - type IssuesListForOrgResponseItemMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForOrgResponseItemMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesListForOrgResponseItemMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesListForOrgResponseItemLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesListForOrgResponseItemAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForOrgResponseItemAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForOrgResponseItem = { - active_lock_reason: string; - assignee: IssuesListForOrgResponseItemAssignee; - assignees: Array; - body: string; - closed_at: null; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - locked: boolean; - milestone: IssuesListForOrgResponseItemMilestone; - node_id: string; - number: number; - pull_request: IssuesListForOrgResponseItemPullRequest; - repository: IssuesListForOrgResponseItemRepository; - repository_url: string; - state: string; - title: string; - updated_at: string; - url: string; - user: IssuesListForOrgResponseItemUser; - }; - type IssuesListForAuthenticatedUserResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForAuthenticatedUserResponseItemRepositoryPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type IssuesListForAuthenticatedUserResponseItemRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForAuthenticatedUserResponseItemRepository = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: IssuesListForAuthenticatedUserResponseItemRepositoryOwner; - permissions: IssuesListForAuthenticatedUserResponseItemRepositoryPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type IssuesListForAuthenticatedUserResponseItemPullRequest = { - diff_url: string; - html_url: string; - patch_url: string; - url: string; - }; - type IssuesListForAuthenticatedUserResponseItemMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForAuthenticatedUserResponseItemMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesListForAuthenticatedUserResponseItemMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesListForAuthenticatedUserResponseItemLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesListForAuthenticatedUserResponseItemAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForAuthenticatedUserResponseItemAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListForAuthenticatedUserResponseItem = { - active_lock_reason: string; - assignee: IssuesListForAuthenticatedUserResponseItemAssignee; - assignees: Array; - body: string; - closed_at: null; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - locked: boolean; - milestone: IssuesListForAuthenticatedUserResponseItemMilestone; - node_id: string; - number: number; - pull_request: IssuesListForAuthenticatedUserResponseItemPullRequest; - repository: IssuesListForAuthenticatedUserResponseItemRepository; - repository_url: string; - state: string; - title: string; - updated_at: string; - url: string; - user: IssuesListForAuthenticatedUserResponseItemUser; - }; - type IssuesListEventsForTimelineResponseItemActor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListEventsForTimelineResponseItem = { - actor: IssuesListEventsForTimelineResponseItemActor; - commit_id: string; - commit_url: string; - created_at: string; - event: string; - id: number; - node_id: string; - url: string; - }; - type IssuesListEventsForRepoResponseItemIssueUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListEventsForRepoResponseItemIssuePullRequest = { - diff_url: string; - html_url: string; - patch_url: string; - url: string; - }; - type IssuesListEventsForRepoResponseItemIssueMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListEventsForRepoResponseItemIssueMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesListEventsForRepoResponseItemIssueMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesListEventsForRepoResponseItemIssueLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesListEventsForRepoResponseItemIssueAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListEventsForRepoResponseItemIssueAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListEventsForRepoResponseItemIssue = { - active_lock_reason: string; - assignee: IssuesListEventsForRepoResponseItemIssueAssignee; - assignees: Array; - body: string; - closed_at: null; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - locked: boolean; - milestone: IssuesListEventsForRepoResponseItemIssueMilestone; - node_id: string; - number: number; - pull_request: IssuesListEventsForRepoResponseItemIssuePullRequest; - repository_url: string; - state: string; - title: string; - updated_at: string; - url: string; - user: IssuesListEventsForRepoResponseItemIssueUser; - }; - type IssuesListEventsForRepoResponseItemActor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListEventsForRepoResponseItem = { - actor: IssuesListEventsForRepoResponseItemActor; - commit_id: string; - commit_url: string; - created_at: string; - event: string; - id: number; - issue: IssuesListEventsForRepoResponseItemIssue; - node_id: string; - url: string; - }; - type IssuesListEventsResponseItemActor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListEventsResponseItem = { - actor: IssuesListEventsResponseItemActor; - commit_id: string; - commit_url: string; - created_at: string; - event: string; - id: number; - node_id: string; - url: string; - }; - type IssuesListCommentsForRepoResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListCommentsForRepoResponseItem = { - body: string; - created_at: string; - html_url: string; - id: number; - node_id: string; - updated_at: string; - url: string; - user: IssuesListCommentsForRepoResponseItemUser; - }; - type IssuesListCommentsResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListCommentsResponseItem = { - body: string; - created_at: string; - html_url: string; - id: number; - node_id: string; - updated_at: string; - url: string; - user: IssuesListCommentsResponseItemUser; - }; - type IssuesListAssigneesResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListResponseItemRepositoryPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type IssuesListResponseItemRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListResponseItemRepository = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: IssuesListResponseItemRepositoryOwner; - permissions: IssuesListResponseItemRepositoryPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type IssuesListResponseItemPullRequest = { - diff_url: string; - html_url: string; - patch_url: string; - url: string; - }; - type IssuesListResponseItemMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListResponseItemMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesListResponseItemMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesListResponseItemLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesListResponseItemAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListResponseItemAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesListResponseItem = { - active_lock_reason: string; - assignee: IssuesListResponseItemAssignee; - assignees: Array; - body: string; - closed_at: null; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - locked: boolean; - milestone: IssuesListResponseItemMilestone; - node_id: string; - number: number; - pull_request: IssuesListResponseItemPullRequest; - repository: IssuesListResponseItemRepository; - repository_url: string; - state: string; - title: string; - updated_at: string; - url: string; - user: IssuesListResponseItemUser; - }; - type IssuesGetMilestoneResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesGetMilestoneResponse = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesGetMilestoneResponseCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesGetLabelResponse = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesGetEventResponseIssueUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesGetEventResponseIssuePullRequest = { - diff_url: string; - html_url: string; - patch_url: string; - url: string; - }; - type IssuesGetEventResponseIssueMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesGetEventResponseIssueMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesGetEventResponseIssueMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesGetEventResponseIssueLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesGetEventResponseIssueAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesGetEventResponseIssueAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesGetEventResponseIssue = { - active_lock_reason: string; - assignee: IssuesGetEventResponseIssueAssignee; - assignees: Array; - body: string; - closed_at: null; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - locked: boolean; - milestone: IssuesGetEventResponseIssueMilestone; - node_id: string; - number: number; - pull_request: IssuesGetEventResponseIssuePullRequest; - repository_url: string; - state: string; - title: string; - updated_at: string; - url: string; - user: IssuesGetEventResponseIssueUser; - }; - type IssuesGetEventResponseActor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesGetEventResponse = { - actor: IssuesGetEventResponseActor; - commit_id: string; - commit_url: string; - created_at: string; - event: string; - id: number; - issue: IssuesGetEventResponseIssue; - node_id: string; - url: string; - }; - type IssuesGetCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesGetCommentResponse = { - body: string; - created_at: string; - html_url: string; - id: number; - node_id: string; - updated_at: string; - url: string; - user: IssuesGetCommentResponseUser; - }; - type IssuesGetResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesGetResponsePullRequest = { - diff_url: string; - html_url: string; - patch_url: string; - url: string; - }; - type IssuesGetResponseMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesGetResponseMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesGetResponseMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesGetResponseLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesGetResponseClosedBy = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesGetResponseAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesGetResponseAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesGetResponse = { - active_lock_reason: string; - assignee: IssuesGetResponseAssignee; - assignees: Array; - body: string; - closed_at: null; - closed_by: IssuesGetResponseClosedBy; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - locked: boolean; - milestone: IssuesGetResponseMilestone; - node_id: string; - number: number; - pull_request: IssuesGetResponsePullRequest; - repository_url: string; - state: string; - title: string; - updated_at: string; - url: string; - user: IssuesGetResponseUser; - }; - type IssuesCreateMilestoneResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesCreateMilestoneResponse = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesCreateMilestoneResponseCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesCreateLabelResponse = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesCreateCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesCreateCommentResponse = { - body: string; - created_at: string; - html_url: string; - id: number; - node_id: string; - updated_at: string; - url: string; - user: IssuesCreateCommentResponseUser; - }; - type IssuesCreateResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesCreateResponsePullRequest = { - diff_url: string; - html_url: string; - patch_url: string; - url: string; - }; - type IssuesCreateResponseMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesCreateResponseMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesCreateResponseMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesCreateResponseLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesCreateResponseClosedBy = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesCreateResponseAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesCreateResponseAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesCreateResponse = { - active_lock_reason: string; - assignee: IssuesCreateResponseAssignee; - assignees: Array; - body: string; - closed_at: null; - closed_by: IssuesCreateResponseClosedBy; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - locked: boolean; - milestone: IssuesCreateResponseMilestone; - node_id: string; - number: number; - pull_request: IssuesCreateResponsePullRequest; - repository_url: string; - state: string; - title: string; - updated_at: string; - url: string; - user: IssuesCreateResponseUser; - }; - type IssuesAddLabelsResponseItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesAddAssigneesResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesAddAssigneesResponsePullRequest = { - diff_url: string; - html_url: string; - patch_url: string; - url: string; - }; - type IssuesAddAssigneesResponseMilestoneCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesAddAssigneesResponseMilestone = { - closed_at: string; - closed_issues: number; - created_at: string; - creator: IssuesAddAssigneesResponseMilestoneCreator; - description: string; - due_on: string; - html_url: string; - id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; - url: string; - }; - type IssuesAddAssigneesResponseLabelsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - url: string; - }; - type IssuesAddAssigneesResponseAssigneesItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesAddAssigneesResponseAssignee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type IssuesAddAssigneesResponse = { - active_lock_reason: string; - assignee: IssuesAddAssigneesResponseAssignee; - assignees: Array; - body: string; - closed_at: null; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - locked: boolean; - milestone: IssuesAddAssigneesResponseMilestone; - node_id: string; - number: number; - pull_request: IssuesAddAssigneesResponsePullRequest; - repository_url: string; - state: string; - title: string; - updated_at: string; - url: string; - user: IssuesAddAssigneesResponseUser; - }; - type InteractionsGetRestrictionsForRepoResponse = { - expires_at: string; - limit: string; - origin: string; - }; - type InteractionsGetRestrictionsForOrgResponse = { - expires_at: string; - limit: string; - origin: string; - }; - type InteractionsAddOrUpdateRestrictionsForRepoResponse = { - expires_at: string; - limit: string; - origin: string; - }; - type InteractionsAddOrUpdateRestrictionsForOrgResponse = { - expires_at: string; - limit: string; - origin: string; - }; - type GitignoreGetTemplateResponse = { name: string; source: string }; - type GitUpdateRefResponseObject = { sha: string; type: string; url: string }; - type GitUpdateRefResponse = { - node_id: string; - object: GitUpdateRefResponseObject; - ref: string; - url: string; - }; - type GitListMatchingRefsResponseItemObject = { - sha: string; - type: string; - url: string; - }; - type GitListMatchingRefsResponseItem = { - node_id: string; - object: GitListMatchingRefsResponseItemObject; - ref: string; - url: string; - }; - type GitGetTagResponseVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type GitGetTagResponseTagger = { date: string; email: string; name: string }; - type GitGetTagResponseObject = { sha: string; type: string; url: string }; - type GitGetTagResponse = { - message: string; - node_id: string; - object: GitGetTagResponseObject; - sha: string; - tag: string; - tagger: GitGetTagResponseTagger; - url: string; - verification: GitGetTagResponseVerification; - }; - type GitGetRefResponseObject = { sha: string; type: string; url: string }; - type GitGetRefResponse = { - node_id: string; - object: GitGetRefResponseObject; - ref: string; - url: string; - }; - type GitGetCommitResponseVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type GitGetCommitResponseTree = { sha: string; url: string }; - type GitGetCommitResponseParentsItem = { sha: string; url: string }; - type GitGetCommitResponseCommitter = { - date: string; - email: string; - name: string; - }; - type GitGetCommitResponseAuthor = { - date: string; - email: string; - name: string; - }; - type GitGetCommitResponse = { - author: GitGetCommitResponseAuthor; - committer: GitGetCommitResponseCommitter; - message: string; - parents: Array; - sha: string; - tree: GitGetCommitResponseTree; - url: string; - verification: GitGetCommitResponseVerification; - }; - type GitGetBlobResponse = { - content: string; - encoding: string; - sha: string; - size: number; - url: string; - }; - type GitCreateTreeResponseTreeItem = { - mode: string; - path: string; - sha: string; - size: number; - type: string; - url: string; - }; - type GitCreateTreeResponse = { - sha: string; - tree: Array; - url: string; - }; - type GitCreateTagResponseVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type GitCreateTagResponseTagger = { - date: string; - email: string; - name: string; - }; - type GitCreateTagResponseObject = { sha: string; type: string; url: string }; - type GitCreateTagResponse = { - message: string; - node_id: string; - object: GitCreateTagResponseObject; - sha: string; - tag: string; - tagger: GitCreateTagResponseTagger; - url: string; - verification: GitCreateTagResponseVerification; - }; - type GitCreateRefResponseObject = { sha: string; type: string; url: string }; - type GitCreateRefResponse = { - node_id: string; - object: GitCreateRefResponseObject; - ref: string; - url: string; - }; - type GitCreateCommitResponseVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; - }; - type GitCreateCommitResponseTree = { sha: string; url: string }; - type GitCreateCommitResponseParentsItem = { sha: string; url: string }; - type GitCreateCommitResponseCommitter = { - date: string; - email: string; - name: string; - }; - type GitCreateCommitResponseAuthor = { - date: string; - email: string; - name: string; - }; - type GitCreateCommitResponse = { - author: GitCreateCommitResponseAuthor; - committer: GitCreateCommitResponseCommitter; - message: string; - node_id: string; - parents: Array; - sha: string; - tree: GitCreateCommitResponseTree; - url: string; - verification: GitCreateCommitResponseVerification; - }; - type GitCreateBlobResponse = { sha: string; url: string }; - type GistsUpdateCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsUpdateCommentResponse = { - body: string; - created_at: string; - id: number; - node_id: string; - updated_at: string; - url: string; - user: GistsUpdateCommentResponseUser; - }; - type GistsUpdateResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsUpdateResponseHistoryItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsUpdateResponseHistoryItemChangeStatus = { - additions: number; - deletions: number; - total: number; - }; - type GistsUpdateResponseHistoryItem = { - change_status: GistsUpdateResponseHistoryItemChangeStatus; - committed_at: string; - url: string; - user: GistsUpdateResponseHistoryItemUser; - version: string; - }; - type GistsUpdateResponseForksItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsUpdateResponseForksItem = { - created_at: string; - id: string; - updated_at: string; - url: string; - user: GistsUpdateResponseForksItemUser; - }; - type GistsUpdateResponseFilesNewFileTxt = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsUpdateResponseFilesHelloWorldRb = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsUpdateResponseFilesHelloWorldPy = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsUpdateResponseFilesHelloWorldMd = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsUpdateResponseFiles = { - "hello_world.md": GistsUpdateResponseFilesHelloWorldMd; - "hello_world.py": GistsUpdateResponseFilesHelloWorldPy; - "hello_world.rb": GistsUpdateResponseFilesHelloWorldRb; - "new_file.txt": GistsUpdateResponseFilesNewFileTxt; - }; - type GistsUpdateResponse = { - comments: number; - comments_url: string; - commits_url: string; - created_at: string; - description: string; - files: GistsUpdateResponseFiles; - forks: Array; - forks_url: string; - git_pull_url: string; - git_push_url: string; - history: Array; - html_url: string; - id: string; - node_id: string; - owner: GistsUpdateResponseOwner; - public: boolean; - truncated: boolean; - updated_at: string; - url: string; - user: null; - }; - type GistsListStarredResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsListStarredResponseItemFilesHelloWorldRb = { - filename: string; - language: string; - raw_url: string; - size: number; - type: string; - }; - type GistsListStarredResponseItemFiles = { - "hello_world.rb": GistsListStarredResponseItemFilesHelloWorldRb; - }; - type GistsListStarredResponseItem = { - comments: number; - comments_url: string; - commits_url: string; - created_at: string; - description: string; - files: GistsListStarredResponseItemFiles; - forks_url: string; - git_pull_url: string; - git_push_url: string; - html_url: string; - id: string; - node_id: string; - owner: GistsListStarredResponseItemOwner; - public: boolean; - truncated: boolean; - updated_at: string; - url: string; - user: null; - }; - type GistsListPublicForUserResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsListPublicForUserResponseItemFilesHelloWorldRb = { - filename: string; - language: string; - raw_url: string; - size: number; - type: string; - }; - type GistsListPublicForUserResponseItemFiles = { - "hello_world.rb": GistsListPublicForUserResponseItemFilesHelloWorldRb; - }; - type GistsListPublicForUserResponseItem = { - comments: number; - comments_url: string; - commits_url: string; - created_at: string; - description: string; - files: GistsListPublicForUserResponseItemFiles; - forks_url: string; - git_pull_url: string; - git_push_url: string; - html_url: string; - id: string; - node_id: string; - owner: GistsListPublicForUserResponseItemOwner; - public: boolean; - truncated: boolean; - updated_at: string; - url: string; - user: null; - }; - type GistsListPublicResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsListPublicResponseItemFilesHelloWorldRb = { - filename: string; - language: string; - raw_url: string; - size: number; - type: string; - }; - type GistsListPublicResponseItemFiles = { - "hello_world.rb": GistsListPublicResponseItemFilesHelloWorldRb; - }; - type GistsListPublicResponseItem = { - comments: number; - comments_url: string; - commits_url: string; - created_at: string; - description: string; - files: GistsListPublicResponseItemFiles; - forks_url: string; - git_pull_url: string; - git_push_url: string; - html_url: string; - id: string; - node_id: string; - owner: GistsListPublicResponseItemOwner; - public: boolean; - truncated: boolean; - updated_at: string; - url: string; - user: null; - }; - type GistsListForksResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsListForksResponseItem = { - created_at: string; - id: string; - updated_at: string; - url: string; - user: GistsListForksResponseItemUser; - }; - type GistsListCommitsResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsListCommitsResponseItemChangeStatus = { - additions: number; - deletions: number; - total: number; - }; - type GistsListCommitsResponseItem = { - change_status: GistsListCommitsResponseItemChangeStatus; - committed_at: string; - url: string; - user: GistsListCommitsResponseItemUser; - version: string; - }; - type GistsListCommentsResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsListCommentsResponseItem = { - body: string; - created_at: string; - id: number; - node_id: string; - updated_at: string; - url: string; - user: GistsListCommentsResponseItemUser; - }; - type GistsListResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsListResponseItemFilesHelloWorldRb = { - filename: string; - language: string; - raw_url: string; - size: number; - type: string; - }; - type GistsListResponseItemFiles = { - "hello_world.rb": GistsListResponseItemFilesHelloWorldRb; - }; - type GistsListResponseItem = { - comments: number; - comments_url: string; - commits_url: string; - created_at: string; - description: string; - files: GistsListResponseItemFiles; - forks_url: string; - git_pull_url: string; - git_push_url: string; - html_url: string; - id: string; - node_id: string; - owner: GistsListResponseItemOwner; - public: boolean; - truncated: boolean; - updated_at: string; - url: string; - user: null; - }; - type GistsGetRevisionResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsGetRevisionResponseHistoryItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsGetRevisionResponseHistoryItemChangeStatus = { - additions: number; - deletions: number; - total: number; - }; - type GistsGetRevisionResponseHistoryItem = { - change_status: GistsGetRevisionResponseHistoryItemChangeStatus; - committed_at: string; - url: string; - user: GistsGetRevisionResponseHistoryItemUser; - version: string; - }; - type GistsGetRevisionResponseForksItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsGetRevisionResponseForksItem = { - created_at: string; - id: string; - updated_at: string; - url: string; - user: GistsGetRevisionResponseForksItemUser; - }; - type GistsGetRevisionResponseFilesHelloWorldRubyTxt = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsGetRevisionResponseFilesHelloWorldPythonTxt = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsGetRevisionResponseFilesHelloWorldRb = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsGetRevisionResponseFilesHelloWorldPy = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsGetRevisionResponseFiles = { - "hello_world.py": GistsGetRevisionResponseFilesHelloWorldPy; - "hello_world.rb": GistsGetRevisionResponseFilesHelloWorldRb; - "hello_world_python.txt": GistsGetRevisionResponseFilesHelloWorldPythonTxt; - "hello_world_ruby.txt": GistsGetRevisionResponseFilesHelloWorldRubyTxt; - }; - type GistsGetRevisionResponse = { - comments: number; - comments_url: string; - commits_url: string; - created_at: string; - description: string; - files: GistsGetRevisionResponseFiles; - forks: Array; - forks_url: string; - git_pull_url: string; - git_push_url: string; - history: Array; - html_url: string; - id: string; - node_id: string; - owner: GistsGetRevisionResponseOwner; - public: boolean; - truncated: boolean; - updated_at: string; - url: string; - user: null; - }; - type GistsGetCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsGetCommentResponse = { - body: string; - created_at: string; - id: number; - node_id: string; - updated_at: string; - url: string; - user: GistsGetCommentResponseUser; - }; - type GistsGetResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsGetResponseHistoryItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsGetResponseHistoryItemChangeStatus = { - additions: number; - deletions: number; - total: number; - }; - type GistsGetResponseHistoryItem = { - change_status: GistsGetResponseHistoryItemChangeStatus; - committed_at: string; - url: string; - user: GistsGetResponseHistoryItemUser; - version: string; - }; - type GistsGetResponseForksItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsGetResponseForksItem = { - created_at: string; - id: string; - updated_at: string; - url: string; - user: GistsGetResponseForksItemUser; - }; - type GistsGetResponseFilesHelloWorldRubyTxt = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsGetResponseFilesHelloWorldPythonTxt = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsGetResponseFilesHelloWorldRb = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsGetResponseFilesHelloWorldPy = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsGetResponseFiles = { - "hello_world.py": GistsGetResponseFilesHelloWorldPy; - "hello_world.rb": GistsGetResponseFilesHelloWorldRb; - "hello_world_python.txt": GistsGetResponseFilesHelloWorldPythonTxt; - "hello_world_ruby.txt": GistsGetResponseFilesHelloWorldRubyTxt; - }; - type GistsGetResponse = { - comments: number; - comments_url: string; - commits_url: string; - created_at: string; - description: string; - files: GistsGetResponseFiles; - forks: Array; - forks_url: string; - git_pull_url: string; - git_push_url: string; - history: Array; - html_url: string; - id: string; - node_id: string; - owner: GistsGetResponseOwner; - public: boolean; - truncated: boolean; - updated_at: string; - url: string; - user: null; - }; - type GistsForkResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsForkResponseFilesHelloWorldRb = { - filename: string; - language: string; - raw_url: string; - size: number; - type: string; - }; - type GistsForkResponseFiles = { - "hello_world.rb": GistsForkResponseFilesHelloWorldRb; - }; - type GistsForkResponse = { - comments: number; - comments_url: string; - commits_url: string; - created_at: string; - description: string; - files: GistsForkResponseFiles; - forks_url: string; - git_pull_url: string; - git_push_url: string; - html_url: string; - id: string; - node_id: string; - owner: GistsForkResponseOwner; - public: boolean; - truncated: boolean; - updated_at: string; - url: string; - user: null; - }; - type GistsCreateCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsCreateCommentResponse = { - body: string; - created_at: string; - id: number; - node_id: string; - updated_at: string; - url: string; - user: GistsCreateCommentResponseUser; - }; - type GistsCreateResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsCreateResponseHistoryItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsCreateResponseHistoryItemChangeStatus = { - additions: number; - deletions: number; - total: number; - }; - type GistsCreateResponseHistoryItem = { - change_status: GistsCreateResponseHistoryItemChangeStatus; - committed_at: string; - url: string; - user: GistsCreateResponseHistoryItemUser; - version: string; - }; - type GistsCreateResponseForksItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type GistsCreateResponseForksItem = { - created_at: string; - id: string; - updated_at: string; - url: string; - user: GistsCreateResponseForksItemUser; - }; - type GistsCreateResponseFilesHelloWorldRubyTxt = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsCreateResponseFilesHelloWorldPythonTxt = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsCreateResponseFilesHelloWorldRb = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsCreateResponseFilesHelloWorldPy = { - content: string; - filename: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - type: string; - }; - type GistsCreateResponseFiles = { - "hello_world.py": GistsCreateResponseFilesHelloWorldPy; - "hello_world.rb": GistsCreateResponseFilesHelloWorldRb; - "hello_world_python.txt": GistsCreateResponseFilesHelloWorldPythonTxt; - "hello_world_ruby.txt": GistsCreateResponseFilesHelloWorldRubyTxt; - }; - type GistsCreateResponse = { - comments: number; - comments_url: string; - commits_url: string; - created_at: string; - description: string; - files: GistsCreateResponseFiles; - forks: Array; - forks_url: string; - git_pull_url: string; - git_push_url: string; - history: Array; - html_url: string; - id: string; - node_id: string; - owner: GistsCreateResponseOwner; - public: boolean; - truncated: boolean; - updated_at: string; - url: string; - user: null; - }; - type CodesOfConductListConductCodesResponseItem = { - key: string; - name: string; - url: string; - }; - type CodesOfConductGetForRepoResponse = { - body: string; - key: string; - name: string; - url: string; - }; - type CodesOfConductGetConductCodeResponse = { - body: string; - key: string; - name: string; - url: string; - }; - type ChecksUpdateResponsePullRequestsItemHeadRepo = { - id: number; - name: string; - url: string; - }; - type ChecksUpdateResponsePullRequestsItemHead = { - ref: string; - repo: ChecksUpdateResponsePullRequestsItemHeadRepo; - sha: string; - }; - type ChecksUpdateResponsePullRequestsItemBaseRepo = { - id: number; - name: string; - url: string; - }; - type ChecksUpdateResponsePullRequestsItemBase = { - ref: string; - repo: ChecksUpdateResponsePullRequestsItemBaseRepo; - sha: string; - }; - type ChecksUpdateResponsePullRequestsItem = { - base: ChecksUpdateResponsePullRequestsItemBase; - head: ChecksUpdateResponsePullRequestsItemHead; - id: number; - number: number; - url: string; - }; - type ChecksUpdateResponseOutput = { - annotations_count: number; - annotations_url: string; - summary: string; - text: string; - title: string; - }; - type ChecksUpdateResponseCheckSuite = { id: number }; - type ChecksUpdateResponseAppPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ChecksUpdateResponseAppOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ChecksUpdateResponseApp = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ChecksUpdateResponseAppOwner; - permissions: ChecksUpdateResponseAppPermissions; - slug: string; - updated_at: string; - }; - type ChecksUpdateResponse = { - app: ChecksUpdateResponseApp; - check_suite: ChecksUpdateResponseCheckSuite; - completed_at: string; - conclusion: string; - details_url: string; - external_id: string; - head_sha: string; - html_url: string; - id: number; - name: string; - node_id: string; - output: ChecksUpdateResponseOutput; - pull_requests: Array; - started_at: string; - status: string; - url: string; - }; - type ChecksSetSuitesPreferencesResponseRepositoryPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ChecksSetSuitesPreferencesResponseRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ChecksSetSuitesPreferencesResponseRepository = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ChecksSetSuitesPreferencesResponseRepositoryOwner; - permissions: ChecksSetSuitesPreferencesResponseRepositoryPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ChecksSetSuitesPreferencesResponsePreferencesAutoTriggerChecksItem = { - app_id: number; - setting: boolean; - }; - type ChecksSetSuitesPreferencesResponsePreferences = { - auto_trigger_checks: Array< - ChecksSetSuitesPreferencesResponsePreferencesAutoTriggerChecksItem - >; - }; - type ChecksSetSuitesPreferencesResponse = { - preferences: ChecksSetSuitesPreferencesResponsePreferences; - repository: ChecksSetSuitesPreferencesResponseRepository; - }; - type ChecksListSuitesForRefResponseCheckSuitesItemRepositoryPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ChecksListSuitesForRefResponseCheckSuitesItemRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ChecksListSuitesForRefResponseCheckSuitesItemRepository = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ChecksListSuitesForRefResponseCheckSuitesItemRepositoryOwner; - permissions: ChecksListSuitesForRefResponseCheckSuitesItemRepositoryPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ChecksListSuitesForRefResponseCheckSuitesItemAppPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ChecksListSuitesForRefResponseCheckSuitesItemAppOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ChecksListSuitesForRefResponseCheckSuitesItemApp = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ChecksListSuitesForRefResponseCheckSuitesItemAppOwner; - permissions: ChecksListSuitesForRefResponseCheckSuitesItemAppPermissions; - slug: string; - updated_at: string; - }; - type ChecksListSuitesForRefResponseCheckSuitesItem = { - after: string; - app: ChecksListSuitesForRefResponseCheckSuitesItemApp; - before: string; - conclusion: string; - head_branch: string; - head_sha: string; - id: number; - node_id: string; - pull_requests: Array; - repository: ChecksListSuitesForRefResponseCheckSuitesItemRepository; - status: string; - url: string; - }; - type ChecksListSuitesForRefResponse = { - check_suites: Array; - total_count: number; - }; - type ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHeadRepo = { - id: number; - name: string; - url: string; - }; - type ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHead = { - ref: string; - repo: ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHeadRepo; - sha: string; - }; - type ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBaseRepo = { - id: number; - name: string; - url: string; - }; - type ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBase = { - ref: string; - repo: ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBaseRepo; - sha: string; - }; - type ChecksListForSuiteResponseCheckRunsItemPullRequestsItem = { - base: ChecksListForSuiteResponseCheckRunsItemPullRequestsItemBase; - head: ChecksListForSuiteResponseCheckRunsItemPullRequestsItemHead; - id: number; - number: number; - url: string; - }; - type ChecksListForSuiteResponseCheckRunsItemOutput = { - annotations_count: number; - annotations_url: string; - summary: string; - text: string; - title: string; - }; - type ChecksListForSuiteResponseCheckRunsItemCheckSuite = { id: number }; - type ChecksListForSuiteResponseCheckRunsItemAppPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ChecksListForSuiteResponseCheckRunsItemAppOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ChecksListForSuiteResponseCheckRunsItemApp = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ChecksListForSuiteResponseCheckRunsItemAppOwner; - permissions: ChecksListForSuiteResponseCheckRunsItemAppPermissions; - slug: string; - updated_at: string; - }; - type ChecksListForSuiteResponseCheckRunsItem = { - app: ChecksListForSuiteResponseCheckRunsItemApp; - check_suite: ChecksListForSuiteResponseCheckRunsItemCheckSuite; - completed_at: string; - conclusion: string; - details_url: string; - external_id: string; - head_sha: string; - html_url: string; - id: number; - name: string; - node_id: string; - output: ChecksListForSuiteResponseCheckRunsItemOutput; - pull_requests: Array< - ChecksListForSuiteResponseCheckRunsItemPullRequestsItem - >; - started_at: string; - status: string; - url: string; - }; - type ChecksListForSuiteResponse = { - check_runs: Array; - total_count: number; - }; - type ChecksListForRefResponseCheckRunsItemPullRequestsItemHeadRepo = { - id: number; - name: string; - url: string; - }; - type ChecksListForRefResponseCheckRunsItemPullRequestsItemHead = { - ref: string; - repo: ChecksListForRefResponseCheckRunsItemPullRequestsItemHeadRepo; - sha: string; - }; - type ChecksListForRefResponseCheckRunsItemPullRequestsItemBaseRepo = { - id: number; - name: string; - url: string; - }; - type ChecksListForRefResponseCheckRunsItemPullRequestsItemBase = { - ref: string; - repo: ChecksListForRefResponseCheckRunsItemPullRequestsItemBaseRepo; - sha: string; - }; - type ChecksListForRefResponseCheckRunsItemPullRequestsItem = { - base: ChecksListForRefResponseCheckRunsItemPullRequestsItemBase; - head: ChecksListForRefResponseCheckRunsItemPullRequestsItemHead; - id: number; - number: number; - url: string; - }; - type ChecksListForRefResponseCheckRunsItemOutput = { - annotations_count: number; - annotations_url: string; - summary: string; - text: string; - title: string; - }; - type ChecksListForRefResponseCheckRunsItemCheckSuite = { id: number }; - type ChecksListForRefResponseCheckRunsItemAppPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ChecksListForRefResponseCheckRunsItemAppOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ChecksListForRefResponseCheckRunsItemApp = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ChecksListForRefResponseCheckRunsItemAppOwner; - permissions: ChecksListForRefResponseCheckRunsItemAppPermissions; - slug: string; - updated_at: string; - }; - type ChecksListForRefResponseCheckRunsItem = { - app: ChecksListForRefResponseCheckRunsItemApp; - check_suite: ChecksListForRefResponseCheckRunsItemCheckSuite; - completed_at: string; - conclusion: string; - details_url: string; - external_id: string; - head_sha: string; - html_url: string; - id: number; - name: string; - node_id: string; - output: ChecksListForRefResponseCheckRunsItemOutput; - pull_requests: Array; - started_at: string; - status: string; - url: string; - }; - type ChecksListForRefResponse = { - check_runs: Array; - total_count: number; - }; - type ChecksListAnnotationsResponseItem = { - annotation_level: string; - end_column: number; - end_line: number; - message: string; - path: string; - raw_details: string; - start_column: number; - start_line: number; - title: string; - }; - type ChecksGetSuiteResponseRepositoryPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ChecksGetSuiteResponseRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ChecksGetSuiteResponseRepository = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ChecksGetSuiteResponseRepositoryOwner; - permissions: ChecksGetSuiteResponseRepositoryPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ChecksGetSuiteResponseAppPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ChecksGetSuiteResponseAppOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ChecksGetSuiteResponseApp = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ChecksGetSuiteResponseAppOwner; - permissions: ChecksGetSuiteResponseAppPermissions; - slug: string; - updated_at: string; - }; - type ChecksGetSuiteResponse = { - after: string; - app: ChecksGetSuiteResponseApp; - before: string; - conclusion: string; - head_branch: string; - head_sha: string; - id: number; - node_id: string; - pull_requests: Array; - repository: ChecksGetSuiteResponseRepository; - status: string; - url: string; - }; - type ChecksGetResponsePullRequestsItemHeadRepo = { - id: number; - name: string; - url: string; - }; - type ChecksGetResponsePullRequestsItemHead = { - ref: string; - repo: ChecksGetResponsePullRequestsItemHeadRepo; - sha: string; - }; - type ChecksGetResponsePullRequestsItemBaseRepo = { - id: number; - name: string; - url: string; - }; - type ChecksGetResponsePullRequestsItemBase = { - ref: string; - repo: ChecksGetResponsePullRequestsItemBaseRepo; - sha: string; - }; - type ChecksGetResponsePullRequestsItem = { - base: ChecksGetResponsePullRequestsItemBase; - head: ChecksGetResponsePullRequestsItemHead; - id: number; - number: number; - url: string; - }; - type ChecksGetResponseOutput = { - annotations_count: number; - annotations_url: string; - summary: string; - text: string; - title: string; - }; - type ChecksGetResponseCheckSuite = { id: number }; - type ChecksGetResponseAppPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ChecksGetResponseAppOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ChecksGetResponseApp = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ChecksGetResponseAppOwner; - permissions: ChecksGetResponseAppPermissions; - slug: string; - updated_at: string; - }; - type ChecksGetResponse = { - app: ChecksGetResponseApp; - check_suite: ChecksGetResponseCheckSuite; - completed_at: string; - conclusion: string; - details_url: string; - external_id: string; - head_sha: string; - html_url: string; - id: number; - name: string; - node_id: string; - output: ChecksGetResponseOutput; - pull_requests: Array; - started_at: string; - status: string; - url: string; - }; - type ChecksCreateSuiteResponseRepositoryPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ChecksCreateSuiteResponseRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ChecksCreateSuiteResponseRepository = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ChecksCreateSuiteResponseRepositoryOwner; - permissions: ChecksCreateSuiteResponseRepositoryPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ChecksCreateSuiteResponseAppPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ChecksCreateSuiteResponseAppOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ChecksCreateSuiteResponseApp = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ChecksCreateSuiteResponseAppOwner; - permissions: ChecksCreateSuiteResponseAppPermissions; - slug: string; - updated_at: string; - }; - type ChecksCreateSuiteResponse = { - after: string; - app: ChecksCreateSuiteResponseApp; - before: string; - conclusion: string; - head_branch: string; - head_sha: string; - id: number; - node_id: string; - pull_requests: Array; - repository: ChecksCreateSuiteResponseRepository; - status: string; - url: string; - }; - type ChecksCreateResponsePullRequestsItemHeadRepo = { - id: number; - name: string; - url: string; - }; - type ChecksCreateResponsePullRequestsItemHead = { - ref: string; - repo: ChecksCreateResponsePullRequestsItemHeadRepo; - sha: string; - }; - type ChecksCreateResponsePullRequestsItemBaseRepo = { - id: number; - name: string; - url: string; - }; - type ChecksCreateResponsePullRequestsItemBase = { - ref: string; - repo: ChecksCreateResponsePullRequestsItemBaseRepo; - sha: string; - }; - type ChecksCreateResponsePullRequestsItem = { - base: ChecksCreateResponsePullRequestsItemBase; - head: ChecksCreateResponsePullRequestsItemHead; - id: number; - number: number; - url: string; - }; - type ChecksCreateResponseOutput = { - summary: string; - text: string; - title: string; - annotations_count?: number; - annotations_url?: string; - }; - type ChecksCreateResponseCheckSuite = { id: number }; - type ChecksCreateResponseAppPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type ChecksCreateResponseAppOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type ChecksCreateResponseApp = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ChecksCreateResponseAppOwner; - permissions: ChecksCreateResponseAppPermissions; - slug: string; - updated_at: string; - }; - type ChecksCreateResponse = { - app: ChecksCreateResponseApp; - check_suite: ChecksCreateResponseCheckSuite; - completed_at: null | string; - conclusion: null | string; - details_url: string; - external_id: string; - head_sha: string; - html_url: string; - id: number; - name: string; - node_id: string; - output: ChecksCreateResponseOutput; - pull_requests: Array; - started_at: string; - status: string; - url: string; - }; - type AppsResetTokenResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsResetTokenResponseApp = { - client_id: string; - name: string; - url: string; - }; - type AppsResetTokenResponse = { - app: AppsResetTokenResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - user: AppsResetTokenResponseUser; - }; - type AppsResetAuthorizationResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsResetAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; - }; - type AppsResetAuthorizationResponse = { - app: AppsResetAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - user: AppsResetAuthorizationResponseUser; - }; - type AppsListReposResponseRepositoriesItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsListReposResponseRepositoriesItem = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: AppsListReposResponseRepositoriesItemOwner; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type AppsListReposResponse = { - repositories: Array; - total_count: number; - }; - type AppsListPlansStubbedResponseItem = { - accounts_url: string; - bullets: Array; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - number: number; - price_model: string; - state: string; - unit_name: null; - url: string; - yearly_price_in_cents: number; - }; - type AppsListPlansResponseItem = { - accounts_url: string; - bullets: Array; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - number: number; - price_model: string; - state: string; - unit_name: null; - url: string; - yearly_price_in_cents: number; - }; - type AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemPlan = { - accounts_url: string; - bullets: Array; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - number: number; - price_model: string; - state: string; - unit_name: null; - url: string; - yearly_price_in_cents: number; - }; - type AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemAccount = { - email: null; - id: number; - login: string; - organization_billing_email: string; - type: string; - url: string; - }; - type AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItem = { - account: AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemAccount; - billing_cycle: string; - free_trial_ends_on: string; - next_billing_date: string; - on_free_trial: boolean; - plan: AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItemPlan; - unit_count: null; - updated_at: string; - }; - type AppsListMarketplacePurchasesForAuthenticatedUserResponseItemPlan = { - accounts_url: string; - bullets: Array; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - number: number; - price_model: string; - state: string; - unit_name: null; - url: string; - yearly_price_in_cents: number; - }; - type AppsListMarketplacePurchasesForAuthenticatedUserResponseItemAccount = { - email: null; - id: number; - login: string; - organization_billing_email: string; - type: string; - url: string; - }; - type AppsListMarketplacePurchasesForAuthenticatedUserResponseItem = { - account: AppsListMarketplacePurchasesForAuthenticatedUserResponseItemAccount; - billing_cycle: string; - free_trial_ends_on: string; - next_billing_date: string; - on_free_trial: boolean; - plan: AppsListMarketplacePurchasesForAuthenticatedUserResponseItemPlan; - unit_count: null; - updated_at: string; - }; - type AppsListInstallationsForAuthenticatedUserResponseInstallationsItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type AppsListInstallationsForAuthenticatedUserResponseInstallationsItemAccount = { - avatar_url: string; - description?: string; - events_url: string; - hooks_url?: string; - id: number; - issues_url?: string; - login: string; - members_url?: string; - node_id: string; - public_members_url?: string; - repos_url: string; - url: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - organizations_url?: string; - received_events_url?: string; - site_admin?: boolean; - starred_url?: string; - subscriptions_url?: string; - type?: string; - }; - type AppsListInstallationsForAuthenticatedUserResponseInstallationsItem = { - access_tokens_url: string; - account: AppsListInstallationsForAuthenticatedUserResponseInstallationsItemAccount; - app_id: number; - events: Array; - html_url: string; - id: number; - permissions: AppsListInstallationsForAuthenticatedUserResponseInstallationsItemPermissions; - repositories_url: string; - single_file_name: string; - target_id: number; - target_type: string; - }; - type AppsListInstallationsForAuthenticatedUserResponse = { - installations: Array< - AppsListInstallationsForAuthenticatedUserResponseInstallationsItem - >; - total_count: number; - }; - type AppsListInstallationsResponseItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type AppsListInstallationsResponseItemAccount = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type AppsListInstallationsResponseItem = { - access_tokens_url: string; - account: AppsListInstallationsResponseItemAccount; - app_id: number; - events: Array; - html_url: string; - id: number; - permissions: AppsListInstallationsResponseItemPermissions; - repositories_url: string; - repository_selection: string; - single_file_name: string; - target_id: number; - target_type: string; - }; - type AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItem = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemOwner; - permissions: AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type AppsListInstallationReposForAuthenticatedUserResponse = { - repositories: Array< - AppsListInstallationReposForAuthenticatedUserResponseRepositoriesItem - >; - total_count: number; - }; - type AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchasePlan = { - accounts_url: string; - bullets: Array; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - number: number; - price_model: string; - state: string; - unit_name: null; - url: string; - yearly_price_in_cents: number; - }; - type AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchase = { - billing_cycle: string; - free_trial_ends_on: string; - next_billing_date: string; - on_free_trial: boolean; - plan: AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchasePlan; - unit_count: null; - updated_at: string; - }; - type AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChangePlan = { - accounts_url: string; - bullets: Array; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - number: number; - price_model: string; - state: string; - unit_name: null; - url: string; - yearly_price_in_cents: number; - }; - type AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChange = { - effective_date: string; - id: number; - plan: AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChangePlan; - unit_count: null; - }; - type AppsListAccountsUserOrOrgOnPlanStubbedResponseItem = { - email: null; - id: number; - login: string; - marketplace_pending_change: AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePendingChange; - marketplace_purchase: AppsListAccountsUserOrOrgOnPlanStubbedResponseItemMarketplacePurchase; - organization_billing_email: string; - type: string; - url: string; - }; - type AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchasePlan = { - accounts_url: string; - bullets: Array; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - number: number; - price_model: string; - state: string; - unit_name: null; - url: string; - yearly_price_in_cents: number; - }; - type AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchase = { - billing_cycle: string; - free_trial_ends_on: string; - next_billing_date: string; - on_free_trial: boolean; - plan: AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchasePlan; - unit_count: null; - updated_at: string; - }; - type AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChangePlan = { - accounts_url: string; - bullets: Array; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - number: number; - price_model: string; - state: string; - unit_name: null; - url: string; - yearly_price_in_cents: number; - }; - type AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChange = { - effective_date: string; - id: number; - plan: AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChangePlan; - unit_count: null; - }; - type AppsListAccountsUserOrOrgOnPlanResponseItem = { - email: null; - id: number; - login: string; - marketplace_pending_change: AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePendingChange; - marketplace_purchase: AppsListAccountsUserOrOrgOnPlanResponseItemMarketplacePurchase; - organization_billing_email: string; - type: string; - url: string; - }; - type AppsGetUserInstallationResponsePermissions = { - checks: string; - contents: string; - metadata: string; - }; - type AppsGetUserInstallationResponseAccount = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsGetUserInstallationResponse = { - access_tokens_url: string; - account: AppsGetUserInstallationResponseAccount; - app_id: number; - created_at: string; - events: Array; - html_url: string; - id: number; - permissions: AppsGetUserInstallationResponsePermissions; - repositories_url: string; - repository_selection: string; - single_file_name: null; - target_id: number; - target_type: string; - updated_at: string; - }; - type AppsGetRepoInstallationResponsePermissions = { - checks: string; - contents: string; - metadata: string; - }; - type AppsGetRepoInstallationResponseAccount = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsGetRepoInstallationResponse = { - access_tokens_url: string; - account: AppsGetRepoInstallationResponseAccount; - app_id: number; - created_at: string; - events: Array; - html_url: string; - id: number; - permissions: AppsGetRepoInstallationResponsePermissions; - repositories_url: string; - repository_selection: string; - single_file_name: null; - target_id: number; - target_type: string; - updated_at: string; - }; - type AppsGetOrgInstallationResponsePermissions = { - checks: string; - contents: string; - metadata: string; - }; - type AppsGetOrgInstallationResponseAccount = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsGetOrgInstallationResponse = { - access_tokens_url: string; - account: AppsGetOrgInstallationResponseAccount; - app_id: number; - created_at: string; - events: Array; - html_url: string; - id: number; - permissions: AppsGetOrgInstallationResponsePermissions; - repositories_url: string; - repository_selection: string; - single_file_name: null; - target_id: number; - target_type: string; - updated_at: string; - }; - type AppsGetInstallationResponsePermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type AppsGetInstallationResponseAccount = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type AppsGetInstallationResponse = { - access_tokens_url: string; - account: AppsGetInstallationResponseAccount; - app_id: number; - events: Array; - html_url: string; - id: number; - permissions: AppsGetInstallationResponsePermissions; - repositories_url: string; - repository_selection: string; - single_file_name: string; - target_id: number; - target_type: string; - }; - type AppsGetBySlugResponsePermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type AppsGetBySlugResponseOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type AppsGetBySlugResponse = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: AppsGetBySlugResponseOwner; - permissions: AppsGetBySlugResponsePermissions; - slug: string; - updated_at: string; - }; - type AppsGetAuthenticatedResponsePermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; - }; - type AppsGetAuthenticatedResponseOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; - }; - type AppsGetAuthenticatedResponse = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - installations_count: number; - name: string; - node_id: string; - owner: AppsGetAuthenticatedResponseOwner; - permissions: AppsGetAuthenticatedResponsePermissions; - slug: string; - updated_at: string; - }; - type AppsFindUserInstallationResponsePermissions = { - checks: string; - contents: string; - metadata: string; - }; - type AppsFindUserInstallationResponseAccount = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsFindUserInstallationResponse = { - access_tokens_url: string; - account: AppsFindUserInstallationResponseAccount; - app_id: number; - created_at: string; - events: Array; - html_url: string; - id: number; - permissions: AppsFindUserInstallationResponsePermissions; - repositories_url: string; - repository_selection: string; - single_file_name: null; - target_id: number; - target_type: string; - updated_at: string; - }; - type AppsFindRepoInstallationResponsePermissions = { - checks: string; - contents: string; - metadata: string; - }; - type AppsFindRepoInstallationResponseAccount = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsFindRepoInstallationResponse = { - access_tokens_url: string; - account: AppsFindRepoInstallationResponseAccount; - app_id: number; - created_at: string; - events: Array; - html_url: string; - id: number; - permissions: AppsFindRepoInstallationResponsePermissions; - repositories_url: string; - repository_selection: string; - single_file_name: null; - target_id: number; - target_type: string; - updated_at: string; - }; - type AppsFindOrgInstallationResponsePermissions = { - checks: string; - contents: string; - metadata: string; - }; - type AppsFindOrgInstallationResponseAccount = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsFindOrgInstallationResponse = { - access_tokens_url: string; - account: AppsFindOrgInstallationResponseAccount; - app_id: number; - created_at: string; - events: Array; - html_url: string; - id: number; - permissions: AppsFindOrgInstallationResponsePermissions; - repositories_url: string; - repository_selection: string; - single_file_name: null; - target_id: number; - target_type: string; - updated_at: string; - }; - type AppsCreateInstallationTokenResponseRepositoriesItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type AppsCreateInstallationTokenResponseRepositoriesItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsCreateInstallationTokenResponseRepositoriesItem = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: AppsCreateInstallationTokenResponseRepositoriesItemOwner; - permissions: AppsCreateInstallationTokenResponseRepositoriesItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type AppsCreateInstallationTokenResponsePermissions = { - contents: string; - issues: string; - }; - type AppsCreateInstallationTokenResponse = { - expires_at: string; - permissions: AppsCreateInstallationTokenResponsePermissions; - repositories: Array; - token: string; - }; - type AppsCreateFromManifestResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsCreateFromManifestResponse = { - client_id: string; - client_secret: string; - created_at: string; - description: null; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: AppsCreateFromManifestResponseOwner; - pem: string; - updated_at: string; - webhook_secret: string; - }; - type AppsCreateContentAttachmentResponse = { - body: string; - id: number; - title: string; - }; - type AppsCheckTokenResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsCheckTokenResponseApp = { - client_id: string; - name: string; - url: string; - }; - type AppsCheckTokenResponse = { - app: AppsCheckTokenResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - user: AppsCheckTokenResponseUser; - }; - type AppsCheckAuthorizationResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type AppsCheckAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; - }; - type AppsCheckAuthorizationResponse = { - app: AppsCheckAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - user: AppsCheckAuthorizationResponseUser; - }; - type AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchasePlan = { - accounts_url: string; - bullets: Array; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - number: number; - price_model: string; - state: string; - unit_name: null; - url: string; - yearly_price_in_cents: number; - }; - type AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchase = { - billing_cycle: string; - free_trial_ends_on: string; - next_billing_date: string; - on_free_trial: boolean; - plan: AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchasePlan; - unit_count: null; - updated_at: string; - }; - type AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChangePlan = { - accounts_url: string; - bullets: Array; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - number: number; - price_model: string; - state: string; - unit_name: null; - url: string; - yearly_price_in_cents: number; - }; - type AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChange = { - effective_date: string; - id: number; - plan: AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChangePlan; - unit_count: null; - }; - type AppsCheckAccountIsAssociatedWithAnyStubbedResponse = { - email: null; - id: number; - login: string; - marketplace_pending_change: AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePendingChange; - marketplace_purchase: AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchase; - organization_billing_email: string; - type: string; - url: string; - }; - type AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchasePlan = { - accounts_url: string; - bullets: Array; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - number: number; - price_model: string; - state: string; - unit_name: null; - url: string; - yearly_price_in_cents: number; - }; - type AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchase = { - billing_cycle: string; - free_trial_ends_on: string; - next_billing_date: string; - on_free_trial: boolean; - plan: AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchasePlan; - unit_count: null; - updated_at: string; - }; - type AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChangePlan = { - accounts_url: string; - bullets: Array; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - number: number; - price_model: string; - state: string; - unit_name: null; - url: string; - yearly_price_in_cents: number; - }; - type AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChange = { - effective_date: string; - id: number; - plan: AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChangePlan; - unit_count: null; - }; - type AppsCheckAccountIsAssociatedWithAnyResponse = { - email: null; - id: number; - login: string; - marketplace_pending_change: AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePendingChange; - marketplace_purchase: AppsCheckAccountIsAssociatedWithAnyResponseMarketplacePurchase; - organization_billing_email: string; - type: string; - url: string; - }; - type ActivitySetThreadSubscriptionResponse = { - created_at: string; - ignored: boolean; - reason: null; - subscribed: boolean; - thread_url: string; - url: string; - }; - type ActivitySetRepoSubscriptionResponse = { - created_at: string; - ignored: boolean; - reason: null; - repository_url: string; - subscribed: boolean; - url: string; - }; - type ActivityListWatchersForRepoResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ActivityListWatchedReposForAuthenticatedUserResponseItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ActivityListWatchedReposForAuthenticatedUserResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ActivityListWatchedReposForAuthenticatedUserResponseItemLicense = { - key: string; - name: string; - node_id: string; - spdx_id: string; - url: string; - }; - type ActivityListWatchedReposForAuthenticatedUserResponseItem = { - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - license: ActivityListWatchedReposForAuthenticatedUserResponseItemLicense; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ActivityListWatchedReposForAuthenticatedUserResponseItemOwner; - permissions: ActivityListWatchedReposForAuthenticatedUserResponseItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ActivityListStargazersForRepoResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ActivityListReposWatchedByUserResponseItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ActivityListReposWatchedByUserResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ActivityListReposWatchedByUserResponseItemLicense = { - key: string; - name: string; - node_id: string; - spdx_id: string; - url: string; - }; - type ActivityListReposWatchedByUserResponseItem = { - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - license: ActivityListReposWatchedByUserResponseItemLicense; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ActivityListReposWatchedByUserResponseItemOwner; - permissions: ActivityListReposWatchedByUserResponseItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ActivityListReposStarredByUserResponseItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ActivityListReposStarredByUserResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ActivityListReposStarredByUserResponseItem = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ActivityListReposStarredByUserResponseItemOwner; - permissions: ActivityListReposStarredByUserResponseItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ActivityListReposStarredByAuthenticatedUserResponseItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; - }; - type ActivityListReposStarredByAuthenticatedUserResponseItemOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ActivityListReposStarredByAuthenticatedUserResponseItem = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ActivityListReposStarredByAuthenticatedUserResponseItemOwner; - permissions: ActivityListReposStarredByAuthenticatedUserResponseItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - watchers_count: number; - }; - type ActivityListNotificationsForRepoResponseItemSubject = { - latest_comment_url: string; - title: string; - type: string; - url: string; - }; - type ActivityListNotificationsForRepoResponseItemRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ActivityListNotificationsForRepoResponseItemRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: ActivityListNotificationsForRepoResponseItemRepositoryOwner; - private: boolean; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; - }; - type ActivityListNotificationsForRepoResponseItem = { - id: string; - last_read_at: string; - reason: string; - repository: ActivityListNotificationsForRepoResponseItemRepository; - subject: ActivityListNotificationsForRepoResponseItemSubject; - unread: boolean; - updated_at: string; - url: string; - }; - type ActivityListNotificationsResponseItemSubject = { - latest_comment_url: string; - title: string; - type: string; - url: string; - }; - type ActivityListNotificationsResponseItemRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ActivityListNotificationsResponseItemRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: ActivityListNotificationsResponseItemRepositoryOwner; - private: boolean; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; - }; - type ActivityListNotificationsResponseItem = { - id: string; - last_read_at: string; - reason: string; - repository: ActivityListNotificationsResponseItemRepository; - subject: ActivityListNotificationsResponseItemSubject; - unread: boolean; - updated_at: string; - url: string; - }; - type ActivityListFeedsResponseLinksUser = { href: string; type: string }; - type ActivityListFeedsResponseLinksTimeline = { href: string; type: string }; - type ActivityListFeedsResponseLinksSecurityAdvisories = { - href: string; - type: string; - }; - type ActivityListFeedsResponseLinksCurrentUserPublic = { - href: string; - type: string; - }; - type ActivityListFeedsResponseLinksCurrentUserOrganizationsItem = { - href: string; - type: string; - }; - type ActivityListFeedsResponseLinksCurrentUserOrganization = { - href: string; - type: string; - }; - type ActivityListFeedsResponseLinksCurrentUserActor = { - href: string; - type: string; - }; - type ActivityListFeedsResponseLinksCurrentUser = { - href: string; - type: string; - }; - type ActivityListFeedsResponseLinks = { - current_user: ActivityListFeedsResponseLinksCurrentUser; - current_user_actor: ActivityListFeedsResponseLinksCurrentUserActor; - current_user_organization: ActivityListFeedsResponseLinksCurrentUserOrganization; - current_user_organizations: Array< - ActivityListFeedsResponseLinksCurrentUserOrganizationsItem - >; - current_user_public: ActivityListFeedsResponseLinksCurrentUserPublic; - security_advisories: ActivityListFeedsResponseLinksSecurityAdvisories; - timeline: ActivityListFeedsResponseLinksTimeline; - user: ActivityListFeedsResponseLinksUser; - }; - type ActivityListFeedsResponse = { - _links: ActivityListFeedsResponseLinks; - current_user_actor_url: string; - current_user_organization_url: string; - current_user_organization_urls: Array; - current_user_public_url: string; - current_user_url: string; - security_advisories_url: string; - timeline_url: string; - user_url: string; - }; - type ActivityGetThreadSubscriptionResponse = { - created_at: string; - ignored: boolean; - reason: null; - subscribed: boolean; - thread_url: string; - url: string; - }; - type ActivityGetThreadResponseSubject = { - latest_comment_url: string; - title: string; - type: string; - url: string; - }; - type ActivityGetThreadResponseRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - }; - type ActivityGetThreadResponseRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: ActivityGetThreadResponseRepositoryOwner; - private: boolean; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; - }; - type ActivityGetThreadResponse = { - id: string; - last_read_at: string; - reason: string; - repository: ActivityGetThreadResponseRepository; - subject: ActivityGetThreadResponseSubject; - unread: boolean; - updated_at: string; - url: string; - }; - type ActivityGetRepoSubscriptionResponse = { - created_at: string; - ignored: boolean; - reason: null; - repository_url: string; - subscribed: boolean; - url: string; - }; - type ActivityListNotificationsResponse = Array< - ActivityListNotificationsResponseItem - >; - type ActivityListNotificationsForRepoResponse = Array< - ActivityListNotificationsForRepoResponseItem - >; - type ActivityListReposStarredByAuthenticatedUserResponse = Array< - ActivityListReposStarredByAuthenticatedUserResponseItem - >; - type ActivityListReposStarredByUserResponse = Array< - ActivityListReposStarredByUserResponseItem - >; - type ActivityListReposWatchedByUserResponse = Array< - ActivityListReposWatchedByUserResponseItem - >; - type ActivityListStargazersForRepoResponse = Array< - ActivityListStargazersForRepoResponseItem - >; - type ActivityListWatchedReposForAuthenticatedUserResponse = Array< - ActivityListWatchedReposForAuthenticatedUserResponseItem - >; - type ActivityListWatchersForRepoResponse = Array< - ActivityListWatchersForRepoResponseItem - >; - type AppsListAccountsUserOrOrgOnPlanResponse = Array< - AppsListAccountsUserOrOrgOnPlanResponseItem - >; - type AppsListAccountsUserOrOrgOnPlanStubbedResponse = Array< - AppsListAccountsUserOrOrgOnPlanStubbedResponseItem - >; - type AppsListInstallationsResponse = Array; - type AppsListMarketplacePurchasesForAuthenticatedUserResponse = Array< - AppsListMarketplacePurchasesForAuthenticatedUserResponseItem - >; - type AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponse = Array< - AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponseItem - >; - type AppsListPlansResponse = Array; - type AppsListPlansStubbedResponse = Array; - type ChecksListAnnotationsResponse = Array; - type CodesOfConductListConductCodesResponse = Array< - CodesOfConductListConductCodesResponseItem - >; - type GistsListResponse = Array; - type GistsListCommentsResponse = Array; - type GistsListCommitsResponse = Array; - type GistsListForksResponse = Array; - type GistsListPublicResponse = Array; - type GistsListPublicForUserResponse = Array< - GistsListPublicForUserResponseItem - >; - type GistsListStarredResponse = Array; - type GitListMatchingRefsResponse = Array; - type GitignoreListTemplatesResponse = Array; - type IssuesAddLabelsResponse = Array; - type IssuesListResponse = Array; - type IssuesListAssigneesResponse = Array; - type IssuesListCommentsResponse = Array; - type IssuesListCommentsForRepoResponse = Array< - IssuesListCommentsForRepoResponseItem - >; - type IssuesListEventsResponse = Array; - type IssuesListEventsForRepoResponse = Array< - IssuesListEventsForRepoResponseItem - >; - type IssuesListEventsForTimelineResponse = Array< - IssuesListEventsForTimelineResponseItem - >; - type IssuesListForAuthenticatedUserResponse = Array< - IssuesListForAuthenticatedUserResponseItem - >; - type IssuesListForOrgResponse = Array; - type IssuesListForRepoResponse = Array; - type IssuesListLabelsForMilestoneResponse = Array< - IssuesListLabelsForMilestoneResponseItem - >; - type IssuesListLabelsForRepoResponse = Array< - IssuesListLabelsForRepoResponseItem - >; - type IssuesListLabelsOnIssueResponse = Array< - IssuesListLabelsOnIssueResponseItem - >; - type IssuesListMilestonesForRepoResponse = Array< - IssuesListMilestonesForRepoResponseItem - >; - type IssuesRemoveLabelResponse = Array; - type IssuesReplaceLabelsResponse = Array; - type LicensesListResponse = Array; - type LicensesListCommonlyUsedResponse = Array< - LicensesListCommonlyUsedResponseItem - >; - type MigrationsGetCommitAuthorsResponse = Array< - MigrationsGetCommitAuthorsResponseItem - >; - type MigrationsGetLargeFilesResponse = Array< - MigrationsGetLargeFilesResponseItem - >; - type MigrationsListForAuthenticatedUserResponse = Array< - MigrationsListForAuthenticatedUserResponseItem - >; - type MigrationsListForOrgResponse = Array; - type OauthAuthorizationsListAuthorizationsResponse = Array< - OauthAuthorizationsListAuthorizationsResponseItem - >; - type OauthAuthorizationsListGrantsResponse = Array< - OauthAuthorizationsListGrantsResponseItem - >; - type OrgsListResponse = Array; - type OrgsListBlockedUsersResponse = Array; - type OrgsListForAuthenticatedUserResponse = Array< - OrgsListForAuthenticatedUserResponseItem - >; - type OrgsListForUserResponse = Array; - type OrgsListHooksResponse = Array; - type OrgsListInvitationTeamsResponse = Array< - OrgsListInvitationTeamsResponseItem - >; - type OrgsListMembersResponse = Array; - type OrgsListMembershipsResponse = Array; - type OrgsListOutsideCollaboratorsResponse = Array< - OrgsListOutsideCollaboratorsResponseItem - >; - type OrgsListPendingInvitationsResponse = Array< - OrgsListPendingInvitationsResponseItem - >; - type OrgsListPublicMembersResponse = Array; - type ProjectsListCardsResponse = Array; - type ProjectsListCollaboratorsResponse = Array< - ProjectsListCollaboratorsResponseItem - >; - type ProjectsListColumnsResponse = Array; - type ProjectsListForOrgResponse = Array; - type ProjectsListForRepoResponse = Array; - type ProjectsListForUserResponse = Array; - type PullsGetCommentsForReviewResponse = Array< - PullsGetCommentsForReviewResponseItem - >; - type PullsListResponse = Array; - type PullsListCommentsResponse = Array; - type PullsListCommentsForRepoResponse = Array< - PullsListCommentsForRepoResponseItem - >; - type PullsListCommitsResponse = Array; - type PullsListFilesResponse = Array; - type PullsListReviewsResponse = Array; - type ReactionsListForCommitCommentResponse = Array< - ReactionsListForCommitCommentResponseItem - >; - type ReactionsListForIssueResponse = Array; - type ReactionsListForIssueCommentResponse = Array< - ReactionsListForIssueCommentResponseItem - >; - type ReactionsListForPullRequestReviewCommentResponse = Array< - ReactionsListForPullRequestReviewCommentResponseItem - >; - type ReactionsListForTeamDiscussionResponse = Array< - ReactionsListForTeamDiscussionResponseItem - >; - type ReactionsListForTeamDiscussionCommentResponse = Array< - ReactionsListForTeamDiscussionCommentResponseItem - >; - type ReposAddProtectedBranchAppRestrictionsResponse = Array< - ReposAddProtectedBranchAppRestrictionsResponseItem - >; - type ReposAddProtectedBranchRequiredStatusChecksContextsResponse = Array< - string - >; - type ReposAddProtectedBranchTeamRestrictionsResponse = Array< - ReposAddProtectedBranchTeamRestrictionsResponseItem - >; - type ReposAddProtectedBranchUserRestrictionsResponse = Array< - ReposAddProtectedBranchUserRestrictionsResponseItem - >; - type ReposGetAppsWithAccessToProtectedBranchResponse = Array< - ReposGetAppsWithAccessToProtectedBranchResponseItem - >; - type ReposGetCodeFrequencyStatsResponse = Array>; - type ReposGetCommitActivityStatsResponse = Array< - ReposGetCommitActivityStatsResponseItem - >; - type ReposGetContributorsStatsResponse = Array< - ReposGetContributorsStatsResponseItem - >; - type ReposGetPunchCardStatsResponse = Array>; - type ReposGetTeamsWithAccessToProtectedBranchResponse = Array< - ReposGetTeamsWithAccessToProtectedBranchResponseItem - >; - type ReposGetTopPathsResponse = Array; - type ReposGetTopReferrersResponse = Array; - type ReposGetUsersWithAccessToProtectedBranchResponse = Array< - ReposGetUsersWithAccessToProtectedBranchResponseItem - >; - type ReposListAppsWithAccessToProtectedBranchResponse = Array< - ReposListAppsWithAccessToProtectedBranchResponseItem - >; - type ReposListAssetsForReleaseResponse = Array< - ReposListAssetsForReleaseResponseItem - >; - type ReposListBranchesResponse = Array; - type ReposListBranchesForHeadCommitResponse = Array< - ReposListBranchesForHeadCommitResponseItem - >; - type ReposListCollaboratorsResponse = Array< - ReposListCollaboratorsResponseItem - >; - type ReposListCommentsForCommitResponse = Array< - ReposListCommentsForCommitResponseItem - >; - type ReposListCommitCommentsResponse = Array< - ReposListCommitCommentsResponseItem - >; - type ReposListCommitsResponse = Array; - type ReposListContributorsResponse = Array; - type ReposListDeployKeysResponse = Array; - type ReposListDeploymentStatusesResponse = Array< - ReposListDeploymentStatusesResponseItem - >; - type ReposListDeploymentsResponse = Array; - type ReposListDownloadsResponse = Array; - type ReposListForOrgResponse = Array; - type ReposListForksResponse = Array; - type ReposListHooksResponse = Array; - type ReposListInvitationsResponse = Array; - type ReposListInvitationsForAuthenticatedUserResponse = Array< - ReposListInvitationsForAuthenticatedUserResponseItem - >; - type ReposListPagesBuildsResponse = Array; - type ReposListProtectedBranchRequiredStatusChecksContextsResponse = Array< - string - >; - type ReposListProtectedBranchTeamRestrictionsResponse = Array< - ReposListProtectedBranchTeamRestrictionsResponseItem - >; - type ReposListProtectedBranchUserRestrictionsResponse = Array< - ReposListProtectedBranchUserRestrictionsResponseItem - >; - type ReposListPublicResponse = Array; - type ReposListPullRequestsAssociatedWithCommitResponse = Array< - ReposListPullRequestsAssociatedWithCommitResponseItem - >; - type ReposListReleasesResponse = Array; - type ReposListStatusesForRefResponse = Array< - ReposListStatusesForRefResponseItem - >; - type ReposListTagsResponse = Array; - type ReposListTeamsResponse = Array; - type ReposListTeamsWithAccessToProtectedBranchResponse = Array< - ReposListTeamsWithAccessToProtectedBranchResponseItem - >; - type ReposListUsersWithAccessToProtectedBranchResponse = Array< - ReposListUsersWithAccessToProtectedBranchResponseItem - >; - type ReposRemoveProtectedBranchAppRestrictionsResponse = Array< - ReposRemoveProtectedBranchAppRestrictionsResponseItem - >; - type ReposRemoveProtectedBranchRequiredStatusChecksContextsResponse = Array< - string - >; - type ReposRemoveProtectedBranchTeamRestrictionsResponse = Array< - ReposRemoveProtectedBranchTeamRestrictionsResponseItem - >; - type ReposRemoveProtectedBranchUserRestrictionsResponse = Array< - ReposRemoveProtectedBranchUserRestrictionsResponseItem - >; - type ReposReplaceProtectedBranchAppRestrictionsResponse = Array< - ReposReplaceProtectedBranchAppRestrictionsResponseItem - >; - type ReposReplaceProtectedBranchRequiredStatusChecksContextsResponse = Array< - string - >; - type ReposReplaceProtectedBranchTeamRestrictionsResponse = Array< - ReposReplaceProtectedBranchTeamRestrictionsResponseItem - >; - type ReposReplaceProtectedBranchUserRestrictionsResponse = Array< - ReposReplaceProtectedBranchUserRestrictionsResponseItem - >; - type TeamsListResponse = Array; - type TeamsListChildResponse = Array; - type TeamsListDiscussionCommentsResponse = Array< - TeamsListDiscussionCommentsResponseItem - >; - type TeamsListDiscussionsResponse = Array; - type TeamsListForAuthenticatedUserResponse = Array< - TeamsListForAuthenticatedUserResponseItem - >; - type TeamsListMembersResponse = Array; - type TeamsListPendingInvitationsResponse = Array< - TeamsListPendingInvitationsResponseItem - >; - type TeamsListProjectsResponse = Array; - type TeamsListReposResponse = Array; - type UsersAddEmailsResponse = Array; - type UsersListResponse = Array; - type UsersListBlockedResponse = Array; - type UsersListEmailsResponse = Array; - type UsersListFollowersForAuthenticatedUserResponse = Array< - UsersListFollowersForAuthenticatedUserResponseItem - >; - type UsersListFollowersForUserResponse = Array< - UsersListFollowersForUserResponseItem - >; - type UsersListFollowingForAuthenticatedUserResponse = Array< - UsersListFollowingForAuthenticatedUserResponseItem - >; - type UsersListFollowingForUserResponse = Array< - UsersListFollowingForUserResponseItem - >; - type UsersListGpgKeysResponse = Array; - type UsersListGpgKeysForUserResponse = Array< - UsersListGpgKeysForUserResponseItem - >; - type UsersListPublicEmailsResponse = Array; - type UsersListPublicKeysResponse = Array; - type UsersListPublicKeysForUserResponse = Array< - UsersListPublicKeysForUserResponseItem - >; - type UsersTogglePrimaryEmailVisibilityResponse = Array< - UsersTogglePrimaryEmailVisibilityResponseItem - >; - - // param types - export type ActivityCheckStarringRepoParams = { - owner: string; - - repo: string; - }; - export type ActivityDeleteRepoSubscriptionParams = { - owner: string; - - repo: string; - }; - export type ActivityDeleteThreadSubscriptionParams = { - thread_id: number; - }; - export type ActivityGetRepoSubscriptionParams = { - owner: string; - - repo: string; - }; - export type ActivityGetThreadParams = { - thread_id: number; - }; - export type ActivityGetThreadSubscriptionParams = { - thread_id: number; - }; - export type ActivityListEventsForOrgParams = { - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - username: string; - }; - export type ActivityListEventsForUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - username: string; - }; - export type ActivityListNotificationsParams = { - /** - * If `true`, show notifications marked as read. - */ - all?: boolean; - /** - * 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`. - */ - before?: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * If `true`, only shows notifications in which the user is directly participating or mentioned. - */ - participating?: boolean; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * 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`. - */ - since?: string; - }; - export type ActivityListNotificationsForRepoParams = { - /** - * If `true`, show notifications marked as read. - */ - all?: boolean; - /** - * 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`. - */ - before?: string; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * If `true`, only shows notifications in which the user is directly participating or mentioned. - */ - participating?: boolean; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - /** - * 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`. - */ - since?: string; - }; - export type ActivityListPublicEventsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type ActivityListPublicEventsForOrgParams = { - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type ActivityListPublicEventsForRepoNetworkParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ActivityListPublicEventsForUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - username: string; - }; - export type ActivityListReceivedEventsForUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - username: string; - }; - export type ActivityListReceivedPublicEventsForUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - username: string; - }; - export type ActivityListRepoEventsParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ActivityListReposStarredByAuthenticatedUserParams = { - /** - * One of `asc` (ascending) or `desc` (descending). - */ - direction?: "asc" | "desc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). - */ - sort?: "created" | "updated"; - }; - export type ActivityListReposStarredByUserParams = { - /** - * One of `asc` (ascending) or `desc` (descending). - */ - direction?: "asc" | "desc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). - */ - sort?: "created" | "updated"; - - username: string; - }; - export type ActivityListReposWatchedByUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - username: string; - }; - export type ActivityListStargazersForRepoParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ActivityListWatchedReposForAuthenticatedUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type ActivityListWatchersForRepoParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ActivityMarkAsReadParams = { - /** - * Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. - */ - last_read_at?: string; - }; - export type ActivityMarkNotificationsAsReadForRepoParams = { - /** - * Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. - */ - last_read_at?: string; - - owner: string; - - repo: string; - }; - export type ActivityMarkThreadAsReadParams = { - thread_id: number; - }; - export type ActivitySetRepoSubscriptionParams = { - /** - * Determines if all notifications should be blocked from this repository. - */ - ignored?: boolean; - - owner: string; - - repo: string; - /** - * Determines if notifications should be received from this repository. - */ - subscribed?: boolean; - }; - export type ActivitySetThreadSubscriptionParams = { - /** - * Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread. - */ - ignored?: boolean; - - thread_id: number; - }; - export type ActivityStarRepoParams = { - owner: string; - - repo: string; - }; - export type ActivityUnstarRepoParams = { - owner: string; - - repo: string; - }; - export type AppsAddRepoToInstallationParams = { - installation_id: number; - - repository_id: number; - }; - export type AppsCheckAccountIsAssociatedWithAnyParams = { - account_id: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type AppsCheckAccountIsAssociatedWithAnyStubbedParams = { - account_id: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type AppsCheckAuthorizationParams = { - access_token: string; - - client_id: string; - }; - export type AppsCheckTokenParams = { - /** - * The OAuth access token used to authenticate to the GitHub API. - */ - access_token?: string; - - client_id: string; - }; - export type AppsCreateContentAttachmentParams = { - /** - * The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown. - */ - body: string; - - content_reference_id: number; - /** - * The title of the content attachment displayed in the body or comment of an issue or pull request. - */ - title: string; - }; - export type AppsCreateFromManifestParams = { - code: string; - }; - export type AppsCreateInstallationTokenParams = { - installation_id: number; - /** - * 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)." - */ - permissions?: AppsCreateInstallationTokenParamsPermissions; - /** - * 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. - */ - repository_ids?: number[]; - }; - export type AppsDeleteAuthorizationParams = { - /** - * The OAuth access token used to authenticate to the GitHub API. - */ - access_token?: string; - - client_id: string; - }; - export type AppsDeleteInstallationParams = { - installation_id: number; - }; - export type AppsDeleteTokenParams = { - /** - * The OAuth access token used to authenticate to the GitHub API. - */ - access_token?: string; - - client_id: string; - }; - export type AppsFindOrgInstallationParams = { - org: string; - }; - export type AppsFindRepoInstallationParams = { - owner: string; - - repo: string; - }; - export type AppsFindUserInstallationParams = { - username: string; - }; - export type AppsGetBySlugParams = { - app_slug: string; - }; - export type AppsGetInstallationParams = { - installation_id: number; - }; - export type AppsGetOrgInstallationParams = { - org: string; - }; - export type AppsGetRepoInstallationParams = { - owner: string; - - repo: string; - }; - export type AppsGetUserInstallationParams = { - username: string; - }; - export type AppsListAccountsUserOrOrgOnPlanParams = { - /** - * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. - */ - direction?: "asc" | "desc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - plan_id: number; - /** - * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. - */ - sort?: "created" | "updated"; - }; - export type AppsListAccountsUserOrOrgOnPlanStubbedParams = { - /** - * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. - */ - direction?: "asc" | "desc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - plan_id: number; - /** - * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. - */ - sort?: "created" | "updated"; - }; - export type AppsListInstallationReposForAuthenticatedUserParams = { - installation_id: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type AppsListInstallationsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type AppsListInstallationsForAuthenticatedUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type AppsListMarketplacePurchasesForAuthenticatedUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type AppsListMarketplacePurchasesForAuthenticatedUserStubbedParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type AppsListPlansParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type AppsListPlansStubbedParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type AppsListReposParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type AppsRemoveRepoFromInstallationParams = { - installation_id: number; - - repository_id: number; - }; - export type AppsResetAuthorizationParams = { - access_token: string; - - client_id: string; - }; - export type AppsResetTokenParams = { - /** - * The OAuth access token used to authenticate to the GitHub API. - */ - access_token?: string; - - client_id: string; - }; - export type AppsRevokeAuthorizationForApplicationParams = { - access_token: string; - - client_id: string; - }; - export type AppsRevokeGrantForApplicationParams = { - access_token: string; - - client_id: string; - }; - export type ChecksCreateParams = { - /** - * Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." - */ - actions?: ChecksCreateParamsActions[]; - /** - * 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`. - */ - completed_at?: string; - /** - * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. - */ - conclusion?: - | "success" - | "failure" - | "neutral" - | "cancelled" - | "timed_out" - | "action_required"; - /** - * The URL of the integrator's site that has the full details of the check. - */ - details_url?: string; - /** - * A reference for the run on the integrator's system. - */ - external_id?: string; - /** - * The SHA of the commit. - */ - head_sha: string; - /** - * The name of the check. For example, "code-coverage". - */ - name: string; - /** - * 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. - */ - output?: ChecksCreateParamsOutput; - - owner: string; - - repo: string; - /** - * 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`. - */ - started_at?: string; - /** - * The current status. Can be one of `queued`, `in_progress`, or `completed`. - */ - status?: "queued" | "in_progress" | "completed"; - }; - export type ChecksCreateSuiteParams = { - /** - * The sha of the head commit. - */ - head_sha: string; - - owner: string; - - repo: string; - }; - export type ChecksGetParams = { - check_run_id: number; - - owner: string; - - repo: string; - }; - export type ChecksGetSuiteParams = { - check_suite_id: number; - - owner: string; - - repo: string; - }; - export type ChecksListAnnotationsParams = { - check_run_id: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ChecksListForRefParams = { - /** - * Returns check runs with the specified `name`. - */ - check_name?: string; - /** - * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. - */ - filter?: "latest" | "all"; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - ref: string; - - repo: string; - /** - * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. - */ - status?: "queued" | "in_progress" | "completed"; - }; - export type ChecksListForSuiteParams = { - /** - * Returns check runs with the specified `name`. - */ - check_name?: string; - - check_suite_id: number; - /** - * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. - */ - filter?: "latest" | "all"; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - /** - * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. - */ - status?: "queued" | "in_progress" | "completed"; - }; - export type ChecksListSuitesForRefParams = { - /** - * Filters check suites by GitHub App `id`. - */ - app_id?: number; - /** - * Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/). - */ - check_name?: string; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - ref: string; - - repo: string; - }; - export type ChecksRerequestSuiteParams = { - check_suite_id: number; - - owner: string; - - repo: string; - }; - export type ChecksSetSuitesPreferencesParams = { - /** - * 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. - */ - auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]; - - owner: string; - - repo: string; - }; - export type ChecksUpdateParams = { - /** - * 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)." - */ - actions?: ChecksUpdateParamsActions[]; - - check_run_id: number; - /** - * 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`. - */ - completed_at?: string; - /** - * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. - */ - conclusion?: - | "success" - | "failure" - | "neutral" - | "cancelled" - | "timed_out" - | "action_required"; - /** - * The URL of the integrator's site that has the full details of the check. - */ - details_url?: string; - /** - * A reference for the run on the integrator's system. - */ - external_id?: string; - /** - * The name of the check. For example, "code-coverage". - */ - name?: string; - /** - * 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. - */ - output?: ChecksUpdateParamsOutput; - - owner: string; - - repo: string; - /** - * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - started_at?: string; - /** - * The current status. Can be one of `queued`, `in_progress`, or `completed`. - */ - status?: "queued" | "in_progress" | "completed"; - }; - export type CodesOfConductGetConductCodeParams = { - key: string; - }; - export type CodesOfConductGetForRepoParams = { - owner: string; - - repo: string; - }; - export type GistsCheckIsStarredParams = { - gist_id: string; - }; - export type GistsCreateParams = { - /** - * A descriptive name for this gist. - */ - description?: string; - /** - * The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`. - */ - files: GistsCreateParamsFiles; - /** - * When `true`, the gist will be public and available for anyone to see. - */ - public?: boolean; - }; - export type GistsCreateCommentParams = { - /** - * The comment text. - */ - body: string; - - gist_id: string; - }; - export type GistsDeleteParams = { - gist_id: string; - }; - export type GistsDeleteCommentParams = { - comment_id: number; - - gist_id: string; - }; - export type GistsForkParams = { - gist_id: string; - }; - export type GistsGetParams = { - gist_id: string; - }; - export type GistsGetCommentParams = { - comment_id: number; - - gist_id: string; - }; - export type GistsGetRevisionParams = { - gist_id: string; - - sha: string; - }; - export type GistsListParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * 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. - */ - since?: string; - }; - export type GistsListCommentsParams = { - gist_id: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type GistsListCommitsParams = { - gist_id: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type GistsListForksParams = { - gist_id: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type GistsListPublicParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * 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. - */ - since?: string; - }; - export type GistsListPublicForUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * 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. - */ - since?: string; - - username: string; - }; - export type GistsListStarredParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * 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. - */ - since?: string; - }; - export type GistsStarParams = { - gist_id: string; - }; - export type GistsUnstarParams = { - gist_id: string; - }; - export type GistsUpdateParams = { - /** - * A descriptive name for this gist. - */ - description?: string; - /** - * The filenames and content that make up this gist. - */ - files?: GistsUpdateParamsFiles; - - gist_id: string; - }; - export type GistsUpdateCommentParams = { - /** - * The comment text. - */ - body: string; - - comment_id: number; - - gist_id: string; - }; - export type GitCreateBlobParams = { - /** - * The new blob's content. - */ - content: string; - /** - * The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. - */ - encoding?: string; - - owner: string; - - repo: string; - }; - export type GitCreateCommitParams = { - /** - * 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. - */ - author?: GitCreateCommitParamsAuthor; - /** - * 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. - */ - committer?: GitCreateCommitParamsCommitter; - /** - * The commit message - */ - message: string; - - owner: string; - /** - * 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. - */ - parents: string[]; - - repo: string; - /** - * 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. - */ - signature?: string; - /** - * The SHA of the tree object this commit points to - */ - tree: string; - }; - export type GitCreateRefParams = { - owner: string; - /** - * 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. - */ - ref: string; - - repo: string; - /** - * The SHA1 value for this reference. - */ - sha: string; - }; - export type GitCreateTagParams = { - /** - * The tag message. - */ - message: string; - /** - * The SHA of the git object this is tagging. - */ - object: string; - - owner: string; - - repo: string; - /** - * The tag's name. This is typically a version (e.g., "v0.0.1"). - */ - tag: string; - /** - * An object with information about the individual creating the tag. - */ - tagger?: GitCreateTagParamsTagger; - /** - * The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. - */ - type: "commit" | "tree" | "blob"; - }; - export type GitCreateTreeParams = { - /** - * 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. - */ - base_tree?: string; - - owner: string; - - repo: string; - /** - * Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. - */ - tree: GitCreateTreeParamsTree[]; - }; - export type GitDeleteRefParams = { - owner: string; - - ref: string; - - repo: string; - }; - export type GitGetBlobParams = { - file_sha: string; - - owner: string; - - repo: string; - }; - export type GitGetCommitParams = { - commit_sha: string; - - owner: string; - - repo: string; - }; - export type GitGetRefParams = { - owner: string; - - ref: string; - - repo: string; - }; - export type GitGetTagParams = { - owner: string; - - repo: string; - - tag_sha: string; - }; - export type GitGetTreeParams = { - owner: string; - - recursive?: "1"; - - repo: string; - - tree_sha: string; - }; - export type GitListMatchingRefsParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - ref: string; - - repo: string; - }; - export type GitListRefsParams = { - /** - * Filter by sub-namespace (reference prefix). Most commen examples would be `'heads/'` and `'tags/'` to retrieve branches or tags - */ - namespace?: string; - - owner: string; - - page?: number; - - per_page?: number; - - repo: string; - }; - export type GitUpdateRefParams = { - /** - * Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. - */ - force?: boolean; - - owner: string; - - ref: string; - - repo: string; - /** - * The SHA1 value to set this reference to - */ - sha: string; - }; - export type GitignoreGetTemplateParams = { - name: string; - }; - export type InteractionsAddOrUpdateRestrictionsForOrgParams = { - /** - * 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`. - */ - limit: "existing_users" | "contributors_only" | "collaborators_only"; - - org: string; - }; - export type InteractionsAddOrUpdateRestrictionsForRepoParams = { - /** - * 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`. - */ - limit: "existing_users" | "contributors_only" | "collaborators_only"; - - owner: string; - - repo: string; - }; - export type InteractionsGetRestrictionsForOrgParams = { - org: string; - }; - export type InteractionsGetRestrictionsForRepoParams = { - owner: string; - - repo: string; - }; - export type InteractionsRemoveRestrictionsForOrgParams = { - org: string; - }; - export type InteractionsRemoveRestrictionsForRepoParams = { - owner: string; - - repo: string; - }; - export type IssuesAddAssigneesParamsDeprecatedNumber = { - /** - * Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ - */ - assignees?: string[]; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type IssuesAddAssigneesParams = { - /** - * Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ - */ - assignees?: string[]; - - issue_number: number; - - owner: string; - - repo: string; - }; - export type IssuesAddLabelsParamsDeprecatedNumber = { - /** - * The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. - */ - labels: string[]; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type IssuesAddLabelsParams = { - issue_number: number; - /** - * The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. - */ - labels: string[]; - - owner: string; - - repo: string; - }; - export type IssuesCheckAssigneeParams = { - assignee: string; - - owner: string; - - repo: string; - }; - export type IssuesCreateParamsDeprecatedAssignee = { - /** - * 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.**_ - * @deprecated "assignee" parameter has been deprecated and will be removed in future - */ - assignee?: string; - /** - * 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._ - */ - assignees?: string[]; - /** - * The contents of the issue. - */ - body?: string; - /** - * Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ - */ - labels?: string[]; - /** - * 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._ - */ - milestone?: number; - - owner: string; - - repo: string; - /** - * The title of the issue. - */ - title: string; - }; - export type IssuesCreateParams = { - /** - * 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._ - */ - assignees?: string[]; - /** - * The contents of the issue. - */ - body?: string; - /** - * Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ - */ - labels?: string[]; - /** - * 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._ - */ - milestone?: number; - - owner: string; - - repo: string; - /** - * The title of the issue. - */ - title: string; - }; - export type IssuesCreateCommentParamsDeprecatedNumber = { - /** - * The contents of the comment. - */ - body: string; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type IssuesCreateCommentParams = { - /** - * The contents of the comment. - */ - body: string; - - issue_number: number; - - owner: string; - - repo: string; - }; - export type IssuesCreateLabelParams = { - /** - * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. - */ - color: string; - /** - * A short description of the label. - */ - description?: string; - /** - * 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/). - */ - name: string; - - owner: string; - - repo: string; - }; - export type IssuesCreateMilestoneParams = { - /** - * A description of the milestone. - */ - description?: string; - /** - * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - due_on?: string; - - owner: string; - - repo: string; - /** - * The state of the milestone. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The title of the milestone. - */ - title: string; - }; - export type IssuesDeleteCommentParams = { - comment_id: number; - - owner: string; - - repo: string; - }; - export type IssuesDeleteLabelParams = { - name: string; - - owner: string; - - repo: string; - }; - export type IssuesDeleteMilestoneParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "milestone_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type IssuesDeleteMilestoneParams = { - milestone_number: number; - - owner: string; - - repo: string; - }; - export type IssuesGetParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type IssuesGetParams = { - issue_number: number; - - owner: string; - - repo: string; - }; - export type IssuesGetCommentParams = { - comment_id: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type IssuesGetEventParams = { - event_id: number; - - owner: string; - - repo: string; - }; - export type IssuesGetLabelParams = { - name: string; - - owner: string; - - repo: string; - }; - export type IssuesGetMilestoneParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "milestone_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type IssuesGetMilestoneParams = { - milestone_number: number; - - owner: string; - - repo: string; - }; - export type IssuesListParams = { - /** - * The direction of the sort. Can be either `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * Indicates which sorts of issues to return. Can be one of: - * \* `assigned`: Issues assigned to you - * \* `created`: Issues created by you - * \* `mentioned`: Issues mentioning you - * \* `subscribed`: Issues you're subscribed to updates for - * \* `all`: All issues the authenticated user can see, regardless of participation or creation - */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; - /** - * A list of comma separated label names. Example: `bug,ui,@high` - */ - labels?: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * 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`. - */ - since?: string; - /** - * What to sort results by. Can be either `created`, `updated`, `comments`. - */ - sort?: "created" | "updated" | "comments"; - /** - * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - }; - export type IssuesListAssigneesParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type IssuesListCommentsParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - /** - * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - since?: string; - }; - export type IssuesListCommentsParams = { - issue_number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - /** - * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - since?: string; - }; - export type IssuesListCommentsForRepoParams = { - /** - * Either `asc` or `desc`. Ignored without the `sort` parameter. - */ - direction?: "asc" | "desc"; - - owner: string; - - repo: string; - /** - * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - since?: string; - /** - * Either `created` or `updated`. - */ - sort?: "created" | "updated"; - }; - export type IssuesListEventsParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type IssuesListEventsParams = { - issue_number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type IssuesListEventsForRepoParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type IssuesListEventsForTimelineParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type IssuesListEventsForTimelineParams = { - issue_number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type IssuesListForAuthenticatedUserParams = { - /** - * The direction of the sort. Can be either `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * Indicates which sorts of issues to return. Can be one of: - * \* `assigned`: Issues assigned to you - * \* `created`: Issues created by you - * \* `mentioned`: Issues mentioning you - * \* `subscribed`: Issues you're subscribed to updates for - * \* `all`: All issues the authenticated user can see, regardless of participation or creation - */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; - /** - * A list of comma separated label names. Example: `bug,ui,@high` - */ - labels?: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * 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`. - */ - since?: string; - /** - * What to sort results by. Can be either `created`, `updated`, `comments`. - */ - sort?: "created" | "updated" | "comments"; - /** - * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - }; - export type IssuesListForOrgParams = { - /** - * The direction of the sort. Can be either `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * Indicates which sorts of issues to return. Can be one of: - * \* `assigned`: Issues assigned to you - * \* `created`: Issues created by you - * \* `mentioned`: Issues mentioning you - * \* `subscribed`: Issues you're subscribed to updates for - * \* `all`: All issues the authenticated user can see, regardless of participation or creation - */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; - /** - * A list of comma separated label names. Example: `bug,ui,@high` - */ - labels?: string; - - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * 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`. - */ - since?: string; - /** - * What to sort results by. Can be either `created`, `updated`, `comments`. - */ - sort?: "created" | "updated" | "comments"; - /** - * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - }; - export type IssuesListForRepoParams = { - /** - * Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. - */ - assignee?: string; - /** - * The user that created the issue. - */ - creator?: string; - /** - * The direction of the sort. Can be either `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * A list of comma separated label names. Example: `bug,ui,@high` - */ - labels?: string; - /** - * A user that's mentioned in the issue. - */ - mentioned?: string; - /** - * 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. - */ - milestone?: string; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - /** - * 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`. - */ - since?: string; - /** - * What to sort results by. Can be either `created`, `updated`, `comments`. - */ - sort?: "created" | "updated" | "comments"; - /** - * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - }; - export type IssuesListLabelsForMilestoneParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "milestone_number" - */ - number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type IssuesListLabelsForMilestoneParams = { - milestone_number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type IssuesListLabelsForRepoParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type IssuesListLabelsOnIssueParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type IssuesListLabelsOnIssueParams = { - issue_number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type IssuesListMilestonesForRepoParams = { - /** - * The direction of the sort. Either `asc` or `desc`. - */ - direction?: "asc" | "desc"; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - /** - * What to sort results by. Either `due_on` or `completeness`. - */ - sort?: "due_on" | "completeness"; - /** - * The state of the milestone. Either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - }; - export type IssuesLockParamsDeprecatedNumber = { - /** - * The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: - * \* `off-topic` - * \* `too heated` - * \* `resolved` - * \* `spam` - */ - lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type IssuesLockParams = { - issue_number: number; - /** - * The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: - * \* `off-topic` - * \* `too heated` - * \* `resolved` - * \* `spam` - */ - lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; - - owner: string; - - repo: string; - }; - export type IssuesRemoveAssigneesParamsDeprecatedNumber = { - /** - * Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ - */ - assignees?: string[]; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type IssuesRemoveAssigneesParams = { - /** - * Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ - */ - assignees?: string[]; - - issue_number: number; - - owner: string; - - repo: string; - }; - export type IssuesRemoveLabelParamsDeprecatedNumber = { - name: string; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type IssuesRemoveLabelParams = { - issue_number: number; - - name: string; - - owner: string; - - repo: string; - }; - export type IssuesRemoveLabelsParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type IssuesRemoveLabelsParams = { - issue_number: number; - - owner: string; - - repo: string; - }; - export type IssuesReplaceLabelsParamsDeprecatedNumber = { - /** - * The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. - */ - labels?: string[]; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type IssuesReplaceLabelsParams = { - issue_number: number; - /** - * The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. - */ - labels?: string[]; - - owner: string; - - repo: string; - }; - export type IssuesUnlockParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type IssuesUnlockParams = { - issue_number: number; - - owner: string; - - repo: string; - }; - export type IssuesUpdateParamsDeprecatedNumber = { - /** - * Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ - */ - assignees?: string[]; - /** - * The contents of the issue. - */ - body?: string; - /** - * Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ - */ - labels?: string[]; - /** - * The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ - */ - milestone?: number | null; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - - repo: string; - /** - * State of the issue. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The title of the issue. - */ - title?: string; - }; - export type IssuesUpdateParamsDeprecatedAssignee = { - /** - * Login for the user that this issue should be assigned to. **This field is deprecated.** - * @deprecated "assignee" parameter has been deprecated and will be removed in future - */ - assignee?: string; - /** - * Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ - */ - assignees?: string[]; - /** - * The contents of the issue. - */ - body?: string; - - issue_number: number; - /** - * Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ - */ - labels?: string[]; - /** - * The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ - */ - milestone?: number | null; - - owner: string; - - repo: string; - /** - * State of the issue. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The title of the issue. - */ - title?: string; - }; - export type IssuesUpdateParams = { - /** - * Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ - */ - assignees?: string[]; - /** - * The contents of the issue. - */ - body?: string; - - issue_number: number; - /** - * Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ - */ - labels?: string[]; - /** - * The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ - */ - milestone?: number | null; - - owner: string; - - repo: string; - /** - * State of the issue. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The title of the issue. - */ - title?: string; - }; - export type IssuesUpdateCommentParams = { - /** - * The contents of the comment. - */ - body: string; - - comment_id: number; - - owner: string; - - repo: string; - }; - export type IssuesUpdateLabelParams = { - /** - * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. - */ - color?: string; - - current_name: string; - /** - * A short description of the label. - */ - description?: string; - /** - * The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). - */ - name?: string; - - owner: string; - - repo: string; - }; - export type IssuesUpdateMilestoneParamsDeprecatedNumber = { - /** - * A description of the milestone. - */ - description?: string; - /** - * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - due_on?: string; - /** - * @deprecated "number" parameter renamed to "milestone_number" - */ - number: number; - - owner: string; - - repo: string; - /** - * The state of the milestone. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The title of the milestone. - */ - title?: string; - }; - export type IssuesUpdateMilestoneParams = { - /** - * A description of the milestone. - */ - description?: string; - /** - * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - due_on?: string; - - milestone_number: number; - - owner: string; - - repo: string; - /** - * The state of the milestone. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The title of the milestone. - */ - title?: string; - }; - export type LicensesGetParams = { - license: string; - }; - export type LicensesGetForRepoParams = { - owner: string; - - repo: string; - }; - export type MarkdownRenderParams = { - /** - * The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode. - */ - context?: string; - /** - * The rendering mode. Can be either: - * \* `markdown` to render a document in plain Markdown, just like README.md files are rendered. - * \* `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. - */ - mode?: "markdown" | "gfm"; - /** - * The Markdown text to render in HTML. Markdown content must be 400 KB or less. - */ - text: string; - }; - export type MarkdownRenderRawParams = { - data: string; - }; - export type MigrationsCancelImportParams = { - owner: string; - - repo: string; - }; - export type MigrationsDeleteArchiveForAuthenticatedUserParams = { - migration_id: number; - }; - export type MigrationsDeleteArchiveForOrgParams = { - migration_id: number; - - org: string; - }; - export type MigrationsGetArchiveForAuthenticatedUserParams = { - migration_id: number; - }; - export type MigrationsGetArchiveForOrgParams = { - migration_id: number; - - org: string; - }; - export type MigrationsGetCommitAuthorsParams = { - owner: string; - - repo: string; - /** - * 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. - */ - since?: string; - }; - export type MigrationsGetImportProgressParams = { - owner: string; - - repo: string; - }; - export type MigrationsGetLargeFilesParams = { - owner: string; - - repo: string; - }; - export type MigrationsGetStatusForAuthenticatedUserParams = { - migration_id: number; - }; - export type MigrationsGetStatusForOrgParams = { - migration_id: number; - - org: string; - }; - export type MigrationsListForAuthenticatedUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type MigrationsListForOrgParams = { - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type MigrationsMapCommitAuthorParams = { - author_id: number; - /** - * The new Git author email. - */ - email?: string; - /** - * The new Git author name. - */ - name?: string; - - owner: string; - - repo: string; - }; - export type MigrationsSetLfsPreferenceParams = { - owner: string; - - repo: string; - /** - * 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). - */ - use_lfs: "opt_in" | "opt_out"; - }; - export type MigrationsStartForAuthenticatedUserParams = { - /** - * 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. - */ - exclude_attachments?: boolean; - /** - * Locks the `repositories` to prevent changes during the migration when set to `true`. - */ - lock_repositories?: boolean; - /** - * An array of repositories to include in the migration. - */ - repositories: string[]; - }; - export type MigrationsStartForOrgParams = { - /** - * Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). - */ - exclude_attachments?: boolean; - /** - * Indicates whether repositories should be locked (to prevent manipulation) while migrating data. - */ - lock_repositories?: boolean; - - org: string; - /** - * A list of arrays indicating which repositories should be migrated. - */ - repositories: string[]; - }; - export type MigrationsStartImportParams = { - owner: string; - - repo: string; - /** - * For a tfvc import, the name of the project that is being imported. - */ - tfvc_project?: string; - /** - * 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. - */ - vcs?: "subversion" | "git" | "mercurial" | "tfvc"; - /** - * If authentication is required, the password to provide to `vcs_url`. - */ - vcs_password?: string; - /** - * The URL of the originating repository. - */ - vcs_url: string; - /** - * If authentication is required, the username to provide to `vcs_url`. - */ - vcs_username?: string; - }; - export type MigrationsUnlockRepoForAuthenticatedUserParams = { - migration_id: number; - - repo_name: string; - }; - export type MigrationsUnlockRepoForOrgParams = { - migration_id: number; - - org: string; - - repo_name: string; - }; - export type MigrationsUpdateImportParams = { - owner: string; - - repo: string; - /** - * The password to provide to the originating repository. - */ - vcs_password?: string; - /** - * The username to provide to the originating repository. - */ - vcs_username?: string; - }; - export type OauthAuthorizationsCheckAuthorizationParams = { - access_token: string; - - client_id: string; - }; - export type OauthAuthorizationsCreateAuthorizationParams = { - /** - * The 20 character OAuth app client key for which to create the token. - */ - client_id?: string; - /** - * The 40 character OAuth app client secret for which to create the token. - */ - client_secret?: string; - /** - * A unique string to distinguish an authorization from others created for the same client ID and user. - */ - fingerprint?: string; - /** - * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. - */ - note: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; - }; - export type OauthAuthorizationsDeleteAuthorizationParams = { - authorization_id: number; - }; - export type OauthAuthorizationsDeleteGrantParams = { - grant_id: number; - }; - export type OauthAuthorizationsGetAuthorizationParams = { - authorization_id: number; - }; - export type OauthAuthorizationsGetGrantParams = { - grant_id: number; - }; - export type OauthAuthorizationsGetOrCreateAuthorizationForAppParams = { - client_id: string; - /** - * The 40 character OAuth app client secret associated with the client ID specified in the URL. - */ - client_secret: string; - /** - * A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint). - */ - fingerprint?: string; - /** - * A note to remind you what the OAuth token is for. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; - }; - export type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintParams = { - client_id: string; - /** - * The 40 character OAuth app client secret associated with the client ID specified in the URL. - */ - client_secret: string; - - fingerprint: string; - /** - * A note to remind you what the OAuth token is for. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; - }; - export type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintParams = { - client_id: string; - /** - * The 40 character OAuth app client secret associated with the client ID specified in the URL. - */ - client_secret: string; - - fingerprint: string; - /** - * A note to remind you what the OAuth token is for. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; - }; - export type OauthAuthorizationsListAuthorizationsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type OauthAuthorizationsListGrantsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type OauthAuthorizationsResetAuthorizationParams = { - access_token: string; - - client_id: string; - }; - export type OauthAuthorizationsRevokeAuthorizationForApplicationParams = { - access_token: string; - - client_id: string; - }; - export type OauthAuthorizationsRevokeGrantForApplicationParams = { - access_token: string; - - client_id: string; - }; - export type OauthAuthorizationsUpdateAuthorizationParams = { - /** - * A list of scopes to add to this authorization. - */ - add_scopes?: string[]; - - authorization_id: number; - /** - * A unique string to distinguish an authorization from others created for the same client ID and user. - */ - fingerprint?: string; - /** - * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * A list of scopes to remove from this authorization. - */ - remove_scopes?: string[]; - /** - * Replaces the authorization scopes with these. - */ - scopes?: string[]; - }; - export type OrgsAddOrUpdateMembershipParams = { - org: string; - /** - * The role to give the user in the organization. Can be one of: - * \* `admin` - The user will become an owner of the organization. - * \* `member` - The user will become a non-owner member of the organization. - */ - role?: "admin" | "member"; - - username: string; - }; - export type OrgsBlockUserParams = { - org: string; - - username: string; - }; - export type OrgsCheckBlockedUserParams = { - org: string; - - username: string; - }; - export type OrgsCheckMembershipParams = { - org: string; - - username: string; - }; - export type OrgsCheckPublicMembershipParams = { - org: string; - - username: string; - }; - export type OrgsConcealMembershipParams = { - org: string; - - username: string; - }; - export type OrgsConvertMemberToOutsideCollaboratorParams = { - org: string; - - username: string; - }; - export type OrgsCreateHookParams = { - /** - * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - */ - active?: boolean; - /** - * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params). - */ - config: OrgsCreateHookParamsConfig; - /** - * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. - */ - events?: string[]; - /** - * Must be passed as "web". - */ - name: string; - - org: string; - }; - export type OrgsCreateInvitationParams = { - /** - * **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. - */ - email?: string; - /** - * **Required unless you provide `email`**. GitHub user ID for the person you are inviting. - */ - invitee_id?: number; - - org: string; - /** - * Specify role for new member. Can be one of: - * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. - * \* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. - * \* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. - */ - role?: "admin" | "direct_member" | "billing_manager"; - /** - * Specify IDs for the teams you want to invite new members to. - */ - team_ids?: number[]; - }; - export type OrgsDeleteHookParams = { - hook_id: number; - - org: string; - }; - export type OrgsGetParams = { - org: string; - }; - export type OrgsGetHookParams = { - hook_id: number; - - org: string; - }; - export type OrgsGetMembershipParams = { - org: string; - - username: string; - }; - export type OrgsGetMembershipForAuthenticatedUserParams = { - org: string; - }; - export type OrgsListParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * The integer ID of the last Organization that you've seen. - */ - since?: string; - }; - export type OrgsListBlockedUsersParams = { - org: string; - }; - export type OrgsListForAuthenticatedUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type OrgsListForUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - username: string; - }; - export type OrgsListHooksParams = { - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type OrgsListInstallationsParams = { - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type OrgsListInvitationTeamsParams = { - invitation_id: number; - - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type OrgsListMembersParams = { - /** - * Filter members returned in the list. Can be one of: - * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. - * \* `all` - All members the authenticated user can see. - */ - filter?: "2fa_disabled" | "all"; - - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Filter members returned by their role. Can be one of: - * \* `all` - All members of the organization, regardless of role. - * \* `admin` - Organization owners. - * \* `member` - Non-owner organization members. - */ - role?: "all" | "admin" | "member"; - }; - export type OrgsListMembershipsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * 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. - */ - state?: "active" | "pending"; - }; - export type OrgsListOutsideCollaboratorsParams = { - /** - * Filter the list of outside collaborators. Can be one of: - * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. - * \* `all`: All outside collaborators. - */ - filter?: "2fa_disabled" | "all"; - - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type OrgsListPendingInvitationsParams = { - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type OrgsListPublicMembersParams = { - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type OrgsPingHookParams = { - hook_id: number; - - org: string; - }; - export type OrgsPublicizeMembershipParams = { - org: string; - - username: string; - }; - export type OrgsRemoveMemberParams = { - org: string; - - username: string; - }; - export type OrgsRemoveMembershipParams = { - org: string; - - username: string; - }; - export type OrgsRemoveOutsideCollaboratorParams = { - org: string; - - username: string; - }; - export type OrgsUnblockUserParams = { - org: string; - - username: string; - }; - export type OrgsUpdateParams = { - /** - * Billing email address. This address is not publicized. - */ - billing_email?: string; - /** - * The company name. - */ - company?: string; - /** - * Default permission level members have for organization repositories: - * \* `read` - can pull, but not push to or administer this repository. - * \* `write` - can pull and push, but not administer this repository. - * \* `admin` - can pull, push, and administer this repository. - * \* `none` - no permissions granted by default. - */ - default_repository_permission?: "read" | "write" | "admin" | "none"; - /** - * The description of the company. - */ - description?: string; - /** - * The publicly visible email address. - */ - email?: string; - /** - * Toggles whether organization projects are enabled for the organization. - */ - has_organization_projects?: boolean; - /** - * Toggles whether repository projects are enabled for repositories that belong to the organization. - */ - has_repository_projects?: boolean; - /** - * The location. - */ - location?: string; - /** - * Specifies which types of repositories non-admin organization members can create. Can be one of: - * \* `all` - all organization members can create public and private repositories. - * \* `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). - * \* `none` - only admin members can create repositories. - * **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. - */ - members_allowed_repository_creation_type?: "all" | "private" | "none"; - /** - * Toggles the ability of non-admin organization members to create repositories. Can be one of: - * \* `true` - all organization members can create repositories. - * \* `false` - only admin members can create repositories. - * Default: `true` - * **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. - */ - members_can_create_repositories?: boolean; - /** - * The shorthand name of the company. - */ - name?: string; - - org: string; - }; - export type OrgsUpdateHookParams = { - /** - * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - */ - active?: boolean; - /** - * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params). - */ - config?: OrgsUpdateHookParamsConfig; - /** - * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. - */ - events?: string[]; - - hook_id: number; - - org: string; - }; - export type OrgsUpdateMembershipParams = { - org: string; - /** - * The state that the membership should be in. Only `"active"` will be accepted. - */ - state: "active"; - }; - export type ProjectsAddCollaboratorParams = { - /** - * 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: - * \* `read` - can read, but not write to or administer this project. - * \* `write` - can read and write, but not administer this project. - * \* `admin` - can read, write and administer this project. - */ - permission?: "read" | "write" | "admin"; - - project_id: number; - - username: string; - }; - export type ProjectsCreateCardParams = { - column_id: number; - /** - * 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. - * **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_id?: number; - /** - * **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. - */ - content_type?: string; - /** - * 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`. - */ - note?: string; - }; - export type ProjectsCreateColumnParams = { - /** - * The name of the column. - */ - name: string; - - project_id: number; - }; - export type ProjectsCreateForAuthenticatedUserParams = { - /** - * The description of the project. - */ - body?: string; - /** - * The name of the project. - */ - name: string; - }; - export type ProjectsCreateForOrgParams = { - /** - * The description of the project. - */ - body?: string; - /** - * The name of the project. - */ - name: string; - - org: string; - }; - export type ProjectsCreateForRepoParams = { - /** - * The description of the project. - */ - body?: string; - /** - * The name of the project. - */ - name: string; - - owner: string; - - repo: string; - }; - export type ProjectsDeleteParams = { - project_id: number; - }; - export type ProjectsDeleteCardParams = { - card_id: number; - }; - export type ProjectsDeleteColumnParams = { - column_id: number; - }; - export type ProjectsGetParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - project_id: number; - }; - export type ProjectsGetCardParams = { - card_id: number; - }; - export type ProjectsGetColumnParams = { - column_id: number; - }; - export type ProjectsListCardsParams = { - /** - * Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. - */ - archived_state?: "all" | "archived" | "not_archived"; - - column_id: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type ProjectsListCollaboratorsParams = { - /** - * Filters the collaborators by their affiliation. Can be one of: - * \* `outside`: Outside collaborators of a project that are not a member of the project's organization. - * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. - * \* `all`: All collaborators the authenticated user can see. - */ - affiliation?: "outside" | "direct" | "all"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - project_id: number; - }; - export type ProjectsListColumnsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - project_id: number; - }; - export type ProjectsListForOrgParams = { - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - }; - export type ProjectsListForRepoParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - /** - * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - }; - export type ProjectsListForUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - - username: string; - }; - export type ProjectsMoveCardParams = { - card_id: number; - /** - * The `id` value of a column in the same project. - */ - column_id?: number; - /** - * 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`. - */ - position: string; - }; - export type ProjectsMoveColumnParams = { - column_id: number; - /** - * Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project. - */ - position: string; - }; - export type ProjectsRemoveCollaboratorParams = { - project_id: number; - - username: string; - }; - export type ProjectsReviewUserPermissionLevelParams = { - project_id: number; - - username: string; - }; - export type ProjectsUpdateParams = { - /** - * The description of the project. - */ - body?: string; - /** - * The name of the project. - */ - name?: string; - /** - * 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). - * - * **Note:** Updating a project's `organization_permission` requires `admin` access to the project. - * - * Can be one of: - * \* `read` - Organization members can read, but not write to or administer this project. - * \* `write` - Organization members can read and write, but not administer this project. - * \* `admin` - Organization members can read, write and administer this project. - * \* `none` - Organization members can only see this project if it is public. - */ - organization_permission?: string; - /** - * 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. - * - * Can be one of: - * \* `false` - Anyone can see the project. - * \* `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. - */ - private?: boolean; - - project_id: number; - /** - * State of the project. Either `open` or `closed`. - */ - state?: "open" | "closed"; - }; - export type ProjectsUpdateCardParams = { - /** - * Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card. - */ - archived?: boolean; - - card_id: number; - /** - * The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`. - */ - note?: string; - }; - export type ProjectsUpdateColumnParams = { - column_id: number; - /** - * The new name of the column. - */ - name: string; - }; - export type PullsCheckIfMergedParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type PullsCheckIfMergedParams = { - owner: string; - - pull_number: number; - - repo: string; - }; - export type PullsCreateParams = { - /** - * The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. - */ - base: string; - /** - * The contents of the pull request. - */ - body?: string; - /** - * Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. - */ - draft?: boolean; - /** - * The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. - */ - head: string; - /** - * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. - */ - maintainer_can_modify?: boolean; - - owner: string; - - repo: string; - /** - * The title of the new pull request. - */ - title: string; - }; - export type PullsCreateCommentParamsDeprecatedNumber = { - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - /** - * The relative path to the file that necessitates a comment. - */ - path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - - repo: string; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; - }; - export type PullsCreateCommentParamsDeprecatedInReplyTo = { - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported. - * @deprecated "in_reply_to" parameter has been deprecated and will be removed in future - */ - in_reply_to?: number; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - - owner: string; - /** - * The relative path to the file that necessitates a comment. - */ - path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - - pull_number: number; - - repo: string; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; - }; - export type PullsCreateCommentParams = { - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - - owner: string; - /** - * The relative path to the file that necessitates a comment. - */ - path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - - pull_number: number; - - repo: string; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; - }; - export type PullsCreateCommentReplyParamsDeprecatedNumber = { - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - /** - * The relative path to the file that necessitates a comment. - */ - path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - - repo: string; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; - }; - export type PullsCreateCommentReplyParamsDeprecatedInReplyTo = { - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported. - * @deprecated "in_reply_to" parameter has been deprecated and will be removed in future - */ - in_reply_to?: number; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - - owner: string; - /** - * The relative path to the file that necessitates a comment. - */ - path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - - pull_number: number; - - repo: string; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; - }; - export type PullsCreateCommentReplyParams = { - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - - owner: string; - /** - * The relative path to the file that necessitates a comment. - */ - path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - - pull_number: number; - - repo: string; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; - }; - export type PullsCreateFromIssueParams = { - base: string; - - draft?: boolean; - - head: string; - - issue: number; - - maintainer_can_modify?: boolean; - - owner: string; - - repo: string; - }; - export type PullsCreateReviewParamsDeprecatedNumber = { - /** - * **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. - */ - body?: string; - /** - * Use the following table to specify the location, destination, and contents of the draft review comment. - */ - comments?: PullsCreateReviewParamsComments[]; - /** - * The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. - */ - commit_id?: string; - /** - * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready. - */ - event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type PullsCreateReviewParams = { - /** - * **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. - */ - body?: string; - /** - * Use the following table to specify the location, destination, and contents of the draft review comment. - */ - comments?: PullsCreateReviewParamsComments[]; - /** - * The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. - */ - commit_id?: string; - /** - * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready. - */ - event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; - - owner: string; - - pull_number: number; - - repo: string; - }; - export type PullsCreateReviewCommentReplyParams = { - /** - * The text of the review comment. - */ - body: string; - - comment_id: number; - - owner: string; - - pull_number: number; - - repo: string; - }; - export type PullsCreateReviewRequestParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - - repo: string; - /** - * An array of user `login`s that will be requested. - */ - reviewers?: string[]; - /** - * An array of team `slug`s that will be requested. - */ - team_reviewers?: string[]; - }; - export type PullsCreateReviewRequestParams = { - owner: string; - - pull_number: number; - - repo: string; - /** - * An array of user `login`s that will be requested. - */ - reviewers?: string[]; - /** - * An array of team `slug`s that will be requested. - */ - team_reviewers?: string[]; - }; - export type PullsDeleteCommentParams = { - comment_id: number; - - owner: string; - - repo: string; - }; - export type PullsDeletePendingReviewParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - - repo: string; - - review_id: number; - }; - export type PullsDeletePendingReviewParams = { - owner: string; - - pull_number: number; - - repo: string; - - review_id: number; - }; - export type PullsDeleteReviewRequestParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - - repo: string; - /** - * An array of user `login`s that will be removed. - */ - reviewers?: string[]; - /** - * An array of team `slug`s that will be removed. - */ - team_reviewers?: string[]; - }; - export type PullsDeleteReviewRequestParams = { - owner: string; - - pull_number: number; - - repo: string; - /** - * An array of user `login`s that will be removed. - */ - reviewers?: string[]; - /** - * An array of team `slug`s that will be removed. - */ - team_reviewers?: string[]; - }; - export type PullsDismissReviewParamsDeprecatedNumber = { - /** - * The message for the pull request review dismissal - */ - message: string; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - - repo: string; - - review_id: number; - }; - export type PullsDismissReviewParams = { - /** - * The message for the pull request review dismissal - */ - message: string; - - owner: string; - - pull_number: number; - - repo: string; - - review_id: number; - }; - export type PullsGetParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type PullsGetParams = { - owner: string; - - pull_number: number; - - repo: string; - }; - export type PullsGetCommentParams = { - comment_id: number; - - owner: string; - - repo: string; - }; - export type PullsGetCommentsForReviewParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - - review_id: number; - }; - export type PullsGetCommentsForReviewParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - pull_number: number; - - repo: string; - - review_id: number; - }; - export type PullsGetReviewParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - - repo: string; - - review_id: number; - }; - export type PullsGetReviewParams = { - owner: string; - - pull_number: number; - - repo: string; - - review_id: number; - }; - export type PullsListParams = { - /** - * Filter pulls by base branch name. Example: `gh-pages`. - */ - base?: string; - /** - * The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. - */ - direction?: "asc" | "desc"; - /** - * 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`. - */ - head?: string; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - /** - * 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). - */ - sort?: "created" | "updated" | "popularity" | "long-running"; - /** - * Either `open`, `closed`, or `all` to filter by state. - */ - state?: "open" | "closed" | "all"; - }; - export type PullsListCommentsParamsDeprecatedNumber = { - /** - * Can be either `asc` or `desc`. Ignored without `sort` parameter. - */ - direction?: "asc" | "desc"; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - /** - * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. - */ - since?: string; - /** - * Can be either `created` or `updated` comments. - */ - sort?: "created" | "updated"; - }; - export type PullsListCommentsParams = { - /** - * Can be either `asc` or `desc`. Ignored without `sort` parameter. - */ - direction?: "asc" | "desc"; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - pull_number: number; - - repo: string; - /** - * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. - */ - since?: string; - /** - * Can be either `created` or `updated` comments. - */ - sort?: "created" | "updated"; - }; - export type PullsListCommentsForRepoParams = { - /** - * Can be either `asc` or `desc`. Ignored without `sort` parameter. - */ - direction?: "asc" | "desc"; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - /** - * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. - */ - since?: string; - /** - * Can be either `created` or `updated` comments. - */ - sort?: "created" | "updated"; - }; - export type PullsListCommitsParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type PullsListCommitsParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - pull_number: number; - - repo: string; - }; - export type PullsListFilesParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type PullsListFilesParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - pull_number: number; - - repo: string; - }; - export type PullsListReviewRequestsParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type PullsListReviewRequestsParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - pull_number: number; - - repo: string; - }; - export type PullsListReviewsParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type PullsListReviewsParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - pull_number: number; - - repo: string; - }; - export type PullsMergeParamsDeprecatedNumber = { - /** - * Extra detail to append to automatic commit message. - */ - commit_message?: string; - /** - * Title for the automatic commit message. - */ - commit_title?: string; - /** - * Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. - */ - merge_method?: "merge" | "squash" | "rebase"; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - - repo: string; - /** - * SHA that pull request head must match to allow merge. - */ - sha?: string; - }; - export type PullsMergeParams = { - /** - * Extra detail to append to automatic commit message. - */ - commit_message?: string; - /** - * Title for the automatic commit message. - */ - commit_title?: string; - /** - * Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. - */ - merge_method?: "merge" | "squash" | "rebase"; - - owner: string; - - pull_number: number; - - repo: string; - /** - * SHA that pull request head must match to allow merge. - */ - sha?: string; - }; - export type PullsSubmitReviewParamsDeprecatedNumber = { - /** - * The body text of the pull request review - */ - body?: string; - /** - * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. - */ - event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - - repo: string; - - review_id: number; - }; - export type PullsSubmitReviewParams = { - /** - * The body text of the pull request review - */ - body?: string; - /** - * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. - */ - event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; - - owner: string; - - pull_number: number; - - repo: string; - - review_id: number; - }; - export type PullsUpdateParamsDeprecatedNumber = { - /** - * The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. - */ - base?: string; - /** - * The contents of the pull request. - */ - body?: string; - /** - * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. - */ - maintainer_can_modify?: boolean; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - - repo: string; - /** - * State of this Pull Request. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The title of the pull request. - */ - title?: string; - }; - export type PullsUpdateParams = { - /** - * The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. - */ - base?: string; - /** - * The contents of the pull request. - */ - body?: string; - /** - * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. - */ - maintainer_can_modify?: boolean; - - owner: string; - - pull_number: number; - - repo: string; - /** - * State of this Pull Request. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The title of the pull request. - */ - title?: string; - }; - export type PullsUpdateBranchParams = { - /** - * 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. - */ - expected_head_sha?: string; - - owner: string; - - pull_number: number; - - repo: string; - }; - export type PullsUpdateCommentParams = { - /** - * The text of the reply to the review comment. - */ - body: string; - - comment_id: number; - - owner: string; - - repo: string; - }; - export type PullsUpdateReviewParamsDeprecatedNumber = { - /** - * The body text of the pull request review. - */ - body: string; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - - owner: string; - - repo: string; - - review_id: number; - }; - export type PullsUpdateReviewParams = { - /** - * The body text of the pull request review. - */ - body: string; - - owner: string; - - pull_number: number; - - repo: string; - - review_id: number; - }; - export type ReactionsCreateForCommitCommentParams = { - comment_id: number; - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - - owner: string; - - repo: string; - }; - export type ReactionsCreateForIssueParamsDeprecatedNumber = { - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - - repo: string; - }; - export type ReactionsCreateForIssueParams = { - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - - issue_number: number; - - owner: string; - - repo: string; - }; - export type ReactionsCreateForIssueCommentParams = { - comment_id: number; - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - - owner: string; - - repo: string; - }; - export type ReactionsCreateForPullRequestReviewCommentParams = { - comment_id: number; - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - - owner: string; - - repo: string; - }; - export type ReactionsCreateForTeamDiscussionParams = { - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - - discussion_number: number; - - team_id: number; - }; - export type ReactionsCreateForTeamDiscussionCommentParams = { - comment_number: number; - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - - discussion_number: number; - - team_id: number; - }; - export type ReactionsDeleteParams = { - reaction_id: number; - }; - export type ReactionsListForCommitCommentParams = { - comment_id: number; - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReactionsListForIssueParamsDeprecatedNumber = { - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReactionsListForIssueParams = { - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - - issue_number: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReactionsListForIssueCommentParams = { - comment_id: number; - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReactionsListForPullRequestReviewCommentParams = { - comment_id: number; - /** - * 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. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReactionsListForTeamDiscussionParams = { - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - - discussion_number: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - team_id: number; - }; - export type ReactionsListForTeamDiscussionCommentParams = { - comment_number: number; - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - - discussion_number: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - team_id: number; - }; - export type ReposAcceptInvitationParams = { - invitation_id: number; - }; - export type ReposAddCollaboratorParams = { - owner: string; - /** - * The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: - * \* `pull` - can pull, but not push to or administer this repository. - * \* `push` - can pull and push, but not administer this repository. - * \* `admin` - can pull, push and administer this repository. - */ - permission?: "pull" | "push" | "admin"; - - repo: string; - - username: string; - }; - export type ReposAddDeployKeyParams = { - /** - * The contents of the key. - */ - key: string; - - owner: string; - /** - * If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. - * - * Deploy 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/)." - */ - read_only?: boolean; - - repo: string; - /** - * A name for the key. - */ - title?: string; - }; - export type ReposAddProtectedBranchAdminEnforcementParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposAddProtectedBranchAppRestrictionsParams = { - apps: string[]; - - branch: string; - - owner: string; - - repo: string; - }; - export type ReposAddProtectedBranchRequiredSignaturesParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposAddProtectedBranchRequiredStatusChecksContextsParams = { - branch: string; - - contexts: string[]; - - owner: string; - - repo: string; - }; - export type ReposAddProtectedBranchTeamRestrictionsParams = { - branch: string; - - owner: string; - - repo: string; - - teams: string[]; - }; - export type ReposAddProtectedBranchUserRestrictionsParams = { - branch: string; - - owner: string; - - repo: string; - - users: string[]; - }; - export type ReposCheckCollaboratorParams = { - owner: string; - - repo: string; - - username: string; - }; - export type ReposCheckVulnerabilityAlertsParams = { - owner: string; - - repo: string; - }; - export type ReposCompareCommitsParams = { - base: string; - - head: string; - - owner: string; - - repo: string; - }; - export type ReposCreateCommitCommentParamsDeprecatedSha = { - /** - * The contents of the comment. - */ - body: string; - - owner: string; - /** - * Relative path of the file to comment on. - */ - path?: string; - /** - * Line index in the diff to comment on. - */ - position?: number; - - repo: string; - /** - * @deprecated "sha" parameter renamed to "commit_sha" - */ - sha: string; - }; - export type ReposCreateCommitCommentParamsDeprecatedLine = { - /** - * The contents of the comment. - */ - body: string; - - commit_sha: string; - /** - * **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. - * @deprecated "line" parameter has been deprecated and will be removed in future - */ - line?: number; - - owner: string; - /** - * Relative path of the file to comment on. - */ - path?: string; - /** - * Line index in the diff to comment on. - */ - position?: number; - - repo: string; - }; - export type ReposCreateCommitCommentParams = { - /** - * The contents of the comment. - */ - body: string; - - commit_sha: string; - - owner: string; - /** - * Relative path of the file to comment on. - */ - path?: string; - /** - * Line index in the diff to comment on. - */ - position?: number; - - repo: string; - }; - export type ReposCreateDeploymentParams = { - /** - * Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. - */ - auto_merge?: boolean; - /** - * Short description of the deployment. - */ - description?: string; - /** - * Name for the target deployment environment (e.g., `production`, `staging`, `qa`). - */ - environment?: string; - - owner: string; - /** - * JSON payload with extra information about the deployment. - */ - payload?: string; - /** - * Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. - * **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. - */ - production_environment?: boolean; - /** - * The ref to deploy. This can be a branch, tag, or SHA. - */ - ref: string; - - repo: string; - /** - * 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. - */ - required_contexts?: string[]; - /** - * Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). - */ - task?: string; - /** - * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` - * **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. - */ - transient_environment?: boolean; - }; - export type ReposCreateDeploymentStatusParams = { - /** - * 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` - * **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. - * **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. - */ - auto_inactive?: boolean; - - deployment_id: number; - /** - * A short description of the status. The maximum description length is 140 characters. - */ - description?: string; - /** - * 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. - */ - environment?: "production" | "staging" | "qa"; - /** - * Sets the URL for accessing your environment. Default: `""` - * **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. - */ - environment_url?: string; - /** - * 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: `""` - * **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. - */ - log_url?: string; - - owner: string; - - repo: string; - /** - * 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. - */ - state: - | "error" - | "failure" - | "inactive" - | "in_progress" - | "queued" - | "pending" - | "success"; - /** - * 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`. - */ - target_url?: string; - }; - export type ReposCreateDispatchEventParams = { - /** - * JSON payload with extra information about the webhook event that your action or worklow may use. - */ - client_payload?: ReposCreateDispatchEventParamsClientPayload; - /** - * **Required:** A custom webhook event name. - */ - event_type?: string; - - owner: string; - - repo: string; - }; - export type ReposCreateFileParams = { - /** - * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. - */ - author?: ReposCreateFileParamsAuthor; - /** - * The branch name. Default: the repository’s default branch (usually `master`) - */ - branch?: string; - /** - * The person that committed the file. Default: the authenticated user. - */ - committer?: ReposCreateFileParamsCommitter; - /** - * The new file content, using Base64 encoding. - */ - content: string; - /** - * The commit message. - */ - message: string; - - owner: string; - - path: string; - - repo: string; - /** - * **Required if you are updating a file**. The blob SHA of the file being replaced. - */ - sha?: string; - }; - export type ReposCreateForAuthenticatedUserParams = { - /** - * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. - */ - allow_merge_commit?: boolean; - /** - * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. - */ - allow_rebase_merge?: boolean; - /** - * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. - */ - allow_squash_merge?: boolean; - /** - * Pass `true` to create an initial commit with empty README. - */ - auto_init?: boolean; - /** - * A short description of the repository. - */ - description?: string; - /** - * 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". - */ - gitignore_template?: string; - /** - * Either `true` to enable issues for this repository or `false` to disable them. - */ - has_issues?: boolean; - /** - * 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. - */ - has_projects?: boolean; - /** - * Either `true` to enable the wiki for this repository or `false` to disable it. - */ - has_wiki?: boolean; - /** - * A URL with more information about the repository. - */ - homepage?: string; - /** - * Either `true` to make this repo available as a template repository or `false` to prevent it. - */ - is_template?: boolean; - /** - * 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". - */ - license_template?: string; - /** - * The name of the repository. - */ - name: string; - /** - * Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account. - */ - private?: boolean; - /** - * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. - */ - team_id?: number; - }; - export type ReposCreateForkParams = { - /** - * Optional parameter to specify the organization name if forking into an organization. - */ - organization?: string; - - owner: string; - - repo: string; - }; - export type ReposCreateHookParams = { - /** - * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - */ - active?: boolean; - /** - * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). - */ - config: ReposCreateHookParamsConfig; - /** - * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. - */ - events?: string[]; - /** - * Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. - */ - name?: string; - - owner: string; - - repo: string; - }; - export type ReposCreateInOrgParams = { - /** - * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. - */ - allow_merge_commit?: boolean; - /** - * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. - */ - allow_rebase_merge?: boolean; - /** - * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. - */ - allow_squash_merge?: boolean; - /** - * Pass `true` to create an initial commit with empty README. - */ - auto_init?: boolean; - /** - * A short description of the repository. - */ - description?: string; - /** - * 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". - */ - gitignore_template?: string; - /** - * Either `true` to enable issues for this repository or `false` to disable them. - */ - has_issues?: boolean; - /** - * 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. - */ - has_projects?: boolean; - /** - * Either `true` to enable the wiki for this repository or `false` to disable it. - */ - has_wiki?: boolean; - /** - * A URL with more information about the repository. - */ - homepage?: string; - /** - * Either `true` to make this repo available as a template repository or `false` to prevent it. - */ - is_template?: boolean; - /** - * 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". - */ - license_template?: string; - /** - * The name of the repository. - */ - name: string; - - org: string; - /** - * Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account. - */ - private?: boolean; - /** - * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. - */ - team_id?: number; - }; - export type ReposCreateOrUpdateFileParams = { - /** - * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. - */ - author?: ReposCreateOrUpdateFileParamsAuthor; - /** - * The branch name. Default: the repository’s default branch (usually `master`) - */ - branch?: string; - /** - * The person that committed the file. Default: the authenticated user. - */ - committer?: ReposCreateOrUpdateFileParamsCommitter; - /** - * The new file content, using Base64 encoding. - */ - content: string; - /** - * The commit message. - */ - message: string; - - owner: string; - - path: string; - - repo: string; - /** - * **Required if you are updating a file**. The blob SHA of the file being replaced. - */ - sha?: string; - }; - export type ReposCreateReleaseParams = { - /** - * Text describing the contents of the tag. - */ - body?: string; - /** - * `true` to create a draft (unpublished) release, `false` to create a published one. - */ - draft?: boolean; - /** - * The name of the release. - */ - name?: string; - - owner: string; - /** - * `true` to identify the release as a prerelease. `false` to identify the release as a full release. - */ - prerelease?: boolean; - - repo: string; - /** - * The name of the tag. - */ - tag_name: string; - /** - * 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`). - */ - target_commitish?: string; - }; - export type ReposCreateStatusParams = { - /** - * A string label to differentiate this status from the status of other systems. - */ - context?: string; - /** - * A short description of the status. - */ - description?: string; - - owner: string; - - repo: string; - - sha: string; - /** - * The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. - */ - state: "error" | "failure" | "pending" | "success"; - /** - * 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. - * For 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: - * `http://ci.example.com/user/repo/build/sha` - */ - target_url?: string; - }; - export type ReposCreateUsingTemplateParams = { - /** - * A short description of the new repository. - */ - description?: string; - /** - * The name of the new repository. - */ - name: string; - /** - * 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. - */ - owner?: string; - /** - * Either `true` to create a new private repository or `false` to create a new public one. - */ - private?: boolean; - - template_owner: string; - - template_repo: string; - }; - export type ReposDeclineInvitationParams = { - invitation_id: number; - }; - export type ReposDeleteParams = { - owner: string; - - repo: string; - }; - export type ReposDeleteCommitCommentParams = { - comment_id: number; - - owner: string; - - repo: string; - }; - export type ReposDeleteDownloadParams = { - download_id: number; - - owner: string; - - repo: string; - }; - export type ReposDeleteFileParams = { - /** - * object containing information about the author. - */ - author?: ReposDeleteFileParamsAuthor; - /** - * The branch name. Default: the repository’s default branch (usually `master`) - */ - branch?: string; - /** - * object containing information about the committer. - */ - committer?: ReposDeleteFileParamsCommitter; - /** - * The commit message. - */ - message: string; - - owner: string; - - path: string; - - repo: string; - /** - * The blob SHA of the file being replaced. - */ - sha: string; - }; - export type ReposDeleteHookParams = { - hook_id: number; - - owner: string; - - repo: string; - }; - export type ReposDeleteInvitationParams = { - invitation_id: number; - - owner: string; - - repo: string; - }; - export type ReposDeleteReleaseParams = { - owner: string; - - release_id: number; - - repo: string; - }; - export type ReposDeleteReleaseAssetParams = { - asset_id: number; - - owner: string; - - repo: string; - }; - export type ReposDisableAutomatedSecurityFixesParams = { - owner: string; - - repo: string; - }; - export type ReposDisablePagesSiteParams = { - owner: string; - - repo: string; - }; - export type ReposDisableVulnerabilityAlertsParams = { - owner: string; - - repo: string; - }; - export type ReposEnableAutomatedSecurityFixesParams = { - owner: string; - - repo: string; - }; - export type ReposEnablePagesSiteParams = { - owner: string; - - repo: string; - - source?: ReposEnablePagesSiteParamsSource; - }; - export type ReposEnableVulnerabilityAlertsParams = { - owner: string; - - repo: string; - }; - export type ReposGetParams = { - owner: string; - - repo: string; - }; - export type ReposGetAppsWithAccessToProtectedBranchParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposGetArchiveLinkParams = { - archive_format: string; - - owner: string; - - ref: string; - - repo: string; - }; - export type ReposGetBranchParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposGetBranchProtectionParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposGetClonesParams = { - owner: string; - /** - * Must be one of: `day`, `week`. - */ - per?: "day" | "week"; - - repo: string; - }; - export type ReposGetCodeFrequencyStatsParams = { - owner: string; - - repo: string; - }; - export type ReposGetCollaboratorPermissionLevelParams = { - owner: string; - - repo: string; - - username: string; - }; - export type ReposGetCombinedStatusForRefParams = { - owner: string; - - ref: string; - - repo: string; - }; - export type ReposGetCommitParamsDeprecatedSha = { - owner: string; - - repo: string; - /** - * @deprecated "sha" parameter renamed to "ref" - */ - sha: string; - }; - export type ReposGetCommitParamsDeprecatedCommitSha = { - /** - * @deprecated "commit_sha" parameter renamed to "ref" - */ - commit_sha: string; - - owner: string; - - repo: string; - }; - export type ReposGetCommitParams = { - owner: string; - - ref: string; - - repo: string; - }; - export type ReposGetCommitActivityStatsParams = { - owner: string; - - repo: string; - }; - export type ReposGetCommitCommentParams = { - comment_id: number; - - owner: string; - - repo: string; - }; - export type ReposGetCommitRefShaParams = { - owner: string; - - ref: string; - - repo: string; - }; - export type ReposGetContentsParams = { - owner: string; - - path: string; - /** - * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) - */ - ref?: string; - - repo: string; - }; - export type ReposGetContributorsStatsParams = { - owner: string; - - repo: string; - }; - export type ReposGetDeployKeyParams = { - key_id: number; - - owner: string; - - repo: string; - }; - export type ReposGetDeploymentParams = { - deployment_id: number; - - owner: string; - - repo: string; - }; - export type ReposGetDeploymentStatusParams = { - deployment_id: number; - - owner: string; - - repo: string; - - status_id: number; - }; - export type ReposGetDownloadParams = { - download_id: number; - - owner: string; - - repo: string; - }; - export type ReposGetHookParams = { - hook_id: number; - - owner: string; - - repo: string; - }; - export type ReposGetLatestPagesBuildParams = { - owner: string; - - repo: string; - }; - export type ReposGetLatestReleaseParams = { - owner: string; - - repo: string; - }; - export type ReposGetPagesParams = { - owner: string; - - repo: string; - }; - export type ReposGetPagesBuildParams = { - build_id: number; - - owner: string; - - repo: string; - }; - export type ReposGetParticipationStatsParams = { - owner: string; - - repo: string; - }; - export type ReposGetProtectedBranchAdminEnforcementParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposGetProtectedBranchPullRequestReviewEnforcementParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposGetProtectedBranchRequiredSignaturesParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposGetProtectedBranchRequiredStatusChecksParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposGetProtectedBranchRestrictionsParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposGetPunchCardStatsParams = { - owner: string; - - repo: string; - }; - export type ReposGetReadmeParams = { - owner: string; - /** - * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) - */ - ref?: string; - - repo: string; - }; - export type ReposGetReleaseParams = { - owner: string; - - release_id: number; - - repo: string; - }; - export type ReposGetReleaseAssetParams = { - asset_id: number; - - owner: string; - - repo: string; - }; - export type ReposGetReleaseByTagParams = { - owner: string; - - repo: string; - - tag: string; - }; - export type ReposGetTeamsWithAccessToProtectedBranchParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposGetTopPathsParams = { - owner: string; - - repo: string; - }; - export type ReposGetTopReferrersParams = { - owner: string; - - repo: string; - }; - export type ReposGetUsersWithAccessToProtectedBranchParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposGetViewsParams = { - owner: string; - /** - * Must be one of: `day`, `week`. - */ - per?: "day" | "week"; - - repo: string; - }; - export type ReposListParams = { - /** - * Comma-separated list of values. Can include: - * \* `owner`: Repositories that are owned by the authenticated user. - * \* `collaborator`: Repositories that the user has been added to as a collaborator. - * \* `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. - */ - affiliation?: string; - /** - * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` - */ - direction?: "asc" | "desc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Can be one of `created`, `updated`, `pushed`, `full_name`. - */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** - * Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` - * - * Will 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**. - */ - type?: "all" | "owner" | "public" | "private" | "member"; - /** - * Can be one of `all`, `public`, or `private`. - */ - visibility?: "all" | "public" | "private"; - }; - export type ReposListAppsWithAccessToProtectedBranchParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposListAssetsForReleaseParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - release_id: number; - - repo: string; - }; - export type ReposListBranchesParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. - */ - protected?: boolean; - - repo: string; - }; - export type ReposListBranchesForHeadCommitParams = { - commit_sha: string; - - owner: string; - - repo: string; - }; - export type ReposListCollaboratorsParams = { - /** - * Filter collaborators returned by their affiliation. Can be one of: - * \* `outside`: All outside collaborators of an organization-owned repository. - * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. - * \* `all`: All collaborators the authenticated user can see. - */ - affiliation?: "outside" | "direct" | "all"; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListCommentsForCommitParamsDeprecatedRef = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * @deprecated "ref" parameter renamed to "commit_sha" - */ - ref: string; - - repo: string; - }; - export type ReposListCommentsForCommitParams = { - commit_sha: string; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListCommitCommentsParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListCommitsParams = { - /** - * GitHub login or email address by which to filter by commit author. - */ - author?: string; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Only commits containing this file path will be returned. - */ - path?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - /** - * SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). - */ - sha?: string; - /** - * 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`. - */ - since?: string; - /** - * 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`. - */ - until?: string; - }; - export type ReposListContributorsParams = { - /** - * Set to `1` or `true` to include anonymous contributors in results. - */ - anon?: string; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListDeployKeysParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListDeploymentStatusesParams = { - deployment_id: number; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListDeploymentsParams = { - /** - * The name of the environment that was deployed to (e.g., `staging` or `production`). - */ - environment?: string; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * The name of the ref. This can be a branch, tag, or SHA. - */ - ref?: string; - - repo: string; - /** - * The SHA recorded at creation time. - */ - sha?: string; - /** - * The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). - */ - task?: string; - }; - export type ReposListDownloadsParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListForOrgParams = { - /** - * Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` - */ - direction?: "asc" | "desc"; - - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Can be one of `created`, `updated`, `pushed`, `full_name`. - */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** - * Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`. - */ - type?: "all" | "public" | "private" | "forks" | "sources" | "member"; - }; - export type ReposListForUserParams = { - /** - * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` - */ - direction?: "asc" | "desc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Can be one of `created`, `updated`, `pushed`, `full_name`. - */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** - * Can be one of `all`, `owner`, `member`. - */ - type?: "all" | "owner" | "member"; - - username: string; - }; - export type ReposListForksParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - /** - * The sort order. Can be either `newest`, `oldest`, or `stargazers`. - */ - sort?: "newest" | "oldest" | "stargazers"; - }; - export type ReposListHooksParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListInvitationsParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListInvitationsForAuthenticatedUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type ReposListLanguagesParams = { - owner: string; - - repo: string; - }; - export type ReposListPagesBuildsParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListProtectedBranchRequiredStatusChecksContextsParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposListProtectedBranchTeamRestrictionsParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposListProtectedBranchUserRestrictionsParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposListPublicParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * The integer ID of the last Repository that you've seen. - */ - since?: string; - }; - export type ReposListPullRequestsAssociatedWithCommitParams = { - commit_sha: string; - - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListReleasesParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListStatusesForRefParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - ref: string; - - repo: string; - }; - export type ReposListTagsParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListTeamsParams = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - repo: string; - }; - export type ReposListTeamsWithAccessToProtectedBranchParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposListTopicsParams = { - owner: string; - - repo: string; - }; - export type ReposListUsersWithAccessToProtectedBranchParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposMergeParams = { - /** - * The name of the base branch that the head will be merged into. - */ - base: string; - /** - * Commit message to use for the merge commit. If omitted, a default message will be used. - */ - commit_message?: string; - /** - * The head to merge. This can be a branch name or a commit SHA1. - */ - head: string; - - owner: string; - - repo: string; - }; - export type ReposPingHookParams = { - hook_id: number; - - owner: string; - - repo: string; - }; - export type ReposRemoveBranchProtectionParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposRemoveCollaboratorParams = { - owner: string; - - repo: string; - - username: string; - }; - export type ReposRemoveDeployKeyParams = { - key_id: number; - - owner: string; - - repo: string; - }; - export type ReposRemoveProtectedBranchAdminEnforcementParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposRemoveProtectedBranchAppRestrictionsParams = { - apps: string[]; - - branch: string; - - owner: string; - - repo: string; - }; - export type ReposRemoveProtectedBranchPullRequestReviewEnforcementParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposRemoveProtectedBranchRequiredSignaturesParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposRemoveProtectedBranchRequiredStatusChecksParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposRemoveProtectedBranchRequiredStatusChecksContextsParams = { - branch: string; - - contexts: string[]; - - owner: string; - - repo: string; - }; - export type ReposRemoveProtectedBranchRestrictionsParams = { - branch: string; - - owner: string; - - repo: string; - }; - export type ReposRemoveProtectedBranchTeamRestrictionsParams = { - branch: string; - - owner: string; - - repo: string; - - teams: string[]; - }; - export type ReposRemoveProtectedBranchUserRestrictionsParams = { - branch: string; - - owner: string; - - repo: string; - - users: string[]; - }; - export type ReposReplaceProtectedBranchAppRestrictionsParams = { - apps: string[]; - - branch: string; - - owner: string; - - repo: string; - }; - export type ReposReplaceProtectedBranchRequiredStatusChecksContextsParams = { - branch: string; - - contexts: string[]; - - owner: string; - - repo: string; - }; - export type ReposReplaceProtectedBranchTeamRestrictionsParams = { - branch: string; - - owner: string; - - repo: string; - - teams: string[]; - }; - export type ReposReplaceProtectedBranchUserRestrictionsParams = { - branch: string; - - owner: string; - - repo: string; - - users: string[]; - }; - export type ReposReplaceTopicsParams = { - /** - * 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. - */ - names: string[]; - - owner: string; - - repo: string; - }; - export type ReposRequestPageBuildParams = { - owner: string; - - repo: string; - }; - export type ReposRetrieveCommunityProfileMetricsParams = { - owner: string; - - repo: string; - }; - export type ReposTestPushHookParams = { - hook_id: number; - - owner: string; - - repo: string; - }; - export type ReposTransferParams = { - /** - * **Required:** The username or organization name the repository will be transferred to. - */ - new_owner?: string; - - owner: string; - - repo: string; - /** - * ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. - */ - team_ids?: number[]; - }; - export type ReposUpdateParams = { - /** - * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. - */ - allow_merge_commit?: boolean; - /** - * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. - */ - allow_rebase_merge?: boolean; - /** - * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. - */ - allow_squash_merge?: boolean; - /** - * `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. - */ - archived?: boolean; - /** - * Updates the default branch for this repository. - */ - default_branch?: string; - /** - * A short description of the repository. - */ - description?: string; - /** - * Either `true` to enable issues for this repository or `false` to disable them. - */ - has_issues?: boolean; - /** - * 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. - */ - has_projects?: boolean; - /** - * Either `true` to enable the wiki for this repository or `false` to disable it. - */ - has_wiki?: boolean; - /** - * A URL with more information about the repository. - */ - homepage?: string; - /** - * Either `true` to make this repo available as a template repository or `false` to prevent it. - */ - is_template?: boolean; - /** - * The name of the repository. - */ - name?: string; - - owner: string; - /** - * Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. - * **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. - */ - private?: boolean; - - repo: string; - }; - export type ReposUpdateBranchProtectionParams = { - branch: string; - /** - * Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. - */ - enforce_admins: boolean | null; - - owner: string; - - repo: string; - /** - * Require at least one approving review on a pull request, before merging. Set to `null` to disable. - */ - required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null; - /** - * Require status checks to pass before merging. Set to `null` to disable. - */ - required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null; - /** - * Restrict who can push to this branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. - */ - restrictions: ReposUpdateBranchProtectionParamsRestrictions | null; - }; - export type ReposUpdateCommitCommentParams = { - /** - * The contents of the comment - */ - body: string; - - comment_id: number; - - owner: string; - - repo: string; - }; - export type ReposUpdateFileParams = { - /** - * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. - */ - author?: ReposUpdateFileParamsAuthor; - /** - * The branch name. Default: the repository’s default branch (usually `master`) - */ - branch?: string; - /** - * The person that committed the file. Default: the authenticated user. - */ - committer?: ReposUpdateFileParamsCommitter; - /** - * The new file content, using Base64 encoding. - */ - content: string; - /** - * The commit message. - */ - message: string; - - owner: string; - - path: string; - - repo: string; - /** - * **Required if you are updating a file**. The blob SHA of the file being replaced. - */ - sha?: string; - }; - export type ReposUpdateHookParams = { - /** - * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - */ - active?: boolean; - /** - * Determines a list of events to be added to the list of events that the Hook triggers for. - */ - add_events?: string[]; - /** - * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). - */ - config?: ReposUpdateHookParamsConfig; - /** - * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events. - */ - events?: string[]; - - hook_id: number; - - owner: string; - /** - * Determines a list of events to be removed from the list of events that the Hook triggers for. - */ - remove_events?: string[]; - - repo: string; - }; - export type ReposUpdateInformationAboutPagesSiteParams = { - /** - * 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/)." - */ - cname?: string; - - owner: string; - - repo: string; - /** - * 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"`. - */ - source?: '"gh-pages"' | '"master"' | '"master /docs"'; - }; - export type ReposUpdateInvitationParams = { - invitation_id: number; - - owner: string; - /** - * The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`. - */ - permissions?: "read" | "write" | "admin"; - - repo: string; - }; - export type ReposUpdateProtectedBranchPullRequestReviewEnforcementParams = { - branch: string; - /** - * Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. - */ - dismiss_stale_reviews?: boolean; - /** - * 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. - */ - dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions; - - owner: string; - - repo: string; - /** - * Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed. - */ - require_code_owner_reviews?: boolean; - /** - * Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6. - */ - required_approving_review_count?: number; - }; - export type ReposUpdateProtectedBranchRequiredStatusChecksParams = { - branch: string; - /** - * The list of status checks to require in order to merge into this branch - */ - contexts?: string[]; - - owner: string; - - repo: string; - /** - * Require branches to be up to date before merging. - */ - strict?: boolean; - }; - export type ReposUpdateReleaseParams = { - /** - * Text describing the contents of the tag. - */ - body?: string; - /** - * `true` makes the release a draft, and `false` publishes the release. - */ - draft?: boolean; - /** - * The name of the release. - */ - name?: string; - - owner: string; - /** - * `true` to identify the release as a prerelease, `false` to identify the release as a full release. - */ - prerelease?: boolean; - - release_id: number; - - repo: string; - /** - * The name of the tag. - */ - tag_name?: string; - /** - * 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`). - */ - target_commitish?: string; - }; - export type ReposUpdateReleaseAssetParams = { - asset_id: number; - /** - * An alternate short description of the asset. Used in place of the filename. - */ - label?: string; - /** - * The file name of the asset. - */ - name?: string; - - owner: string; - - repo: string; - }; - export type ReposUploadReleaseAssetParams = { - file: string | object; - - headers: ReposUploadReleaseAssetParamsHeaders; - /** - * An alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter. - */ - label?: string; - /** - * The file name of the asset. This should be set in a URI query parameter. - */ - name: string; - /** - * The `upload_url` key returned from creating or getting a release - */ - url: string; - }; - export type SearchCodeParams = { - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching code](https://help.github.com/articles/searching-code/)" for a detailed list of qualifiers. - */ - q: string; - /** - * 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) - */ - sort?: "indexed"; - }; - export type SearchCommitsParams = { - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching commits](https://help.github.com/articles/searching-commits/)" for a detailed list of qualifiers. - */ - q: string; - /** - * Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) - */ - sort?: "author-date" | "committer-date"; - }; - export type SearchIssuesParams = { - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. - */ - q: string; - /** - * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) - */ - sort?: - | "comments" - | "reactions" - | "reactions-+1" - | "reactions--1" - | "reactions-smile" - | "reactions-thinking_face" - | "reactions-heart" - | "reactions-tada" - | "interactions" - | "created" - | "updated"; - }; - export type SearchIssuesAndPullRequestsParams = { - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. - */ - q: string; - /** - * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) - */ - sort?: - | "comments" - | "reactions" - | "reactions-+1" - | "reactions--1" - | "reactions-smile" - | "reactions-thinking_face" - | "reactions-heart" - | "reactions-tada" - | "interactions" - | "created" - | "updated"; - }; - export type SearchLabelsParams = { - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * 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). - */ - q: string; - /** - * The id of the repository. - */ - repository_id: number; - /** - * 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) - */ - sort?: "created" | "updated"; - }; - export type SearchReposParams = { - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. - */ - q: string; - /** - * 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) - */ - sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; - }; - export type SearchTopicsParams = { - /** - * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). - */ - q: string; - }; - export type SearchUsersParams = { - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching users](https://help.github.com/articles/searching-users/)" for a detailed list of qualifiers. - */ - q: string; - /** - * 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) - */ - sort?: "followers" | "repositories" | "joined"; - }; - export type TeamsAddMemberParams = { - team_id: number; - - username: string; - }; - export type TeamsAddOrUpdateMembershipParams = { - /** - * The role that this user should have in the team. Can be one of: - * \* `member` - a normal member of the team. - * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. - */ - role?: "member" | "maintainer"; - - team_id: number; - - username: string; - }; - export type TeamsAddOrUpdateProjectParams = { - /** - * The permission to grant to the team for this project. Can be one of: - * \* `read` - team members can read, but not write to or administer this project. - * \* `write` - team members can read and write, but not administer this project. - * \* `admin` - team members can read, write and administer this project. - * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team. - */ - permission?: "read" | "write" | "admin"; - - project_id: number; - - team_id: number; - }; - export type TeamsAddOrUpdateRepoParams = { - owner: string; - /** - * The permission to grant the team on this repository. Can be one of: - * \* `pull` - team members can pull, but not push to or administer this repository. - * \* `push` - team members can pull and push, but not administer this repository. - * \* `admin` - team members can pull, push and administer this repository. - * - * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team. - */ - permission?: "pull" | "push" | "admin"; - - repo: string; - - team_id: number; - }; - export type TeamsCheckManagesRepoParams = { - owner: string; - - repo: string; - - team_id: number; - }; - export type TeamsCreateParamsDeprecatedPermission = { - /** - * The description of the team. - */ - description?: string; - /** - * The logins of organization members to add as maintainers of the team. - */ - maintainers?: string[]; - /** - * The name of the team. - */ - name: string; - - org: string; - /** - * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. - */ - parent_team_id?: number; - /** - * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: - * \* `pull` - team members can pull, but not push to or administer newly-added repositories. - * \* `push` - team members can pull and push, but not administer newly-added repositories. - * \* `admin` - team members can pull, push and administer newly-added repositories. - * @deprecated "permission" parameter has been deprecated and will be removed in future - */ - permission?: string; - /** - * The level of privacy this team should have. The options are: - * **For a non-nested team:** - * \* `secret` - only visible to organization owners and members of this team. - * \* `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * \* `closed` - visible to all members of this organization. - * Default for child team: `closed` - * **Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams. - */ - privacy?: "secret" | "closed"; - /** - * The full name (e.g., "organization-name/repository-name") of repositories to add the team to. - */ - repo_names?: string[]; - }; - export type TeamsCreateParams = { - /** - * The description of the team. - */ - description?: string; - /** - * The logins of organization members to add as maintainers of the team. - */ - maintainers?: string[]; - /** - * The name of the team. - */ - name: string; - - org: string; - /** - * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. - */ - parent_team_id?: number; - /** - * The level of privacy this team should have. The options are: - * **For a non-nested team:** - * \* `secret` - only visible to organization owners and members of this team. - * \* `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * \* `closed` - visible to all members of this organization. - * Default for child team: `closed` - * **Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams. - */ - privacy?: "secret" | "closed"; - /** - * The full name (e.g., "organization-name/repository-name") of repositories to add the team to. - */ - repo_names?: string[]; - }; - export type TeamsCreateDiscussionParams = { - /** - * The discussion post's body text. - */ - body: string; - /** - * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - */ - private?: boolean; - - team_id: number; - /** - * The discussion post's title. - */ - title: string; - }; - export type TeamsCreateDiscussionCommentParams = { - /** - * The discussion comment's body text. - */ - body: string; - - discussion_number: number; - - team_id: number; - }; - export type TeamsDeleteParams = { - team_id: number; - }; - export type TeamsDeleteDiscussionParams = { - discussion_number: number; - - team_id: number; - }; - export type TeamsDeleteDiscussionCommentParams = { - comment_number: number; - - discussion_number: number; - - team_id: number; - }; - export type TeamsGetParams = { - team_id: number; - }; - export type TeamsGetByNameParams = { - org: string; - - team_slug: string; - }; - export type TeamsGetDiscussionParams = { - discussion_number: number; - - team_id: number; - }; - export type TeamsGetDiscussionCommentParams = { - comment_number: number; - - discussion_number: number; - - team_id: number; - }; - export type TeamsGetMemberParams = { - team_id: number; - - username: string; - }; - export type TeamsGetMembershipParams = { - team_id: number; - - username: string; - }; - export type TeamsListParams = { - org: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type TeamsListChildParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - team_id: number; - }; - export type TeamsListDiscussionCommentsParams = { - /** - * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. - */ - direction?: "asc" | "desc"; - - discussion_number: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - team_id: number; - }; - export type TeamsListDiscussionsParams = { - /** - * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - team_id: number; - }; - export type TeamsListForAuthenticatedUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type TeamsListMembersParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Filters members returned by their role in the team. Can be one of: - * \* `member` - normal members of the team. - * \* `maintainer` - team maintainers. - * \* `all` - all members of the team. - */ - role?: "member" | "maintainer" | "all"; - - team_id: number; - }; - export type TeamsListPendingInvitationsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - team_id: number; - }; - export type TeamsListProjectsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - team_id: number; - }; - export type TeamsListReposParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - team_id: number; - }; - export type TeamsRemoveMemberParams = { - team_id: number; - - username: string; - }; - export type TeamsRemoveMembershipParams = { - team_id: number; - - username: string; - }; - export type TeamsRemoveProjectParams = { - project_id: number; - - team_id: number; - }; - export type TeamsRemoveRepoParams = { - owner: string; - - repo: string; - - team_id: number; - }; - export type TeamsReviewProjectParams = { - project_id: number; - - team_id: number; - }; - export type TeamsUpdateParamsDeprecatedPermission = { - /** - * The description of the team. - */ - description?: string; - /** - * The name of the team. - */ - name: string; - /** - * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. - */ - parent_team_id?: number; - /** - * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: - * \* `pull` - team members can pull, but not push to or administer newly-added repositories. - * \* `push` - team members can pull and push, but not administer newly-added repositories. - * \* `admin` - team members can pull, push and administer newly-added repositories. - * @deprecated "permission" parameter has been deprecated and will be removed in future - */ - permission?: string; - /** - * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * \* `secret` - only visible to organization owners and members of this team. - * \* `closed` - visible to all members of this organization. - * **For a parent or child team:** - * \* `closed` - visible to all members of this organization. - */ - privacy?: "secret" | "closed"; - - team_id: number; - }; - export type TeamsUpdateParams = { - /** - * The description of the team. - */ - description?: string; - /** - * The name of the team. - */ - name: string; - /** - * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. - */ - parent_team_id?: number; - /** - * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * \* `secret` - only visible to organization owners and members of this team. - * \* `closed` - visible to all members of this organization. - * **For a parent or child team:** - * \* `closed` - visible to all members of this organization. - */ - privacy?: "secret" | "closed"; - - team_id: number; - }; - export type TeamsUpdateDiscussionParams = { - /** - * The discussion post's body text. - */ - body?: string; - - discussion_number: number; - - team_id: number; - /** - * The discussion post's title. - */ - title?: string; - }; - export type TeamsUpdateDiscussionCommentParams = { - /** - * The discussion comment's body text. - */ - body: string; - - comment_number: number; - - discussion_number: number; - - team_id: number; - }; - export type UsersAddEmailsParams = { - /** - * Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. - */ - emails: string[]; - }; - export type UsersBlockParams = { - username: string; - }; - export type UsersCheckBlockedParams = { - username: string; - }; - export type UsersCheckFollowingParams = { - username: string; - }; - export type UsersCheckFollowingForUserParams = { - target_user: string; - - username: string; - }; - export type UsersCreateGpgKeyParams = { - /** - * 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. - */ - armored_public_key?: string; - }; - export type UsersCreatePublicKeyParams = { - /** - * 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. - */ - key?: string; - /** - * 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". - */ - title?: string; - }; - export type UsersDeleteEmailsParams = { - /** - * 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. - */ - emails: string[]; - }; - export type UsersDeleteGpgKeyParams = { - gpg_key_id: number; - }; - export type UsersDeletePublicKeyParams = { - key_id: number; - }; - export type UsersFollowParams = { - username: string; - }; - export type UsersGetByUsernameParams = { - username: string; - }; - export type UsersGetContextForUserParams = { - /** - * Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. - */ - subject_id?: string; - /** - * 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`. - */ - subject_type?: "organization" | "repository" | "issue" | "pull_request"; - - username: string; - }; - export type UsersGetGpgKeyParams = { - gpg_key_id: number; - }; - export type UsersGetPublicKeyParams = { - key_id: number; - }; - export type UsersListParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * The integer ID of the last User that you've seen. - */ - since?: string; - }; - export type UsersListEmailsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type UsersListFollowersForAuthenticatedUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type UsersListFollowersForUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - username: string; - }; - export type UsersListFollowingForAuthenticatedUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type UsersListFollowingForUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - username: string; - }; - export type UsersListGpgKeysParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type UsersListGpgKeysForUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - username: string; - }; - export type UsersListPublicEmailsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type UsersListPublicKeysParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - }; - export type UsersListPublicKeysForUserParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - - username: string; - }; - export type UsersTogglePrimaryEmailVisibilityParams = { - /** - * Specify the _primary_ email address that needs a visibility change. - */ - email: string; - /** - * 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. - */ - visibility: string; - }; - export type UsersUnblockParams = { - username: string; - }; - export type UsersUnfollowParams = { - username: string; - }; - export type UsersUpdateAuthenticatedParams = { - /** - * The new short biography of the user. - */ - bio?: string; - /** - * The new blog URL of the user. - */ - blog?: string; - /** - * The new company of the user. - */ - company?: string; - /** - * The publicly visible email address of the user. - */ - email?: string; - /** - * The new hiring availability of the user. - */ - hireable?: boolean; - /** - * The new location of the user. - */ - location?: string; - /** - * The new name of the user. - */ - name?: string; - }; - - // child param types - export type AppsCreateInstallationTokenParamsPermissions = {}; - export type ChecksCreateParamsActions = { - description: string; - identifier: string; - label: string; - }; - export type ChecksCreateParamsOutput = { - annotations?: ChecksCreateParamsOutputAnnotations[]; - images?: ChecksCreateParamsOutputImages[]; - summary: string; - text?: string; - title: string; - }; - export type ChecksCreateParamsOutputAnnotations = { - annotation_level: "notice" | "warning" | "failure"; - end_column?: number; - end_line: number; - message: string; - path: string; - raw_details?: string; - start_column?: number; - start_line: number; - title?: string; - }; - export type ChecksCreateParamsOutputImages = { - alt: string; - caption?: string; - image_url: string; - }; - export type ChecksSetSuitesPreferencesParamsAutoTriggerChecks = { - app_id: number; - setting: boolean; - }; - export type ChecksUpdateParamsActions = { - description: string; - identifier: string; - label: string; - }; - export type ChecksUpdateParamsOutput = { - annotations?: ChecksUpdateParamsOutputAnnotations[]; - images?: ChecksUpdateParamsOutputImages[]; - summary: string; - text?: string; - title?: string; - }; - export type ChecksUpdateParamsOutputAnnotations = { - annotation_level: "notice" | "warning" | "failure"; - end_column?: number; - end_line: number; - message: string; - path: string; - raw_details?: string; - start_column?: number; - start_line: number; - title?: string; - }; - export type ChecksUpdateParamsOutputImages = { - alt: string; - caption?: string; - image_url: string; - }; - export type GistsCreateParamsFiles = { - content?: string; - }; - export type GistsUpdateParamsFiles = { - content?: string; - filename?: string; - }; - export type GitCreateCommitParamsAuthor = { - date?: string; - email?: string; - name?: string; - }; - export type GitCreateCommitParamsCommitter = { - date?: string; - email?: string; - name?: string; - }; - export type GitCreateTagParamsTagger = { - date?: string; - email?: string; - name?: string; - }; - export type GitCreateTreeParamsTree = { - content?: string; - mode?: "100644" | "100755" | "040000" | "160000" | "120000"; - path?: string; - sha?: string; - type?: "blob" | "tree" | "commit"; - }; - export type OrgsCreateHookParamsConfig = { - content_type?: string; - insecure_ssl?: string; - secret?: string; - url: string; - }; - export type OrgsUpdateHookParamsConfig = { - content_type?: string; - insecure_ssl?: string; - secret?: string; - url: string; - }; - export type PullsCreateReviewParamsComments = { - body: string; - path: string; - position: number; - }; - export type ReposCreateDispatchEventParamsClientPayload = {}; - export type ReposCreateFileParamsAuthor = { - email: string; - name: string; - }; - export type ReposCreateFileParamsCommitter = { - email: string; - name: string; - }; - export type ReposCreateHookParamsConfig = { - content_type?: string; - insecure_ssl?: string; - secret?: string; - url: string; - }; - export type ReposCreateOrUpdateFileParamsAuthor = { - email: string; - name: string; - }; - export type ReposCreateOrUpdateFileParamsCommitter = { - email: string; - name: string; - }; - export type ReposDeleteFileParamsAuthor = { - email?: string; - name?: string; - }; - export type ReposDeleteFileParamsCommitter = { - email?: string; - name?: string; - }; - export type ReposEnablePagesSiteParamsSource = { - branch?: "master" | "gh-pages"; - path?: string; - }; - export type ReposUpdateBranchProtectionParamsRequiredPullRequestReviews = { - dismiss_stale_reviews?: boolean; - dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions; - require_code_owner_reviews?: boolean; - required_approving_review_count?: number; - }; - export type ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions = { - teams?: string[]; - users?: string[]; - }; - export type ReposUpdateBranchProtectionParamsRequiredStatusChecks = { - contexts: string[]; - strict: boolean; - }; - export type ReposUpdateBranchProtectionParamsRestrictions = { - apps?: string[]; - teams: string[]; - users: string[]; - }; - export type ReposUpdateFileParamsAuthor = { - email: string; - name: string; - }; - export type ReposUpdateFileParamsCommitter = { - email: string; - name: string; - }; - export type ReposUpdateHookParamsConfig = { - content_type?: string; - insecure_ssl?: string; - secret?: string; - url: string; - }; - export type ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions = { - teams?: string[]; - users?: string[]; - }; - export type ReposUploadReleaseAssetParamsHeaders = { - "content-length": number; - "content-type": string; - }; -} - -declare class Octokit { - constructor(options?: Octokit.Options); - authenticate(auth: Octokit.AuthBasic): void; - authenticate(auth: Octokit.AuthOAuthToken): void; - authenticate(auth: Octokit.AuthOAuthSecret): void; - authenticate(auth: Octokit.AuthUserToken): void; - authenticate(auth: Octokit.AuthJWT): void; - - hook: { - before( - name: string, - callback: (options: Octokit.HookOptions) => void - ): void; - after( - name: string, - callback: ( - response: Octokit.Response, - options: Octokit.HookOptions - ) => void - ): void; - error( - name: string, - callback: (error: Octokit.HookError, options: Octokit.HookOptions) => void - ): void; - wrap( - name: string, - callback: ( - request: ( - options: Octokit.HookOptions - ) => Promise>, - options: Octokit.HookOptions - ) => void - ): void; - }; - - static plugin(plugin: Octokit.Plugin | Octokit.Plugin[]): Octokit.Static; - - registerEndpoints(endpoints: { - [scope: string]: Octokit.EndpointOptions; - }): void; - - request: Octokit.Request; - - paginate: Octokit.Paginate; - - log: Octokit.Log; - - activity: { - /** - * Requires for the user to be authenticated. - */ - checkStarringRepo: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityCheckStarringRepoParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://developer.github.com/v3/activity/watching/#set-a-repository-subscription). - */ - deleteRepoSubscription: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityDeleteRepoSubscriptionParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Mutes all future notifications for a conversation until you comment on the thread or get **@mention**ed. - */ - deleteThreadSubscription: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityDeleteThreadSubscriptionParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - getRepoSubscription: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityGetRepoSubscriptionParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getThread: { - ( - params?: Octokit.RequestOptions & Octokit.ActivityGetThreadParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://developer.github.com/v3/activity/watching/#get-a-repository-subscription). - * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. - */ - getThreadSubscription: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityGetThreadSubscriptionParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * This is the user's organization dashboard. You must be authenticated as the user to view this. - */ - listEventsForOrg: { - ( - params?: Octokit.RequestOptions & Octokit.ActivityListEventsForOrgParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. - */ - listEventsForUser: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListEventsForUserParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: - * - * * **Timeline**: The GitHub global public timeline - * * **User**: The public timeline for any user, using [URI template](https://developer.github.com/v3/#hypermedia) - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. - * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://developer.github.com/v3/#basic-authentication) since current feed URIs use the older, non revocable auth tokens. - */ - listFeeds: { - (params?: Octokit.RequestOptions & Octokit.EmptyParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * List all notifications for the current user, sorted by most recently updated. - * - * The following example uses the `since` parameter to list notifications that have been updated after the specified time. - */ - listNotifications: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListNotificationsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * List all notifications for the current user. - */ - listNotificationsForRepo: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListNotificationsForRepoParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. - */ - listPublicEvents: { - ( - params?: Octokit.RequestOptions & Octokit.ActivityListPublicEventsParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - listPublicEventsForOrg: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListPublicEventsForOrgParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - listPublicEventsForRepoNetwork: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListPublicEventsForRepoNetworkParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - listPublicEventsForUser: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListPublicEventsForUserParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. - */ - listReceivedEventsForUser: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListReceivedEventsForUserParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - listReceivedPublicEventsForUser: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListReceivedPublicEventsForUserParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - listRepoEvents: { - ( - params?: Octokit.RequestOptions & Octokit.ActivityListRepoEventsParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header: - */ - listReposStarredByAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListReposStarredByAuthenticatedUserParams - ): Promise< - Octokit.Response< - Octokit.ActivityListReposStarredByAuthenticatedUserResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header: - */ - listReposStarredByUser: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListReposStarredByUserParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - listReposWatchedByUser: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListReposWatchedByUserParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header: - */ - listStargazersForRepo: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListStargazersForRepoParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - listWatchedReposForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListWatchedReposForAuthenticatedUserParams - ): Promise< - Octokit.Response< - Octokit.ActivityListWatchedReposForAuthenticatedUserResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - - listWatchersForRepo: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityListWatchersForRepoParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Marks a notification as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List your notifications](https://developer.github.com/v3/activity/notifications/#list-your-notifications) endpoint and pass the query parameter `all=false`. - */ - markAsRead: { - ( - params?: Octokit.RequestOptions & Octokit.ActivityMarkAsReadParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List your notifications in a repository](https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository) endpoint and pass the query parameter `all=false`. - */ - markNotificationsAsReadForRepo: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivityMarkNotificationsAsReadForRepoParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - markThreadAsRead: { - ( - params?: Octokit.RequestOptions & Octokit.ActivityMarkThreadAsReadParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription) completely. - */ - setRepoSubscription: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivitySetRepoSubscriptionParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * This lets you subscribe or unsubscribe from a conversation. - */ - setThreadSubscription: { - ( - params?: Octokit.RequestOptions & - Octokit.ActivitySetThreadSubscriptionParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Requires for the user to be authenticated. - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - */ - starRepo: { - ( - params?: Octokit.RequestOptions & Octokit.ActivityStarRepoParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Requires for the user to be authenticated. - */ - unstarRepo: { - ( - params?: Octokit.RequestOptions & Octokit.ActivityUnstarRepoParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - }; - apps: { - /** - * Add a single repository to an installation. The authenticated user must have admin access to the repository. - * - * You must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization)) or [Basic Authentication](https://developer.github.com/v3/auth/#basic-authentication) to access this endpoint. - */ - addRepoToInstallation: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsAddRepoToInstallationParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - * - * GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint. - */ - checkAccountIsAssociatedWithAny: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsCheckAccountIsAssociatedWithAnyParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - * - * GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint. - */ - checkAccountIsAssociatedWithAnyStubbed: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsCheckAccountIsAssociatedWithAnyStubbedParams - ): Promise< - Octokit.Response< - Octokit.AppsCheckAccountIsAssociatedWithAnyStubbedResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - * @deprecated octokit.apps.checkAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization - */ - checkAuthorization: { - ( - params?: Octokit.RequestOptions & Octokit.AppsCheckAuthorizationParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. - */ - checkToken: { - (params?: Octokit.RequestOptions & Octokit.AppsCheckTokenParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://developer.github.com/v3/activity/events/types/#contentreferenceevent) to create an attachment. - * - * The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://developer.github.com/apps/using-content-attachments/)" for details about content attachments. - * - * You must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - * - * This example creates a content attachment for the domain `https://errors.ai/`. - */ - createContentAttachment: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsCreateContentAttachmentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://developer.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. - */ - createFromManifest: { - ( - params?: Octokit.RequestOptions & Octokit.AppsCreateFromManifestParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. - * - * By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. - * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * - * This example grants the token "Read and write" permission to `issues` and "Read" permission to `contents`, and restricts the token's access to the repository with an `id` of 1296269. - */ - createInstallationToken: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsCreateInstallationTokenParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - */ - deleteAuthorization: { - ( - params?: Octokit.RequestOptions & Octokit.AppsDeleteAuthorizationParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Uninstalls a GitHub App on a user, organization, or business account. - * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ - deleteInstallation: { - ( - params?: Octokit.RequestOptions & Octokit.AppsDeleteInstallationParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. - */ - deleteToken: { - ( - params?: Octokit.RequestOptions & Octokit.AppsDeleteTokenParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Enables an authenticated GitHub App to find the organization's installation information. - * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * @deprecated octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() (2019-04-10) - */ - findOrgInstallation: { - ( - params?: Octokit.RequestOptions & Octokit.AppsFindOrgInstallationParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. - * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * @deprecated octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() (2019-04-10) - */ - findRepoInstallation: { - ( - params?: Octokit.RequestOptions & Octokit.AppsFindRepoInstallationParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Enables an authenticated GitHub App to find the user’s installation information. - * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * @deprecated octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() (2019-04-10) - */ - findUserInstallation: { - ( - params?: Octokit.RequestOptions & Octokit.AppsFindUserInstallationParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations](https://developer.github.com/v3/apps/#list-installations)" endpoint. - * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ - getAuthenticated: { - (params?: Octokit.RequestOptions & Octokit.EmptyParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - * - * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - */ - getBySlug: { - (params?: Octokit.RequestOptions & Octokit.AppsGetBySlugParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ - getInstallation: { - ( - params?: Octokit.RequestOptions & Octokit.AppsGetInstallationParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Enables an authenticated GitHub App to find the organization's installation information. - * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ - getOrgInstallation: { - ( - params?: Octokit.RequestOptions & Octokit.AppsGetOrgInstallationParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. - * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ - getRepoInstallation: { - ( - params?: Octokit.RequestOptions & Octokit.AppsGetRepoInstallationParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Enables an authenticated GitHub App to find the user’s installation information. - * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ - getUserInstallation: { - ( - params?: Octokit.RequestOptions & Octokit.AppsGetUserInstallationParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - * - * GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint. - */ - listAccountsUserOrOrgOnPlan: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsListAccountsUserOrOrgOnPlanParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - * - * GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint. - */ - listAccountsUserOrOrgOnPlanStubbed: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsListAccountsUserOrOrgOnPlanStubbedParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * You must use a [user-to-server OAuth access token](https://developer.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. - * - * The access the user has to each repository is included in the hash under the `permissions` key. - */ - listInstallationReposForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsListInstallationReposForAuthenticatedUserParams - ): Promise< - Octokit.Response< - Octokit.AppsListInstallationReposForAuthenticatedUserResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * - * The permissions the installation has are included under the `permissions` key. - */ - listInstallations: { - ( - params?: Octokit.RequestOptions & Octokit.AppsListInstallationsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * You must use a [user-to-server OAuth access token](https://developer.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * You can find the permissions for the installation under the `permissions` key. - */ - listInstallationsForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsListInstallationsForAuthenticatedUserParams - ): Promise< - Octokit.Response< - Octokit.AppsListInstallationsForAuthenticatedUserResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns only active subscriptions. You must use a [user-to-server OAuth access token](https://developer.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/). - */ - listMarketplacePurchasesForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsListMarketplacePurchasesForAuthenticatedUserParams - ): Promise< - Octokit.Response< - Octokit.AppsListMarketplacePurchasesForAuthenticatedUserResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns only active subscriptions. You must use a [user-to-server OAuth access token](https://developer.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/). - */ - listMarketplacePurchasesForAuthenticatedUserStubbed: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsListMarketplacePurchasesForAuthenticatedUserStubbedParams - ): Promise< - Octokit.Response< - Octokit.AppsListMarketplacePurchasesForAuthenticatedUserStubbedResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint. - */ - listPlans: { - (params?: Octokit.RequestOptions & Octokit.AppsListPlansParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint. - */ - listPlansStubbed: { - ( - params?: Octokit.RequestOptions & Octokit.AppsListPlansStubbedParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * List repositories that an installation can access. - * - * You must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - */ - listRepos: { - (params?: Octokit.RequestOptions & Octokit.AppsListReposParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Remove a single repository from an installation. The authenticated user must have admin access to the repository. - * - * You must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization)) or [Basic Authentication](https://developer.github.com/v3/auth/#basic-authentication) to access this endpoint. - */ - removeRepoFromInstallation: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsRemoveRepoFromInstallationParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - * @deprecated octokit.apps.resetAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization - */ - resetAuthorization: { - ( - params?: Octokit.RequestOptions & Octokit.AppsResetAuthorizationParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - */ - resetToken: { - (params?: Octokit.RequestOptions & Octokit.AppsResetTokenParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. - * @deprecated octokit.apps.revokeAuthorizationForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application - */ - revokeAuthorizationForApplication: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsRevokeAuthorizationForApplicationParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted. - * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under "Authorized OAuth Apps" on GitHub](https://github.com/settings/applications#authorized). - * @deprecated octokit.apps.revokeGrantForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application - */ - revokeGrantForApplication: { - ( - params?: Octokit.RequestOptions & - Octokit.AppsRevokeGrantForApplicationParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - }; - checks: { - /** - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. - */ - create: { - (params?: Octokit.RequestOptions & Octokit.ChecksCreateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * By default, check suites are automatically created when you create a [check run](https://developer.github.com/v3/checks/runs/). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Set preferences for check suites on a repository](https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository)". Your GitHub App must have the `checks:write` permission to create check suites. - */ - createSuite: { - ( - params?: Octokit.RequestOptions & Octokit.ChecksCreateSuiteParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. - */ - get: { - (params?: Octokit.RequestOptions & Octokit.ChecksGetParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. - */ - getSuite: { - (params?: Octokit.RequestOptions & Octokit.ChecksGetSuiteParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. - */ - listAnnotations: { - ( - params?: Octokit.RequestOptions & Octokit.ChecksListAnnotationsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. - */ - listForRef: { - ( - params?: Octokit.RequestOptions & Octokit.ChecksListForRefParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. - */ - listForSuite: { - ( - params?: Octokit.RequestOptions & Octokit.ChecksListForSuiteParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. - */ - listSuitesForRef: { - ( - params?: Octokit.RequestOptions & Octokit.ChecksListSuitesForRefParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://developer.github.com/v3/activity/events/types/#checksuiteevent) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. - */ - rerequestSuite: { - ( - params?: Octokit.RequestOptions & Octokit.ChecksRerequestSuiteParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Changes the default automatic flow when creating check suites. By default, the CheckSuiteEvent is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://developer.github.com/v3/checks/suites/#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. - */ - setSuitesPreferences: { - ( - params?: Octokit.RequestOptions & - Octokit.ChecksSetSuitesPreferencesParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. - */ - update: { - (params?: Octokit.RequestOptions & Octokit.ChecksUpdateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - }; - codesOfConduct: { - getConductCode: { - ( - params?: Octokit.RequestOptions & - Octokit.CodesOfConductGetConductCodeParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * This method returns the contents of the repository's code of conduct file, if one is detected. - */ - getForRepo: { - ( - params?: Octokit.RequestOptions & Octokit.CodesOfConductGetForRepoParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listConductCodes: { - (params?: Octokit.RequestOptions & Octokit.EmptyParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - }; - emojis: { - /** - * Lists all the emojis available to use on GitHub. - */ - get: { - (params?: Octokit.RequestOptions & Octokit.EmptyParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - }; - gists: { - checkIsStarred: { - ( - params?: Octokit.RequestOptions & Octokit.GistsCheckIsStarredParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Allows you to add a new gist with one or more files. - * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. - */ - create: { - (params?: Octokit.RequestOptions & Octokit.GistsCreateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - createComment: { - ( - params?: Octokit.RequestOptions & Octokit.GistsCreateCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - delete: { - (params?: Octokit.RequestOptions & Octokit.GistsDeleteParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - - deleteComment: { - ( - params?: Octokit.RequestOptions & Octokit.GistsDeleteCommentParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note**: This was previously `/gists/:gist_id/fork`. - */ - fork: { - (params?: Octokit.RequestOptions & Octokit.GistsForkParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - get: { - (params?: Octokit.RequestOptions & Octokit.GistsGetParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - getComment: { - ( - params?: Octokit.RequestOptions & Octokit.GistsGetCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getRevision: { - ( - params?: Octokit.RequestOptions & Octokit.GistsGetRevisionParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - list: { - (params?: Octokit.RequestOptions & Octokit.GistsListParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - listComments: { - ( - params?: Octokit.RequestOptions & Octokit.GistsListCommentsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listCommits: { - ( - params?: Octokit.RequestOptions & Octokit.GistsListCommitsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listForks: { - (params?: Octokit.RequestOptions & Octokit.GistsListForksParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * List all public gists sorted by most recently updated to least recently updated. - * - * Note: With [pagination](https://developer.github.com/v3/#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. - */ - listPublic: { - ( - params?: Octokit.RequestOptions & Octokit.GistsListPublicParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listPublicForUser: { - ( - params?: Octokit.RequestOptions & Octokit.GistsListPublicForUserParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * List the authenticated user's starred gists: - */ - listStarred: { - ( - params?: Octokit.RequestOptions & Octokit.GistsListStarredParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - */ - star: { - (params?: Octokit.RequestOptions & Octokit.GistsStarParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - - unstar: { - (params?: Octokit.RequestOptions & Octokit.GistsUnstarParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. - */ - update: { - (params?: Octokit.RequestOptions & Octokit.GistsUpdateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - updateComment: { - ( - params?: Octokit.RequestOptions & Octokit.GistsUpdateCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - }; - git: { - createBlob: { - (params?: Octokit.RequestOptions & Octokit.GitCreateBlobParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). - * - * In this example, the payload of the signature would be: - * - * - * - * **Signature verification object** - * - * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ - createCommit: { - ( - params?: Octokit.RequestOptions & Octokit.GitCreateCommitParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. - */ - createRef: { - (params?: Octokit.RequestOptions & Octokit.GitCreateRefParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://developer.github.com/v3/git/refs/#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://developer.github.com/v3/git/refs/#create-a-reference) the tag reference - this call would be unnecessary. - * - * **Signature verification object** - * - * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ - createTag: { - (params?: Octokit.RequestOptions & Octokit.GitCreateTagParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. - * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://developer.github.com/v3/git/commits/#create-a-commit)" and "[Update a reference](https://developer.github.com/v3/git/refs/#update-a-reference)." - */ - createTree: { - (params?: Octokit.RequestOptions & Octokit.GitCreateTreeParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * ``` - * DELETE /repos/octocat/Hello-World/git/refs/heads/feature-a - * ``` - * - * ``` - * DELETE /repos/octocat/Hello-World/git/refs/tags/v1.0 - * ``` - */ - deleteRef: { - (params?: Octokit.RequestOptions & Octokit.GitDeleteRefParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * The `content` in the response will always be Base64 encoded. - * - * _Note_: This API supports blobs up to 100 megabytes in size. - */ - getBlob: { - (params?: Octokit.RequestOptions & Octokit.GitGetBlobParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). - * - * **Signature verification object** - * - * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ - getCommit: { - (params?: Octokit.RequestOptions & Octokit.GitGetCommitParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. - * - * **Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)". - * - * To get the reference for a branch named `skunkworkz/featureA`, the endpoint route is: - */ - getRef: { - (params?: Octokit.RequestOptions & Octokit.GitGetRefParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Signature verification object** - * - * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ - getTag: { - (params?: Octokit.RequestOptions & Octokit.GitGetTagParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * 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. - */ - getTree: { - (params?: Octokit.RequestOptions & Octokit.GitGetTreeParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. - * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. - * - * **Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)". - * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. - */ - listMatchingRefs: { - ( - params?: Octokit.RequestOptions & Octokit.GitListMatchingRefsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. If there are no references to list, a `404` is returned. - */ - listRefs: { - (params?: Octokit.RequestOptions & Octokit.GitListRefsParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - - updateRef: { - (params?: Octokit.RequestOptions & Octokit.GitUpdateRefParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - }; - gitignore: { - /** - * The API also allows fetching the source of a single template. - * - * Use the raw [media type](https://developer.github.com/v3/media/) to get the raw contents. - */ - getTemplate: { - ( - params?: Octokit.RequestOptions & Octokit.GitignoreGetTemplateParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * List all templates available to pass as an option when [creating a repository](https://developer.github.com/v3/repos/#create). - */ - listTemplates: { - (params?: Octokit.RequestOptions & Octokit.EmptyParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - }; - interactions: { - /** - * Temporarily restricts interactions to certain GitHub users in any public repository in the given organization. You must be an organization owner to set these restrictions. - */ - addOrUpdateRestrictionsForOrg: { - ( - params?: Octokit.RequestOptions & - Octokit.InteractionsAddOrUpdateRestrictionsForOrgParams - ): Promise< - Octokit.Response< - Octokit.InteractionsAddOrUpdateRestrictionsForOrgResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Temporarily restricts interactions to certain GitHub users within the given repository. You must have owner or admin access to set restrictions. - */ - addOrUpdateRestrictionsForRepo: { - ( - params?: Octokit.RequestOptions & - Octokit.InteractionsAddOrUpdateRestrictionsForRepoParams - ): Promise< - Octokit.Response< - Octokit.InteractionsAddOrUpdateRestrictionsForRepoResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Shows which group of GitHub users can interact with this organization and when the restriction expires. If there are no restrictions, you will see an empty response. - */ - getRestrictionsForOrg: { - ( - params?: Octokit.RequestOptions & - Octokit.InteractionsGetRestrictionsForOrgParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Shows which group of GitHub users can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. - */ - getRestrictionsForRepo: { - ( - params?: Octokit.RequestOptions & - Octokit.InteractionsGetRestrictionsForRepoParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. - */ - removeRestrictionsForOrg: { - ( - params?: Octokit.RequestOptions & - Octokit.InteractionsRemoveRestrictionsForOrgParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. - */ - removeRestrictionsForRepo: { - ( - params?: Octokit.RequestOptions & - Octokit.InteractionsRemoveRestrictionsForRepoParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - }; - issues: { - /** - * Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. - * - * This example adds two assignees to the existing `octocat` assignee. - */ - addAssignees: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesAddAssigneesParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.IssuesAddAssigneesParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - addLabels: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesAddLabelsParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.IssuesAddLabelsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Checks if a user has permission to be assigned to an issue in this repository. - * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. - * - * Otherwise a `404` status code is returned. - */ - checkAssignee: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesCheckAssigneeParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - */ - create: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesCreateParamsDeprecatedAssignee - ): Promise>; - (params?: Octokit.RequestOptions & Octokit.IssuesCreateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - */ - createComment: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesCreateCommentParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.IssuesCreateCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - createLabel: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesCreateLabelParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - createMilestone: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesCreateMilestoneParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - deleteComment: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesDeleteCommentParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - deleteLabel: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesDeleteLabelParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - deleteMilestone: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesDeleteMilestoneParamsDeprecatedNumber - ): Promise; - ( - params?: Octokit.RequestOptions & Octokit.IssuesDeleteMilestoneParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * The API returns a [`301 Moved Permanently` status](https://developer.github.com/v3/#http-redirects) if the issue was [transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe to the [`issues`](https://developer.github.com/v3/activity/events/types/#issuesevent) webhook. - * - * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. - * - * Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. - */ - get: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesGetParamsDeprecatedNumber - ): Promise>; - (params?: Octokit.RequestOptions & Octokit.IssuesGetParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - getComment: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesGetCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getEvent: { - (params?: Octokit.RequestOptions & Octokit.IssuesGetEventParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - getLabel: { - (params?: Octokit.RequestOptions & Octokit.IssuesGetLabelParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - getMilestone: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesGetMilestoneParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.IssuesGetMilestoneParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. - * - * Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. - */ - list: { - (params?: Octokit.RequestOptions & Octokit.IssuesListParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. - */ - listAssignees: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesListAssigneesParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Issue Comments are ordered by ascending ID. - */ - listComments: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesListCommentsParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.IssuesListCommentsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * By default, Issue Comments are ordered by ascending ID. - */ - listCommentsForRepo: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesListCommentsForRepoParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listEvents: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesListEventsParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.IssuesListEventsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listEventsForRepo: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesListEventsForRepoParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listEventsForTimeline: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesListEventsForTimelineParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & - Octokit.IssuesListEventsForTimelineParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. - * - * Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. - */ - listForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesListForAuthenticatedUserParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. - * - * Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. - */ - listForOrg: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesListForOrgParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. - * - * Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. - */ - listForRepo: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesListForRepoParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listLabelsForMilestone: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesListLabelsForMilestoneParamsDeprecatedNumber - ): Promise< - Octokit.Response - >; - ( - params?: Octokit.RequestOptions & - Octokit.IssuesListLabelsForMilestoneParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - listLabelsForRepo: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesListLabelsForRepoParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listLabelsOnIssue: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesListLabelsOnIssueParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.IssuesListLabelsOnIssueParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listMilestonesForRepo: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesListMilestonesForRepoParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Users with push access can lock an issue or pull request's conversation. - * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - */ - lock: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesLockParamsDeprecatedNumber - ): Promise; - (params?: Octokit.RequestOptions & Octokit.IssuesLockParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Removes one or more assignees from an issue. - * - * This example removes two of three assignees, leaving the `octocat` assignee. - */ - removeAssignees: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesRemoveAssigneesParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.IssuesRemoveAssigneesParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. - */ - removeLabel: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesRemoveLabelParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.IssuesRemoveLabelParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - removeLabels: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesRemoveLabelsParamsDeprecatedNumber - ): Promise; - ( - params?: Octokit.RequestOptions & Octokit.IssuesRemoveLabelsParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - replaceLabels: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesReplaceLabelsParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.IssuesReplaceLabelsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Users with push access can unlock an issue's conversation. - */ - unlock: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesUnlockParamsDeprecatedNumber - ): Promise; - (params?: Octokit.RequestOptions & Octokit.IssuesUnlockParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Issue owners and users with push access can edit an issue. - */ - update: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesUpdateParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & - Octokit.IssuesUpdateParamsDeprecatedAssignee - ): Promise>; - (params?: Octokit.RequestOptions & Octokit.IssuesUpdateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - updateComment: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesUpdateCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - updateLabel: { - ( - params?: Octokit.RequestOptions & Octokit.IssuesUpdateLabelParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - updateMilestone: { - ( - params?: Octokit.RequestOptions & - Octokit.IssuesUpdateMilestoneParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.IssuesUpdateMilestoneParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - }; - licenses: { - get: { - (params?: Octokit.RequestOptions & Octokit.LicensesGetParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * This method returns the contents of the repository's license file, if one is detected. - * - * Similar to [the repository contents API](https://developer.github.com/v3/repos/contents/#get-contents), this method also supports [custom media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw license content or rendered license HTML. - */ - getForRepo: { - ( - params?: Octokit.RequestOptions & Octokit.LicensesGetForRepoParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * @deprecated octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed() (2019-03-05) - */ - list: { - (params?: Octokit.RequestOptions & Octokit.EmptyParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - listCommonlyUsed: { - (params?: Octokit.RequestOptions & Octokit.EmptyParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - }; - markdown: { - render: { - (params?: Octokit.RequestOptions & Octokit.MarkdownRenderParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. - */ - renderRaw: { - ( - params?: Octokit.RequestOptions & Octokit.MarkdownRenderRawParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - }; - meta: { - /** - * This endpoint provides a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)." - */ - get: { - (params?: Octokit.RequestOptions & Octokit.EmptyParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - }; - migrations: { - /** - * Stop an import for a repository. - */ - cancelImport: { - ( - params?: Octokit.RequestOptions & Octokit.MigrationsCancelImportParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [Get a list of user migrations](https://developer.github.com/v3/migrations/users/#get-a-list-of-user-migrations) and [Get the status of a user migration](https://developer.github.com/v3/migrations/users/#get-the-status-of-a-user-migration) endpoints, will continue to be available even after an archive is deleted. - */ - deleteArchiveForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsDeleteArchiveForAuthenticatedUserParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Deletes a previous migration archive. Migration archives are automatically deleted after seven days. - */ - deleteArchiveForOrg: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsDeleteArchiveForOrgParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: - * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. - */ - getArchiveForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsGetArchiveForAuthenticatedUserParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Fetches the URL to a migration archive. - */ - getArchiveForOrg: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsGetArchiveForOrgParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. - * - * This API method and the "Map a commit author" method allow you to provide correct Git author information. - */ - getCommitAuthors: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsGetCommitAuthorsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * View the progress of an import. - * - * **Import status** - * - * This section includes details about the possible values of the `status` field of the Import Progress response. - * - * An import that does not have errors will progress through these steps: - * - * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. - * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). - * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. - * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". - * * `complete` - the import is complete, and the repository is ready on GitHub. - * - * If there are problems, you will see one of these in the `status` field: - * - * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section. - * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://github.com/contact) for more information. - * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section. - * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://developer.github.com/v3/migrations/source_imports/#cancel-an-import) and [retry](https://developer.github.com/v3/migrations/source_imports/#start-an-import) with the correct URL. - * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section. - * - * **The project_choices field** - * - * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. - * - * **Git LFS related fields** - * - * This section includes details about Git LFS related fields that may be present in the Import Progress response. - * - * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. - * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. - * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. - * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. - */ - getImportProgress: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsGetImportProgressParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * List files larger than 100MB found during the import - */ - getLargeFiles: { - ( - params?: Octokit.RequestOptions & Octokit.MigrationsGetLargeFilesParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: - * - * * `pending` - the migration hasn't started yet. - * * `exporting` - the migration is in progress. - * * `exported` - the migration finished successfully. - * * `failed` - the migration failed. - * - * Once the migration has been `exported` you can [download the migration archive](https://developer.github.com/v3/migrations/users/#download-a-user-migration-archive). - */ - getStatusForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsGetStatusForAuthenticatedUserParams - ): Promise< - Octokit.Response< - Octokit.MigrationsGetStatusForAuthenticatedUserResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Fetches the status of a migration. - * - * The `state` of a migration can be one of the following values: - * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ - getStatusForOrg: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsGetStatusForOrgParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists all migrations a user has started. - */ - listForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsListForAuthenticatedUserParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists the most recent migrations. - */ - listForOrg: { - ( - params?: Octokit.RequestOptions & Octokit.MigrationsListForOrgParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. - */ - mapCommitAuthor: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsMapCommitAuthorParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/). - */ - setLfsPreference: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsSetLfsPreferenceParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Initiates the generation of a user migration archive. - */ - startForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsStartForAuthenticatedUserParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Initiates the generation of a migration archive. - */ - startForOrg: { - ( - params?: Octokit.RequestOptions & Octokit.MigrationsStartForOrgParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Start a source import to a GitHub repository using GitHub Importer. - */ - startImport: { - ( - params?: Octokit.RequestOptions & Octokit.MigrationsStartImportParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Unlocks a repository. You can lock repositories when you [start a user migration](https://developer.github.com/v3/migrations/users/#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://developer.github.com/v3/repos/#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. - */ - unlockRepoForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsUnlockRepoForAuthenticatedUserParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://developer.github.com/v3/repos/#delete-a-repository) when the migration is complete and you no longer need the source data. - */ - unlockRepoForOrg: { - ( - params?: Octokit.RequestOptions & - Octokit.MigrationsUnlockRepoForOrgParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted. - * - * Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. You can select the project to import by providing one of the objects in the `project_choices` array in the update request. - * - * The following example demonstrates the workflow for updating an import with "project1" as the project choice. Given a `project_choices` array like such: - * - * To restart an import, no parameters are provided in the update request. - */ - updateImport: { - ( - params?: Octokit.RequestOptions & Octokit.MigrationsUpdateImportParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - }; - oauthAuthorizations: { - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - * @deprecated octokit.apps.checkAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization - */ - checkAuthorization: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsCheckAuthorizationParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * **Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * Creates OAuth tokens using [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication)." - * - * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. - * - * You can also create tokens on GitHub from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use). - * - * Organizations that enforce SAML SSO require personal access tokens to be whitelisted. Read more about whitelisting tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). - * @deprecated octokit.oauthAuthorizations.createAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization - */ - createAuthorization: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsCreateAuthorizationParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * @deprecated octokit.oauthAuthorizations.deleteAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization - */ - deleteAuthorization: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsDeleteAuthorizationParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - * @deprecated octokit.oauthAuthorizations.deleteGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-a-grant - */ - deleteGrant: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsDeleteGrantParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * @deprecated octokit.oauthAuthorizations.getAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization - */ - getAuthorization: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsGetAuthorizationParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * @deprecated octokit.oauthAuthorizations.getGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant - */ - getGrant: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsGetGrantParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * **Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication)." - * - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * @deprecated octokit.oauthAuthorizations.getOrCreateAuthorizationForApp() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app - */ - getOrCreateAuthorizationForApp: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppParams - ): Promise< - Octokit.Response< - Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * **Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication)." - * @deprecated octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint - */ - getOrCreateAuthorizationForAppAndFingerprint: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintParams - ): Promise< - Octokit.Response< - Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * **Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication)." - * @deprecated octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint - */ - getOrCreateAuthorizationForAppFingerprint: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintParams - ): Promise< - Octokit.Response< - Octokit.OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * @deprecated octokit.oauthAuthorizations.listAuthorizations() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations - */ - listAuthorizations: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsListAuthorizationsParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. - * @deprecated octokit.oauthAuthorizations.listGrants() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-grants - */ - listGrants: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsListGrantsParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - * @deprecated octokit.apps.resetAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization - */ - resetAuthorization: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsResetAuthorizationParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. - * @deprecated octokit.apps.revokeAuthorizationForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application - */ - revokeAuthorizationForApplication: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsRevokeAuthorizationForApplicationParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted. - * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under "Authorized OAuth Apps" on GitHub](https://github.com/settings/applications#authorized). - * @deprecated octokit.apps.revokeGrantForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application - */ - revokeGrantForApplication: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsRevokeGrantForApplicationParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication)." - * - * You can only send one of these scope keys at a time. - * @deprecated octokit.oauthAuthorizations.updateAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization - */ - updateAuthorization: { - ( - params?: Octokit.RequestOptions & - Octokit.OauthAuthorizationsUpdateAuthorizationParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - }; - orgs: { - /** - * Only authenticated organization owners can add a member to the organization or update the member's role. - * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://developer.github.com/v3/orgs/members/#get-organization-membership) will be `pending` until they accept the invitation. - * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. - * - * **Rate limits** - * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. - */ - addOrUpdateMembership: { - ( - params?: Octokit.RequestOptions & - Octokit.OrgsAddOrUpdateMembershipParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - blockUser: { - (params?: Octokit.RequestOptions & Octokit.OrgsBlockUserParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * If the user is blocked: - * - * If the user is not blocked: - */ - checkBlockedUser: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsCheckBlockedUserParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Check if a user is, publicly or privately, a member of the organization. - */ - checkMembership: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsCheckMembershipParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - checkPublicMembership: { - ( - params?: Octokit.RequestOptions & - Octokit.OrgsCheckPublicMembershipParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - concealMembership: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsConcealMembershipParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". - */ - convertMemberToOutsideCollaborator: { - ( - params?: Octokit.RequestOptions & - Octokit.OrgsConvertMemberToOutsideCollaboratorParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Here's how you can create a hook that posts payloads in JSON format: - */ - createHook: { - (params?: Octokit.RequestOptions & Octokit.OrgsCreateHookParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - */ - createInvitation: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsCreateInvitationParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - deleteHook: { - (params?: Octokit.RequestOptions & Octokit.OrgsDeleteHookParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). - * - * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see "[Response with GitHub plan information](https://developer.github.com/v3/orgs/#response-with-github-plan-information)." - */ - get: { - (params?: Octokit.RequestOptions & Octokit.OrgsGetParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - getHook: { - (params?: Octokit.RequestOptions & Octokit.OrgsGetHookParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * In order to get a user's membership with an organization, the authenticated user must be an organization member. - */ - getMembership: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsGetMembershipParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getMembershipForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.OrgsGetMembershipForAuthenticatedUserParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists all organizations, in the order that they were created on GitHub. - * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/v3/#link-header) to get the URL for the next page of organizations. - */ - list: { - (params?: Octokit.RequestOptions & Octokit.OrgsListParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * List the users blocked by an organization. - */ - listBlockedUsers: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsListBlockedUsersParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * List organizations for the authenticated user. - * - * **OAuth scope requirements** - * - * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. - */ - listForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.OrgsListForAuthenticatedUserParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. - * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List your organizations](https://developer.github.com/v3/orgs/#list-your-organizations) API instead. - */ - listForUser: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsListForUserParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listHooks: { - (params?: Octokit.RequestOptions & Octokit.OrgsListHooksParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. - */ - listInstallations: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsListInstallationsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. - */ - listInvitationTeams: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsListInvitationTeamsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. - */ - listMembers: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsListMembersParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listMemberships: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsListMembershipsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * List all users who are outside collaborators of an organization. - */ - listOutsideCollaborators: { - ( - params?: Octokit.RequestOptions & - Octokit.OrgsListOutsideCollaboratorsParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. - */ - listPendingInvitations: { - ( - params?: Octokit.RequestOptions & - Octokit.OrgsListPendingInvitationsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Members of an organization can choose to have their membership publicized or not. - */ - listPublicMembers: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsListPublicMembersParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook. - */ - pingHook: { - (params?: Octokit.RequestOptions & Octokit.OrgsPingHookParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * The user can publicize their own membership. (A user cannot publicize the membership for another user.) - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - */ - publicizeMembership: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsPublicizeMembershipParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. - */ - removeMember: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsRemoveMemberParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. - * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. - */ - removeMembership: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsRemoveMembershipParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Removing a user from this list will remove them from all the organization's repositories. - */ - removeOutsideCollaborator: { - ( - params?: Octokit.RequestOptions & - Octokit.OrgsRemoveOutsideCollaboratorParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - unblockUser: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsUnblockUserParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** The new `members_allowed_repository_creation_type` replaces the functionality of `members_can_create_repositories`. - * - * Setting `members_allowed_repository_creation_type` will override the value of `members_can_create_repositories` in the following ways: - * - * * Setting `members_allowed_repository_creation_type` to `all` or `private` sets `members_can_create_repositories` to `true`. - * * Setting `members_allowed_repository_creation_type` to `none` sets `members_can_create_repositories` to `false`. - * * If you omit `members_allowed_repository_creation_type`, `members_can_create_repositories` is not modified. - */ - update: { - (params?: Octokit.RequestOptions & Octokit.OrgsUpdateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - updateHook: { - (params?: Octokit.RequestOptions & Octokit.OrgsUpdateHookParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - updateMembership: { - ( - params?: Octokit.RequestOptions & Octokit.OrgsUpdateMembershipParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - }; - projects: { - /** - * Adds a collaborator to a an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ - addCollaborator: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsAddCollaboratorParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. - * - * Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. - */ - createCard: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsCreateCardParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - createColumn: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsCreateColumnParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - createForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.ProjectsCreateForAuthenticatedUserParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - createForOrg: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsCreateForOrgParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - createForRepo: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsCreateForRepoParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ - delete: { - (params?: Octokit.RequestOptions & Octokit.ProjectsDeleteParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - - deleteCard: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsDeleteCardParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - deleteColumn: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsDeleteColumnParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - get: { - (params?: Octokit.RequestOptions & Octokit.ProjectsGetParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - getCard: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsGetCardParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getColumn: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsGetColumnParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listCards: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsListCardsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ - listCollaborators: { - ( - params?: Octokit.RequestOptions & - Octokit.ProjectsListCollaboratorsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listColumns: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsListColumnsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - * - * s - */ - listForOrg: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsListForOrgParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - listForRepo: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsListForRepoParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listForUser: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsListForUserParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - moveCard: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsMoveCardParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - moveColumn: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsMoveColumnParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ - removeCollaborator: { - ( - params?: Octokit.RequestOptions & - Octokit.ProjectsRemoveCollaboratorParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ - reviewUserPermissionLevel: { - ( - params?: Octokit.RequestOptions & - Octokit.ProjectsReviewUserPermissionLevelParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - update: { - (params?: Octokit.RequestOptions & Octokit.ProjectsUpdateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - updateCard: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsUpdateCardParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - updateColumn: { - ( - params?: Octokit.RequestOptions & Octokit.ProjectsUpdateColumnParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - }; - pulls: { - checkIfMerged: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsCheckIfMergedParamsDeprecatedNumber - ): Promise; - ( - params?: Octokit.RequestOptions & Octokit.PullsCheckIfMergedParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. - * - * You can create a new pull request. - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - */ - create: { - (params?: Octokit.RequestOptions & Octokit.PullsCreateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** Multi-line comments on pull requests are currently in public beta and subject to change. - * - * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Comments](https://developer.github.com/v3/issues/comments/#create-a-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. - * - * You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://developer.github.com/v3/pulls/comments/#multi-line-comment-summary-3). - * - * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - * - * **Multi-line comment summary** - * - * **Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details. - * - * Use the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response. - * - * If you use the `comfort-fade` preview header, your response will show: - * - * * For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`. - * * For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`. - * - * If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show: - * - * * For multi-line comments, the last line of the comment range for the `position` attribute. - * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. - */ - createComment: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsCreateCommentParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & - Octokit.PullsCreateCommentParamsDeprecatedInReplyTo - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.PullsCreateCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** Multi-line comments on pull requests are currently in public beta and subject to change. - * - * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Comments](https://developer.github.com/v3/issues/comments/#create-a-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. - * - * You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://developer.github.com/v3/pulls/comments/#multi-line-comment-summary-3). - * - * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - * - * **Multi-line comment summary** - * - * **Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details. - * - * Use the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response. - * - * If you use the `comfort-fade` preview header, your response will show: - * - * * For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`. - * * For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`. - * - * If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show: - * - * * For multi-line comments, the last line of the comment range for the `position` attribute. - * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. - * @deprecated octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() (2019-09-09) - */ - createCommentReply: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsCreateCommentReplyParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & - Octokit.PullsCreateCommentReplyParamsDeprecatedInReplyTo - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.PullsCreateCommentReplyParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - createFromIssue: { - ( - params?: Octokit.RequestOptions & Octokit.PullsCreateFromIssueParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - * - * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) endpoint. - * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - */ - createReview: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsCreateReviewParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.PullsCreateReviewParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - */ - createReviewCommentReply: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsCreateReviewCommentReplyParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - */ - createReviewRequest: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsCreateReviewRequestParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.PullsCreateReviewRequestParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Deletes a review comment. - */ - deleteComment: { - ( - params?: Octokit.RequestOptions & Octokit.PullsDeleteCommentParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - deletePendingReview: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsDeletePendingReviewParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.PullsDeletePendingReviewParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - deleteReviewRequest: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsDeleteReviewRequestParamsDeprecatedNumber - ): Promise; - ( - params?: Octokit.RequestOptions & Octokit.PullsDeleteReviewRequestParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** To dismiss a pull request review on a [protected branch](https://developer.github.com/v3/repos/branches/), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. - */ - dismissReview: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsDismissReviewParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.PullsDismissReviewParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Lists details of a pull request by providing its number. - * - * When you get, [create](https://developer.github.com/v3/pulls/#create-a-pull-request), or [edit](https://developer.github.com/v3/pulls/#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)". - * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. - * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: - * - * * If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. - * - * Pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. - */ - get: { - ( - params?: Octokit.RequestOptions & Octokit.PullsGetParamsDeprecatedNumber - ): Promise>; - (params?: Octokit.RequestOptions & Octokit.PullsGetParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** Multi-line comments on pull requests are currently in public beta and subject to change. - * - * Provides details for a review comment. - * - * **Multi-line comment summary** - * - * **Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details. - * - * Use the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response. - * - * If you use the `comfort-fade` preview header, your response will show: - * - * * For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`. - * * For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`. - * - * If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show: - * - * * For multi-line comments, the last line of the comment range for the `position` attribute. - * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. - * - * The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions. - */ - getComment: { - ( - params?: Octokit.RequestOptions & Octokit.PullsGetCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getCommentsForReview: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsGetCommentsForReviewParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & - Octokit.PullsGetCommentsForReviewParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getReview: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsGetReviewParamsDeprecatedNumber - ): Promise>; - (params?: Octokit.RequestOptions & Octokit.PullsGetReviewParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - */ - list: { - (params?: Octokit.RequestOptions & Octokit.PullsListParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** Multi-line comments on pull requests are currently in public beta and subject to change. - * - * Lists review comments for a pull request. By default, review comments are in ascending order by ID. - * - * **Multi-line comment summary** - * - * **Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details. - * - * Use the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response. - * - * If you use the `comfort-fade` preview header, your response will show: - * - * * For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`. - * * For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`. - * - * If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show: - * - * * For multi-line comments, the last line of the comment range for the `position` attribute. - * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. - * - * The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions. - */ - listComments: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsListCommentsParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.PullsListCommentsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** Multi-line comments on pull requests are currently in public beta and subject to change. - * - * Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. - * - * **Multi-line comment summary** - * - * **Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details. - * - * Use the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response. - * - * If you use the `comfort-fade` preview header, your response will show: - * - * * For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`. - * * For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`. - * - * If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show: - * - * * For multi-line comments, the last line of the comment range for the `position` attribute. - * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. - * - * The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions. - */ - listCommentsForRepo: { - ( - params?: Octokit.RequestOptions & Octokit.PullsListCommentsForRepoParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [Commit List API](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository). - */ - listCommits: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsListCommitsParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.PullsListCommitsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** The response includes a maximum of 300 files. - */ - listFiles: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsListFilesParamsDeprecatedNumber - ): Promise>; - (params?: Octokit.RequestOptions & Octokit.PullsListFilesParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - listReviewRequests: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsListReviewRequestsParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.PullsListReviewRequestsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * The list of reviews returns in chronological order. - */ - listReviews: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsListReviewsParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.PullsListReviewsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - */ - merge: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsMergeParamsDeprecatedNumber - ): Promise>; - (params?: Octokit.RequestOptions & Octokit.PullsMergeParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - submitReview: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsSubmitReviewParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.PullsSubmitReviewParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. - */ - update: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsUpdateParamsDeprecatedNumber - ): Promise>; - (params?: Octokit.RequestOptions & Octokit.PullsUpdateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. - */ - updateBranch: { - ( - params?: Octokit.RequestOptions & Octokit.PullsUpdateBranchParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** Multi-line comments on pull requests are currently in public beta and subject to change. - * - * Enables you to edit a review comment. - * - * **Multi-line comment summary** - * - * **Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details. - * - * Use the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response. - * - * If you use the `comfort-fade` preview header, your response will show: - * - * * For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`. - * * For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`. - * - * If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show: - * - * * For multi-line comments, the last line of the comment range for the `position` attribute. - * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. - */ - updateComment: { - ( - params?: Octokit.RequestOptions & Octokit.PullsUpdateCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Update the review summary comment with new text. - */ - updateReview: { - ( - params?: Octokit.RequestOptions & - Octokit.PullsUpdateReviewParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.PullsUpdateReviewParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - }; - rateLimit: { - /** - * **Note:** Accessing this endpoint does not count against your REST API rate limit. - * - * **Understanding your rate limit status** - * - * The Search API has a [custom rate limit](https://developer.github.com/v3/search/#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit](https://developer.github.com/v4/guides/resource-limitations/#rate-limit) that is separate from and calculated differently than rate limits in the REST API. - * - * For these reasons, the Rate Limit API response categorizes your rate limit. Under `resources`, you'll see four objects: - * - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the [Search API](https://developer.github.com/v3/search/). - * * The `graphql` object provides your rate limit status for the [GraphQL API](https://developer.github.com/v4/). - * * The `integration_manifest` object provides your rate limit status for the [GitHub App Manifest code conversion](https://developer.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration) endpoint. - * - * For more information on the headers and values in the rate limit response, see "[Rate limiting](https://developer.github.com/v3/#rate-limiting)." - * - * The `rate` object (shown at the bottom of the response above) is deprecated. - * - * If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. - */ - get: { - (params?: Octokit.RequestOptions & Octokit.EmptyParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - }; - reactions: { - /** - * Create a reaction to a [commit comment](https://developer.github.com/v3/repos/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment. - */ - createForCommitComment: { - ( - params?: Octokit.RequestOptions & - Octokit.ReactionsCreateForCommitCommentParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Create a reaction to an [issue](https://developer.github.com/v3/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue. - */ - createForIssue: { - ( - params?: Octokit.RequestOptions & - Octokit.ReactionsCreateForIssueParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.ReactionsCreateForIssueParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Create a reaction to an [issue comment](https://developer.github.com/v3/issues/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment. - */ - createForIssueComment: { - ( - params?: Octokit.RequestOptions & - Octokit.ReactionsCreateForIssueCommentParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Create a reaction to a [pull request review comment](https://developer.github.com/v3/pulls/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment. - */ - createForPullRequestReviewComment: { - ( - params?: Octokit.RequestOptions & - Octokit.ReactionsCreateForPullRequestReviewCommentParams - ): Promise< - Octokit.Response< - Octokit.ReactionsCreateForPullRequestReviewCommentResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. - */ - createForTeamDiscussion: { - ( - params?: Octokit.RequestOptions & - Octokit.ReactionsCreateForTeamDiscussionParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. - */ - createForTeamDiscussionComment: { - ( - params?: Octokit.RequestOptions & - Octokit.ReactionsCreateForTeamDiscussionCommentParams - ): Promise< - Octokit.Response< - Octokit.ReactionsCreateForTeamDiscussionCommentResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://developer.github.com/v3/teams/discussions/) or [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). - */ - delete: { - ( - params?: Octokit.RequestOptions & Octokit.ReactionsDeleteParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * List the reactions to a [commit comment](https://developer.github.com/v3/repos/comments/). - */ - listForCommitComment: { - ( - params?: Octokit.RequestOptions & - Octokit.ReactionsListForCommitCommentParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * List the reactions to an [issue](https://developer.github.com/v3/issues/). - */ - listForIssue: { - ( - params?: Octokit.RequestOptions & - Octokit.ReactionsListForIssueParamsDeprecatedNumber - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.ReactionsListForIssueParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * List the reactions to an [issue comment](https://developer.github.com/v3/issues/comments/). - */ - listForIssueComment: { - ( - params?: Octokit.RequestOptions & - Octokit.ReactionsListForIssueCommentParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * List the reactions to a [pull request review comment](https://developer.github.com/v3/pulls/comments/). - */ - listForPullRequestReviewComment: { - ( - params?: Octokit.RequestOptions & - Octokit.ReactionsListForPullRequestReviewCommentParams - ): Promise< - Octokit.Response< - Octokit.ReactionsListForPullRequestReviewCommentResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - listForTeamDiscussion: { - ( - params?: Octokit.RequestOptions & - Octokit.ReactionsListForTeamDiscussionParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - listForTeamDiscussionComment: { - ( - params?: Octokit.RequestOptions & - Octokit.ReactionsListForTeamDiscussionCommentParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - }; - repos: { - acceptInvitation: { - ( - params?: Octokit.RequestOptions & Octokit.ReposAcceptInvitationParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - * - * 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)." - * - * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://developer.github.com/v3/repos/invitations/). - * - * **Rate limits** - * - * To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. - */ - addCollaborator: { - ( - params?: Octokit.RequestOptions & Octokit.ReposAddCollaboratorParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Here's how you can create a read-only deploy key: - */ - addDeployKey: { - ( - params?: Octokit.RequestOptions & Octokit.ReposAddDeployKeyParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ - addProtectedBranchAdminEnforcement: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposAddProtectedBranchAdminEnforcementParams - ): Promise< - Octokit.Response< - Octokit.ReposAddProtectedBranchAdminEnforcementResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. - * - * | Type | Description | - * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ - addProtectedBranchAppRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposAddProtectedBranchAppRestrictionsParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. - */ - addProtectedBranchRequiredSignatures: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposAddProtectedBranchRequiredSignaturesParams - ): Promise< - Octokit.Response< - Octokit.ReposAddProtectedBranchRequiredSignaturesResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - */ - addProtectedBranchRequiredStatusChecksContexts: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposAddProtectedBranchRequiredStatusChecksContextsParams - ): Promise< - Octokit.Response< - Octokit.ReposAddProtectedBranchRequiredStatusChecksContextsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Grants the specified teams push access for this branch. If you pass the `hellcat-preview` media type, you can also give push access to child teams. - * - * | Type | Description | - * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | - * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ - addProtectedBranchTeamRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposAddProtectedBranchTeamRestrictionsParams - ): Promise< - Octokit.Response< - Octokit.ReposAddProtectedBranchTeamRestrictionsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Grants the specified people push access for this branch. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ - addProtectedBranchUserRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposAddProtectedBranchUserRestrictionsParams - ): Promise< - Octokit.Response< - Octokit.ReposAddProtectedBranchUserRestrictionsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * - * If you pass the `hellcat-preview` media type, team members will include the members of child teams. - */ - checkCollaborator: { - ( - params?: Octokit.RequestOptions & Octokit.ReposCheckCollaboratorParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Shows whether vulnerability alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation. - */ - checkVulnerabilityAlerts: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposCheckVulnerabilityAlertsParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. - * - * The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. - * - * The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. - * - * **Working with large comparisons** - * - * The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [Commit List API](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository) to enumerate all commits in the range. - * - * For comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long to generate. You can typically resolve this error by using a smaller commit range. - * - * **Signature verification object** - * - * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ - compareCommits: { - ( - params?: Octokit.RequestOptions & Octokit.ReposCompareCommitsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Create a comment for a commit using its `:commit_sha`. - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - */ - createCommitComment: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposCreateCommitCommentParamsDeprecatedSha - ): Promise>; - ( - params?: Octokit.RequestOptions & - Octokit.ReposCreateCommitCommentParamsDeprecatedLine - ): Promise>; - ( - params?: Octokit.RequestOptions & Octokit.ReposCreateCommitCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Deployments offer a few configurable parameters with sane defaults. - * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request. - * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter makes it easier to track which environments have requested deployments. The default environment is `production`. - * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response. - * - * By default, [commit statuses](https://developer.github.com/v3/repos/statuses) for every submitted context must be in a `success` state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed. - * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched. - * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled. - * - * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref: - * - * A simple example putting the user and room into the payload to notify back to chat networks. - * - * A more advanced example specifying required commit statuses and bypassing auto-merging. - * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when: - * - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master`in the response example - * * There are no merge conflicts - * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful response. - * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. - * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. - */ - createDeployment: { - ( - params?: Octokit.RequestOptions & Octokit.ReposCreateDeploymentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Users with `push` access can create deployment statuses for a given deployment. - * - * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. - */ - createDeploymentStatus: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposCreateDeploymentStatusParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://developer.github.com/v3/activity/events/types/#repositorydispatchevent)." - * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. For a test example, see the [input example](https://developer.github.com/v3/repos/#example-4). - * - * To give you write access to the repository, you must use a personal access token with the `repo` scope. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. - */ - createDispatchEvent: { - ( - params?: Octokit.RequestOptions & Octokit.ReposCreateDispatchEventParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates a new file or updates an existing file in a repository. - * @deprecated octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07) - */ - createFile: { - ( - params?: Octokit.RequestOptions & Octokit.ReposCreateFileParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates a new repository for the authenticated user. - * - * **OAuth scope requirements** - * - * When using [OAuth](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository - * * `repo` scope to create a private repository - */ - createForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposCreateForAuthenticatedUserParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Create a fork for the authenticated user. - * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://github.com/contact). - */ - createFork: { - ( - params?: Octokit.RequestOptions & Octokit.ReposCreateForkParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can share the same `config` as long as those webhooks do not have any `events` that overlap. - * - * Here's how you can create a hook that posts payloads in JSON format: - */ - createHook: { - ( - params?: Octokit.RequestOptions & Octokit.ReposCreateHookParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates a new repository for the authenticated user. - * - * **OAuth scope requirements** - * - * When using [OAuth](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository - * * `repo` scope to create a private repository - */ - createInOrg: { - ( - params?: Octokit.RequestOptions & Octokit.ReposCreateInOrgParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates a new file or updates an existing file in a repository. - */ - createOrUpdateFile: { - ( - params?: Octokit.RequestOptions & Octokit.ReposCreateOrUpdateFileParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Users with push access to the repository can create a release. - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - */ - createRelease: { - ( - params?: Octokit.RequestOptions & Octokit.ReposCreateReleaseParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Users with push access in a repository can create commit statuses for a given SHA. - * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. - */ - createStatus: { - ( - params?: Octokit.RequestOptions & Octokit.ReposCreateStatusParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [`GET /repos/:owner/:repo`](https://developer.github.com/v3/repos/#get) endpoint and check that the `is_template` key is `true`. - * - * **OAuth scope requirements** - * - * When using [OAuth](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository - * * `repo` scope to create a private repository - * - * \` - */ - createUsingTemplate: { - ( - params?: Octokit.RequestOptions & Octokit.ReposCreateUsingTemplateParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - declineInvitation: { - ( - params?: Octokit.RequestOptions & Octokit.ReposDeclineInvitationParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. - * - * If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: - */ - delete: { - (params?: Octokit.RequestOptions & Octokit.ReposDeleteParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - deleteCommitComment: { - ( - params?: Octokit.RequestOptions & Octokit.ReposDeleteCommitCommentParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - deleteDownload: { - ( - params?: Octokit.RequestOptions & Octokit.ReposDeleteDownloadParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Deletes a file in a repository. - * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. - * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. - * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. - */ - deleteFile: { - ( - params?: Octokit.RequestOptions & Octokit.ReposDeleteFileParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - deleteHook: { - ( - params?: Octokit.RequestOptions & Octokit.ReposDeleteHookParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - deleteInvitation: { - ( - params?: Octokit.RequestOptions & Octokit.ReposDeleteInvitationParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Users with push access to the repository can delete a release. - */ - deleteRelease: { - ( - params?: Octokit.RequestOptions & Octokit.ReposDeleteReleaseParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - deleteReleaseAsset: { - ( - params?: Octokit.RequestOptions & Octokit.ReposDeleteReleaseAssetParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)" in the GitHub Help documentation. - */ - disableAutomatedSecurityFixes: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposDisableAutomatedSecurityFixesParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - disablePagesSite: { - ( - params?: Octokit.RequestOptions & Octokit.ReposDisablePagesSiteParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Disables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation. - */ - disableVulnerabilityAlerts: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposDisableVulnerabilityAlertsParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)" in the GitHub Help documentation. - */ - enableAutomatedSecurityFixes: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposEnableAutomatedSecurityFixesParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - enablePagesSite: { - ( - params?: Octokit.RequestOptions & Octokit.ReposEnablePagesSiteParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Enables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)" in the GitHub Help documentation. - */ - enableVulnerabilityAlerts: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposEnableVulnerabilityAlertsParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. - */ - get: { - (params?: Octokit.RequestOptions & Octokit.ReposGetParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. - */ - getAppsWithAccessToProtectedBranch: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetAppsWithAccessToProtectedBranchParams - ): Promise< - Octokit.Response< - Octokit.ReposGetAppsWithAccessToProtectedBranchResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Gets a redirect URL to download an archive for a repository. The `:archive_format` can be either `tarball` or `zipball`. The `:ref` must be a valid Git reference. If you omit `:ref`, the repository’s default branch (usually `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request. - * - * _Note_: For private repositories, these links are temporary and expire after five minutes. - * - * To follow redirects with curl, use the `-L` switch: - */ - getArchiveLink: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetArchiveLinkParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - getBranch: { - (params?: Octokit.RequestOptions & Octokit.ReposGetBranchParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - */ - getBranchProtection: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetBranchProtectionParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. - */ - getClones: { - (params?: Octokit.RequestOptions & Octokit.ReposGetClonesParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - */ - getCodeFrequencyStats: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetCodeFrequencyStatsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Possible values for the `permission` key: `admin`, `write`, `read`, `none`. - */ - getCollaboratorPermissionLevel: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetCollaboratorPermissionLevelParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. - * - * The most recent status for each context is returned, up to 100. This field [paginates](https://developer.github.com/v3/#pagination) if there are over 100 contexts. - * - * Additionally, a combined `state` is returned. The `state` is one of: - * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` - */ - getCombinedStatusForRef: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetCombinedStatusForRefParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - * - * You can pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. - * - * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. - * - * **Signature verification object** - * - * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ - getCommit: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetCommitParamsDeprecatedSha - ): Promise>; - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetCommitParamsDeprecatedCommitSha - ): Promise>; - (params?: Octokit.RequestOptions & Octokit.ReposGetCommitParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. - */ - getCommitActivityStats: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetCommitActivityStatsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getCommitComment: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetCommitCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** To access this endpoint, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: - * ``` - * application/vnd.github.VERSION.sha - * ``` - * Returns the SHA-1 of the commit reference. You must have `read` access for the repository to get the SHA-1 of a commit reference. You can use this endpoint to check if a remote reference's SHA-1 is the same as your local reference's SHA-1 by providing the local SHA-1 reference as the ETag. - * @deprecated "Get the SHA-1 of a commit reference" will be removed. Use "Get a single commit" instead with media type format set to "sha" instead. - */ - getCommitRefSha: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetCommitRefShaParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit `:path`, you will receive the contents of all files in the repository. - * - * Files and symlinks support [a custom media type](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw content or rendered HTML (when supported). All content types support [a custom media type](https://developer.github.com/v3/repos/contents/#custom-media-types) to ensure the content is returned in a consistent object format. - * - * **Note**: - * - * * To get a repository's contents recursively, you can [recursively get the tree](https://developer.github.com/v3/git/trees/). - * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees API](https://developer.github.com/v3/git/trees/#get-a-tree). - * * This API supports files up to 1 megabyte in size. - * - * The response will be an array of objects, one object for each item in the directory. - * - * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". - * - * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the [format shown above](https://developer.github.com/v3/repos/contents/#response-if-content-is-a-file)). - * - * Otherwise, the API responds with an object describing the symlink itself: - * - * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. - * - * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. - */ - getContents: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetContentsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * * `total` - The Total number of commits authored by the contributor. - * - * Weekly Hash (`weeks` array): - * - * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits - */ - getContributorsStats: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetContributorsStatsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getDeployKey: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetDeployKeyParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getDeployment: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetDeploymentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Users with pull access can view a deployment status for a deployment: - */ - getDeploymentStatus: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetDeploymentStatusParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getDownload: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetDownloadParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getHook: { - (params?: Octokit.RequestOptions & Octokit.ReposGetHookParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - getLatestPagesBuild: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetLatestPagesBuildParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * View the latest published full release for the repository. - * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. - */ - getLatestRelease: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetLatestReleaseParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - getPages: { - (params?: Octokit.RequestOptions & Octokit.ReposGetPagesParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - getPagesBuild: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetPagesBuildParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. - * - * The array order is oldest week (index 0) to most recent week. - */ - getParticipationStats: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetParticipationStatsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - */ - getProtectedBranchAdminEnforcement: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetProtectedBranchAdminEnforcementParams - ): Promise< - Octokit.Response< - Octokit.ReposGetProtectedBranchAdminEnforcementResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - */ - getProtectedBranchPullRequestReviewEnforcement: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetProtectedBranchPullRequestReviewEnforcementParams - ): Promise< - Octokit.Response< - Octokit.ReposGetProtectedBranchPullRequestReviewEnforcementResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help. - * - * **Note**: You must enable branch protection to require signed commits. - */ - getProtectedBranchRequiredSignatures: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetProtectedBranchRequiredSignaturesParams - ): Promise< - Octokit.Response< - Octokit.ReposGetProtectedBranchRequiredSignaturesResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - */ - getProtectedBranchRequiredStatusChecks: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetProtectedBranchRequiredStatusChecksParams - ): Promise< - Octokit.Response< - Octokit.ReposGetProtectedBranchRequiredStatusChecksResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Lists who has access to this protected branch. {{#note}} - * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. - */ - getProtectedBranchRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetProtectedBranchRestrictionsParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Each array contains the day number, hour number, and number of commits: - * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits - * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. - */ - getPunchCardStats: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetPunchCardStatsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Gets the preferred README for a repository. - * - * READMEs support [custom media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw content or rendered HTML. - */ - getReadme: { - (params?: Octokit.RequestOptions & Octokit.ReposGetReadmeParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://developer.github.com/v3/#hypermedia). - */ - getRelease: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetReleaseParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://developer.github.com/v3/media/#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. - */ - getReleaseAsset: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetReleaseAssetParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Get a published release with the specified tag. - */ - getReleaseByTag: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetReleaseByTagParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Lists the teams who have push access to this branch. If you pass the `hellcat-preview` media type, the list includes child teams. - */ - getTeamsWithAccessToProtectedBranch: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetTeamsWithAccessToProtectedBranchParams - ): Promise< - Octokit.Response< - Octokit.ReposGetTeamsWithAccessToProtectedBranchResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Get the top 10 popular contents over the last 14 days. - */ - getTopPaths: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetTopPathsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Get the top 10 referrers over the last 14 days. - */ - getTopReferrers: { - ( - params?: Octokit.RequestOptions & Octokit.ReposGetTopReferrersParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Lists the people who have push access to this branch. - */ - getUsersWithAccessToProtectedBranch: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposGetUsersWithAccessToProtectedBranchParams - ): Promise< - Octokit.Response< - Octokit.ReposGetUsersWithAccessToProtectedBranchResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. - */ - getViews: { - (params?: Octokit.RequestOptions & Octokit.ReposGetViewsParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - */ - list: { - (params?: Octokit.RequestOptions & Octokit.ReposListParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. - * @deprecated octokit.repos.listAppsWithAccessToProtectedBranch() has been renamed to octokit.repos.getAppsWithAccessToProtectedBranch() (2019-09-13) - */ - listAppsWithAccessToProtectedBranch: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposListAppsWithAccessToProtectedBranchParams - ): Promise< - Octokit.Response< - Octokit.ReposListAppsWithAccessToProtectedBranchResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - - listAssetsForRelease: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposListAssetsForReleaseParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listBranches: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListBranchesParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. - */ - listBranchesForHeadCommit: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposListBranchesForHeadCommitParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * - * If you pass the `hellcat-preview` media type, team members will include the members of child teams. - */ - listCollaborators: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListCollaboratorsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Use the `:commit_sha` to specify the commit that will have its comments listed. - */ - listCommentsForCommit: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposListCommentsForCommitParamsDeprecatedRef - ): Promise>; - ( - params?: Octokit.RequestOptions & - Octokit.ReposListCommentsForCommitParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Commit Comments use [these custom media types](https://developer.github.com/v3/repos/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/). - * - * Comments are ordered by ascending ID. - */ - listCommitComments: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListCommitCommentsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Signature verification object** - * - * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ - listCommits: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListCommitsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance. - * - * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. - */ - listContributors: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListContributorsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listDeployKeys: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListDeployKeysParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Users with pull access can view deployment statuses for a deployment: - */ - listDeploymentStatuses: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposListDeploymentStatusesParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Simple filtering of deployments is available via query parameters: - */ - listDeployments: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListDeploymentsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listDownloads: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListDownloadsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists repositories for the specified organization. - */ - listForOrg: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListForOrgParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists public repositories for the specified user. - */ - listForUser: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListForUserParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - listForks: { - (params?: Octokit.RequestOptions & Octokit.ReposListForksParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - listHooks: { - (params?: Octokit.RequestOptions & Octokit.ReposListHooksParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. - */ - listInvitations: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListInvitationsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * When authenticating as a user, this endpoint will list all currently open repository invitations for that user. - */ - listInvitationsForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposListInvitationsForAuthenticatedUserParams - ): Promise< - Octokit.Response< - Octokit.ReposListInvitationsForAuthenticatedUserResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. - */ - listLanguages: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListLanguagesParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listPagesBuilds: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListPagesBuildsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - */ - listProtectedBranchRequiredStatusChecksContexts: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposListProtectedBranchRequiredStatusChecksContextsParams - ): Promise< - Octokit.Response< - Octokit.ReposListProtectedBranchRequiredStatusChecksContextsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Lists the teams who have push access to this branch. If you pass the `hellcat-preview` media type, the list includes child teams. - * @deprecated octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09) - */ - listProtectedBranchTeamRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposListProtectedBranchTeamRestrictionsParams - ): Promise< - Octokit.Response< - Octokit.ReposListProtectedBranchTeamRestrictionsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Lists the people who have push access to this branch. - * @deprecated octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09) - */ - listProtectedBranchUserRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposListProtectedBranchUserRestrictionsParams - ): Promise< - Octokit.Response< - Octokit.ReposListProtectedBranchUserRestrictionsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists all public repositories in the order that they were created. - * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/v3/#link-header) to get the URL for the next page of repositories. - */ - listPublic: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListPublicParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoint. - */ - listPullRequestsAssociatedWithCommit: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposListPullRequestsAssociatedWithCommitParams - ): Promise< - Octokit.Response< - Octokit.ReposListPullRequestsAssociatedWithCommitResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://developer.github.com/v3/repos/#list-tags). - * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. - */ - listReleases: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListReleasesParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. - * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. - */ - listStatusesForRef: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListStatusesForRefParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listTags: { - (params?: Octokit.RequestOptions & Octokit.ReposListTagsParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - listTeams: { - (params?: Octokit.RequestOptions & Octokit.ReposListTeamsParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Lists the teams who have push access to this branch. If you pass the `hellcat-preview` media type, the list includes child teams. - * @deprecated octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13) - */ - listTeamsWithAccessToProtectedBranch: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposListTeamsWithAccessToProtectedBranchParams - ): Promise< - Octokit.Response< - Octokit.ReposListTeamsWithAccessToProtectedBranchResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - - listTopics: { - ( - params?: Octokit.RequestOptions & Octokit.ReposListTopicsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Lists the people who have push access to this branch. - * @deprecated octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13) - */ - listUsersWithAccessToProtectedBranch: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposListUsersWithAccessToProtectedBranchParams - ): Promise< - Octokit.Response< - Octokit.ReposListUsersWithAccessToProtectedBranchResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - - merge: { - (params?: Octokit.RequestOptions & Octokit.ReposMergeParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook. - */ - pingHook: { - (params?: Octokit.RequestOptions & Octokit.ReposPingHookParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - */ - removeBranchProtection: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposRemoveBranchProtectionParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - removeCollaborator: { - ( - params?: Octokit.RequestOptions & Octokit.ReposRemoveCollaboratorParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - removeDeployKey: { - ( - params?: Octokit.RequestOptions & Octokit.ReposRemoveDeployKeyParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ - removeProtectedBranchAdminEnforcement: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposRemoveProtectedBranchAdminEnforcementParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. - * - * | Type | Description | - * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ - removeProtectedBranchAppRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposRemoveProtectedBranchAppRestrictionsParams - ): Promise< - Octokit.Response< - Octokit.ReposRemoveProtectedBranchAppRestrictionsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - */ - removeProtectedBranchPullRequestReviewEnforcement: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposRemoveProtectedBranchPullRequestReviewEnforcementParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. - */ - removeProtectedBranchRequiredSignatures: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposRemoveProtectedBranchRequiredSignaturesParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - */ - removeProtectedBranchRequiredStatusChecks: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposRemoveProtectedBranchRequiredStatusChecksParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - */ - removeProtectedBranchRequiredStatusChecksContexts: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposRemoveProtectedBranchRequiredStatusChecksContextsParams - ): Promise< - Octokit.Response< - Octokit.ReposRemoveProtectedBranchRequiredStatusChecksContextsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Disables the ability to restrict who can push to this branch. - */ - removeProtectedBranchRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposRemoveProtectedBranchRestrictionsParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Removes the ability of a team to push to this branch. If you pass the `hellcat-preview` media type, you can include child teams. - * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ - removeProtectedBranchTeamRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposRemoveProtectedBranchTeamRestrictionsParams - ): Promise< - Octokit.Response< - Octokit.ReposRemoveProtectedBranchTeamRestrictionsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Removes the ability of a user to push to this branch. - * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ - removeProtectedBranchUserRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposRemoveProtectedBranchUserRestrictionsParams - ): Promise< - Octokit.Response< - Octokit.ReposRemoveProtectedBranchUserRestrictionsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. - * - * | Type | Description | - * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ - replaceProtectedBranchAppRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposReplaceProtectedBranchAppRestrictionsParams - ): Promise< - Octokit.Response< - Octokit.ReposReplaceProtectedBranchAppRestrictionsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - */ - replaceProtectedBranchRequiredStatusChecksContexts: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposReplaceProtectedBranchRequiredStatusChecksContextsParams - ): Promise< - Octokit.Response< - Octokit.ReposReplaceProtectedBranchRequiredStatusChecksContextsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. If you pass the `hellcat-preview` media type, you can include child teams. - * - * | Type | Description | - * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | - * | `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ - replaceProtectedBranchTeamRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposReplaceProtectedBranchTeamRestrictionsParams - ): Promise< - Octokit.Response< - Octokit.ReposReplaceProtectedBranchTeamRestrictionsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ - replaceProtectedBranchUserRestrictions: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposReplaceProtectedBranchUserRestrictionsParams - ): Promise< - Octokit.Response< - Octokit.ReposReplaceProtectedBranchUserRestrictionsResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - - replaceTopics: { - ( - params?: Octokit.RequestOptions & Octokit.ReposReplaceTopicsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. - * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. - */ - requestPageBuild: { - ( - params?: Octokit.RequestOptions & Octokit.ReposRequestPageBuildParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * This endpoint will return all community profile metrics, including an overall health score, repository description, the presence of documentation, detected code of conduct, detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE, README, and CONTRIBUTING files. - */ - retrieveCommunityProfileMetrics: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposRetrieveCommunityProfileMetricsParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. - * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` - */ - testPushHook: { - ( - params?: Octokit.RequestOptions & Octokit.ReposTestPushHookParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/). - */ - transfer: { - (params?: Octokit.RequestOptions & Octokit.ReposTransferParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note**: To edit a repository's topics, use the [`topics` endpoint](https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository). - */ - update: { - (params?: Octokit.RequestOptions & Octokit.ReposUpdateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Protecting a branch requires admin or owner permissions to the repository. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. - */ - updateBranchProtection: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposUpdateBranchProtectionParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - updateCommitComment: { - ( - params?: Octokit.RequestOptions & Octokit.ReposUpdateCommitCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates a new file or updates an existing file in a repository. - * @deprecated octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07) - */ - updateFile: { - ( - params?: Octokit.RequestOptions & Octokit.ReposUpdateFileParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - updateHook: { - ( - params?: Octokit.RequestOptions & Octokit.ReposUpdateHookParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - updateInformationAboutPagesSite: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposUpdateInformationAboutPagesSiteParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - updateInvitation: { - ( - params?: Octokit.RequestOptions & Octokit.ReposUpdateInvitationParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - */ - updateProtectedBranchPullRequestReviewEnforcement: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposUpdateProtectedBranchPullRequestReviewEnforcementParams - ): Promise< - Octokit.Response< - Octokit.ReposUpdateProtectedBranchPullRequestReviewEnforcementResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's billing plans](https://help.github.com/articles/github-s-billing-plans) in the GitHub Help documentation. - * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. - */ - updateProtectedBranchRequiredStatusChecks: { - ( - params?: Octokit.RequestOptions & - Octokit.ReposUpdateProtectedBranchRequiredStatusChecksParams - ): Promise< - Octokit.Response< - Octokit.ReposUpdateProtectedBranchRequiredStatusChecksResponse - > - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Users with push access to the repository can edit a release. - */ - updateRelease: { - ( - params?: Octokit.RequestOptions & Octokit.ReposUpdateReleaseParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Users with push access to the repository can edit a release asset. - */ - updateReleaseAsset: { - ( - params?: Octokit.RequestOptions & Octokit.ReposUpdateReleaseAssetParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * This endpoint makes use of [a Hypermedia relation](https://developer.github.com/v3/#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in the response of the [Create a release endpoint](https://developer.github.com/v3/repos/releases/#create-a-release) to upload a release asset. - * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. - * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: - * - * `application/zip` - * - * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset. - */ - uploadReleaseAsset: { - ( - params?: Octokit.RequestOptions & Octokit.ReposUploadReleaseAssetParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - }; - search: { - /** - * Find file contents via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). - * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). - * - * **Note:** You must [authenticate](https://developer.github.com/v3/#authentication) to search for code across all public repositories. - * - * **Considerations for code search** - * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: - * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - * - * Suppose you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery). Your query would look something like this: - * - * Here, we're searching for the keyword `addClass` within a file's contents. We're making sure that we're only looking in files where the language is JavaScript. And we're scoping the search to the `repo:jquery/jquery` repository. - */ - code: { - (params?: Octokit.RequestOptions & Octokit.SearchCodeParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Find commits via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). - * - * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). - * - * **Considerations for commit search** - * - * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * - * Suppose you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: - */ - commits: { - (params?: Octokit.RequestOptions & Octokit.SearchCommitsParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). - * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). - * - * Let's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - * - * In this query, we're searching for the keyword `windows`, within any open issue that's labeled as `bug`. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results. - * @deprecated octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27) - */ - issues: { - (params?: Octokit.RequestOptions & Octokit.SearchIssuesParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). - * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). - * - * Let's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - * - * In this query, we're searching for the keyword `windows`, within any open issue that's labeled as `bug`. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results. - */ - issuesAndPullRequests: { - ( - params?: Octokit.RequestOptions & - Octokit.SearchIssuesAndPullRequestsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://developer.github.com/v3/#pagination). - * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). - * - * Suppose you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: - * - * The labels that best match for the query appear first in the search results. - */ - labels: { - (params?: Octokit.RequestOptions & Octokit.SearchLabelsParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Find repositories via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). - * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). - * - * Suppose you want to search for popular Tetris repositories written in Assembly. Your query might look like this. - * - * You can search for multiple topics by adding more `topic:` instances, and including the `mercy-preview` header. For example: - * - * In this request, we're searching for repositories with the word `tetris` in the name, the description, or the README. We're limiting the results to only find repositories where the primary language is Assembly. We're sorting by stars in descending order, so that the most popular repositories appear first in the search results. - */ - repos: { - (params?: Octokit.RequestOptions & Octokit.SearchReposParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). - * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). - * - * See "[Searching topics](https://help.github.com/articles/searching-topics/)" for a detailed list of qualifiers. - * - * Suppose you want to search for topics related to Ruby that are featured on [https://github.com/topics](https://github.com/topics). Your query might look like this: - * - * In this request, we're searching for topics with the keyword `ruby`, and we're limiting the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. - * - * **Note:** A search for featured Ruby topics only has 6 total results, so a [Link header](https://developer.github.com/v3/#link-header) indicating pagination is not included in the response. - */ - topics: { - (params?: Octokit.RequestOptions & Octokit.SearchTopicsParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Find users via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). - * - * When searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). - * - * Imagine you're looking for a list of popular users. You might try out this query: - * - * Here, we're looking at users with the name Tom. We're only interested in those with more than 42 repositories, and only if they have over 1,000 followers. - */ - users: { - (params?: Octokit.RequestOptions & Octokit.SearchUsersParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - }; - teams: { - /** - * The "Add team member" API (described below) is deprecated. - * - * We recommend using the [Add team membership API](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) instead. It allows you to invite new organization members to your teams. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/articles/github-s-products) in the GitHub Help documentation. - * - * To add someone to a team, the authenticated user must be a team maintainer in the team they're changing or be an owner of the organization that the team is associated with. The person being added to the team must be a member of the team's organization. - * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - * @deprecated octokit.teams.addMember() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member - */ - addMember: { - (params?: Octokit.RequestOptions & Octokit.TeamsAddMemberParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/articles/github-s-products) in the GitHub Help documentation. - * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a maintainer of the team. - * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. - * - * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a maintainer of the team. - */ - addOrUpdateMembership: { - ( - params?: Octokit.RequestOptions & - Octokit.TeamsAddOrUpdateMembershipParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - */ - addOrUpdateProject: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsAddOrUpdateProjectParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. - * - * If you pass the `hellcat-preview` media type, you can modify repository permissions of child teams. - * - * 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)." - */ - addOrUpdateRepo: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsAddOrUpdateRepoParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note**: If you pass the `hellcat-preview` media type, repositories inherited through a parent team will be checked. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header: - */ - checkManagesRepo: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsCheckManagesRepoParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * To create a team, the authenticated user must be a member or owner of `:org`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." - */ - create: { - ( - params?: Octokit.RequestOptions & - Octokit.TeamsCreateParamsDeprecatedPermission - ): Promise>; - (params?: Octokit.RequestOptions & Octokit.TeamsCreateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - */ - createDiscussion: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsCreateDiscussionParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - */ - createDiscussionComment: { - ( - params?: Octokit.RequestOptions & - Octokit.TeamsCreateDiscussionCommentParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * To delete a team, the authenticated user must be a team maintainer or an owner of the org associated with the team. - * - * If you are an organization owner and you pass the `hellcat-preview` media type, deleting a parent team will delete all of its child teams as well. - */ - delete: { - (params?: Octokit.RequestOptions & Octokit.TeamsDeleteParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - deleteDiscussion: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsDeleteDiscussionParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - deleteDiscussionComment: { - ( - params?: Octokit.RequestOptions & - Octokit.TeamsDeleteDiscussionCommentParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - get: { - (params?: Octokit.RequestOptions & Octokit.TeamsGetParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. - */ - getByName: { - (params?: Octokit.RequestOptions & Octokit.TeamsGetByNameParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - getDiscussion: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsGetDiscussionParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - getDiscussionComment: { - ( - params?: Octokit.RequestOptions & - Octokit.TeamsGetDiscussionCommentParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * The "Get team member" API (described below) is deprecated. - * - * We recommend using the [Get team membership API](https://developer.github.com/v3/teams/members/#get-team-membership) instead. It allows you to get both active and pending memberships. - * - * To list members in a team, the team must be visible to the authenticated user. - * @deprecated octokit.teams.getMember() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member - */ - getMember: { - (params?: Octokit.RequestOptions & Octokit.TeamsGetMemberParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * If you pass the `hellcat-preview` media type, team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team). - */ - getMembership: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsGetMembershipParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - list: { - (params?: Octokit.RequestOptions & Octokit.TeamsListParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * At this time, the `hellcat-preview` media type is required to use this endpoint. - */ - listChild: { - (params?: Octokit.RequestOptions & Octokit.TeamsListChildParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - listDiscussionComments: { - ( - params?: Octokit.RequestOptions & - Octokit.TeamsListDiscussionCommentsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - listDiscussions: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsListDiscussionsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://developer.github.com/apps/building-oauth-apps/). - */ - listForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.TeamsListForAuthenticatedUserParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * If you pass the `hellcat-preview` media type, team members will include the members of child teams. - */ - listMembers: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsListMembersParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. - */ - listPendingInvitations: { - ( - params?: Octokit.RequestOptions & - Octokit.TeamsListPendingInvitationsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists the organization projects for a team. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team. - */ - listProjects: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsListProjectsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note**: If you pass the `hellcat-preview` media type, the response will include any repositories inherited through a parent team. - */ - listRepos: { - (params?: Octokit.RequestOptions & Octokit.TeamsListReposParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * The "Remove team member" API (described below) is deprecated. - * - * We recommend using the [Remove team membership endpoint](https://developer.github.com/v3/teams/members/#remove-team-membership) instead. It allows you to remove both active and pending memberships. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/articles/github-s-products) in the GitHub Help documentation. - * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. - * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * @deprecated octokit.teams.removeMember() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member - */ - removeMember: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsRemoveMemberParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/articles/github-s-products) in the GitHub Help documentation. - * - * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. - * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - */ - removeMembership: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsRemoveMembershipParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. - */ - removeProject: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsRemoveProjectParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. - */ - removeRepo: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsRemoveRepoParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team. - */ - reviewProject: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsReviewProjectParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * To edit a team, the authenticated user must either be an owner of the org that the team is associated with, or a maintainer of the team. - * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. - */ - update: { - ( - params?: Octokit.RequestOptions & - Octokit.TeamsUpdateParamsDeprecatedPermission - ): Promise>; - (params?: Octokit.RequestOptions & Octokit.TeamsUpdateParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - updateDiscussion: { - ( - params?: Octokit.RequestOptions & Octokit.TeamsUpdateDiscussionParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - updateDiscussionComment: { - ( - params?: Octokit.RequestOptions & - Octokit.TeamsUpdateDiscussionCommentParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - }; - users: { - /** - * This endpoint is accessible with the `user` scope. - */ - addEmails: { - (params?: Octokit.RequestOptions & Octokit.UsersAddEmailsParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - block: { - (params?: Octokit.RequestOptions & Octokit.UsersBlockParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * If the user is blocked: - * - * If the user is not blocked: - */ - checkBlocked: { - ( - params?: Octokit.RequestOptions & Octokit.UsersCheckBlockedParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - checkFollowing: { - ( - params?: Octokit.RequestOptions & Octokit.UsersCheckFollowingParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - - checkFollowingForUser: { - ( - params?: Octokit.RequestOptions & - Octokit.UsersCheckFollowingForUserParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - createGpgKey: { - ( - params?: Octokit.RequestOptions & Octokit.UsersCreateGpgKeyParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - createPublicKey: { - ( - params?: Octokit.RequestOptions & Octokit.UsersCreatePublicKeyParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * This endpoint is accessible with the `user` scope. - */ - deleteEmails: { - ( - params?: Octokit.RequestOptions & Octokit.UsersDeleteEmailsParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - deleteGpgKey: { - ( - params?: Octokit.RequestOptions & Octokit.UsersDeleteGpgKeyParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - deletePublicKey: { - ( - params?: Octokit.RequestOptions & Octokit.UsersDeletePublicKeyParams - ): Promise; - - endpoint: Octokit.Endpoint; - }; - /** - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - * - * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. - */ - follow: { - (params?: Octokit.RequestOptions & Octokit.UsersFollowParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists public and private profile information when authenticated through basic auth or OAuth with the `user` scope. - * - * Lists public profile information when authenticated through OAuth without the `user` scope. - */ - getAuthenticated: { - (params?: Octokit.RequestOptions & Octokit.EmptyParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Provides publicly available information about someone with a GitHub account. - * - * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://developer.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see "[Response with GitHub plan information](https://developer.github.com/v3/users/#response-with-github-plan-information)." - * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://developer.github.com/v3/#authentication). - * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://developer.github.com/v3/users/emails/)". - */ - getByUsername: { - ( - params?: Octokit.RequestOptions & Octokit.UsersGetByUsernameParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. - * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: - */ - getContextForUser: { - ( - params?: Octokit.RequestOptions & Octokit.UsersGetContextForUserParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - getGpgKey: { - (params?: Octokit.RequestOptions & Octokit.UsersGetGpgKeyParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - getPublicKey: { - ( - params?: Octokit.RequestOptions & Octokit.UsersGetPublicKeyParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. - * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/v3/#link-header) to get the URL for the next page of users. - */ - list: { - (params?: Octokit.RequestOptions & Octokit.UsersListParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * List the users you've blocked on your personal account. - */ - listBlocked: { - (params?: Octokit.RequestOptions & Octokit.EmptyParams): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. - */ - listEmails: { - ( - params?: Octokit.RequestOptions & Octokit.UsersListEmailsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listFollowersForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.UsersListFollowersForAuthenticatedUserParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - listFollowersForUser: { - ( - params?: Octokit.RequestOptions & - Octokit.UsersListFollowersForUserParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - - listFollowingForAuthenticatedUser: { - ( - params?: Octokit.RequestOptions & - Octokit.UsersListFollowingForAuthenticatedUserParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - listFollowingForUser: { - ( - params?: Octokit.RequestOptions & - Octokit.UsersListFollowingForUserParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - listGpgKeys: { - ( - params?: Octokit.RequestOptions & Octokit.UsersListGpgKeysParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists the GPG keys for a user. This information is accessible by anyone. - */ - listGpgKeysForUser: { - ( - params?: Octokit.RequestOptions & Octokit.UsersListGpgKeysForUserParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists your publicly visible email address, which you can set with the [Toggle primary email visibility](https://developer.github.com/v3/users/emails/#toggle-primary-email-visibility) endpoint. This endpoint is accessible with the `user:email` scope. - */ - listPublicEmails: { - ( - params?: Octokit.RequestOptions & Octokit.UsersListPublicEmailsParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ - listPublicKeys: { - ( - params?: Octokit.RequestOptions & Octokit.UsersListPublicKeysParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Lists the _verified_ public SSH keys for a user. This is accessible by anyone. - */ - listPublicKeysForUser: { - ( - params?: Octokit.RequestOptions & - Octokit.UsersListPublicKeysForUserParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - /** - * Sets the visibility for your primary email addresses. - */ - togglePrimaryEmailVisibility: { - ( - params?: Octokit.RequestOptions & - Octokit.UsersTogglePrimaryEmailVisibilityParams - ): Promise< - Octokit.Response - >; - - endpoint: Octokit.Endpoint; - }; - - unblock: { - (params?: Octokit.RequestOptions & Octokit.UsersUnblockParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. - */ - unfollow: { - (params?: Octokit.RequestOptions & Octokit.UsersUnfollowParams): Promise< - Octokit.AnyResponse - >; - - endpoint: Octokit.Endpoint; - }; - /** - * **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. - */ - updateAuthenticated: { - ( - params?: Octokit.RequestOptions & Octokit.UsersUpdateAuthenticatedParams - ): Promise>; - - endpoint: Octokit.Endpoint; - }; - }; -} - -export = Octokit; diff --git a/node_modules/@octokit/rest/index.js b/node_modules/@octokit/rest/index.js deleted file mode 100644 index 5a228f3..0000000 --- a/node_modules/@octokit/rest/index.js +++ /dev/null @@ -1,15 +0,0 @@ -const Octokit = require("./lib/core"); - -const CORE_PLUGINS = [ - require("./plugins/log"), - require("./plugins/authentication-deprecated"), // deprecated: remove in v17 - require("./plugins/authentication"), - require("./plugins/pagination"), - require("./plugins/register-endpoints"), - require("./plugins/rest-api-endpoints"), - require("./plugins/validate"), - - require("octokit-pagination-methods") // deprecated: remove in v17 -]; - -module.exports = Octokit.plugin(CORE_PLUGINS); diff --git a/node_modules/@octokit/rest/lib/constructor.js b/node_modules/@octokit/rest/lib/constructor.js deleted file mode 100644 index d83cf6b..0000000 --- a/node_modules/@octokit/rest/lib/constructor.js +++ /dev/null @@ -1,29 +0,0 @@ -module.exports = Octokit; - -const { request } = require("@octokit/request"); -const Hook = require("before-after-hook"); - -const parseClientOptions = require("./parse-client-options"); - -function Octokit(plugins, options) { - options = options || {}; - const hook = new Hook.Collection(); - const log = Object.assign( - { - debug: () => {}, - info: () => {}, - warn: console.warn, - error: console.error - }, - options && options.log - ); - const api = { - hook, - log, - request: request.defaults(parseClientOptions(options, log, hook)) - }; - - plugins.forEach(pluginFunction => pluginFunction(api, options)); - - return api; -} diff --git a/node_modules/@octokit/rest/lib/core.js b/node_modules/@octokit/rest/lib/core.js deleted file mode 100644 index 4943ffa..0000000 --- a/node_modules/@octokit/rest/lib/core.js +++ /dev/null @@ -1,3 +0,0 @@ -const factory = require("./factory"); - -module.exports = factory(); diff --git a/node_modules/@octokit/rest/lib/factory.js b/node_modules/@octokit/rest/lib/factory.js deleted file mode 100644 index 5dc2065..0000000 --- a/node_modules/@octokit/rest/lib/factory.js +++ /dev/null @@ -1,10 +0,0 @@ -module.exports = factory; - -const Octokit = require("./constructor"); -const registerPlugin = require("./register-plugin"); - -function factory(plugins) { - const Api = Octokit.bind(null, plugins || []); - Api.plugin = registerPlugin.bind(null, plugins || []); - return Api; -} diff --git a/node_modules/@octokit/rest/lib/parse-client-options.js b/node_modules/@octokit/rest/lib/parse-client-options.js deleted file mode 100644 index c7c097d..0000000 --- a/node_modules/@octokit/rest/lib/parse-client-options.js +++ /dev/null @@ -1,89 +0,0 @@ -module.exports = parseOptions; - -const { Deprecation } = require("deprecation"); -const { getUserAgent } = require("universal-user-agent"); -const once = require("once"); - -const pkg = require("../package.json"); - -const deprecateOptionsTimeout = once((log, deprecation) => - log.warn(deprecation) -); -const deprecateOptionsAgent = once((log, deprecation) => log.warn(deprecation)); -const deprecateOptionsHeaders = once((log, deprecation) => - log.warn(deprecation) -); - -function parseOptions(options, log, hook) { - if (options.headers) { - options.headers = Object.keys(options.headers).reduce((newObj, key) => { - newObj[key.toLowerCase()] = options.headers[key]; - return newObj; - }, {}); - } - - const clientDefaults = { - headers: options.headers || {}, - request: options.request || {}, - mediaType: { - previews: [], - format: "" - } - }; - - if (options.baseUrl) { - clientDefaults.baseUrl = options.baseUrl; - } - - if (options.userAgent) { - clientDefaults.headers["user-agent"] = options.userAgent; - } - - if (options.previews) { - clientDefaults.mediaType.previews = options.previews; - } - - if (options.timeZone) { - clientDefaults.headers["time-zone"] = options.timeZone; - } - - if (options.timeout) { - deprecateOptionsTimeout( - log, - new Deprecation( - "[@octokit/rest] new Octokit({timeout}) is deprecated. Use {request: {timeout}} instead. See https://github.com/octokit/request.js#request" - ) - ); - clientDefaults.request.timeout = options.timeout; - } - - if (options.agent) { - deprecateOptionsAgent( - log, - new Deprecation( - "[@octokit/rest] new Octokit({agent}) is deprecated. Use {request: {agent}} instead. See https://github.com/octokit/request.js#request" - ) - ); - clientDefaults.request.agent = options.agent; - } - - if (options.headers) { - deprecateOptionsHeaders( - log, - new Deprecation( - "[@octokit/rest] new Octokit({headers}) is deprecated. Use {userAgent, previews} instead. See https://github.com/octokit/request.js#request" - ) - ); - } - - const userAgentOption = clientDefaults.headers["user-agent"]; - const defaultUserAgent = `octokit.js/${pkg.version} ${getUserAgent()}`; - - clientDefaults.headers["user-agent"] = [userAgentOption, defaultUserAgent] - .filter(Boolean) - .join(" "); - - clientDefaults.request.hook = hook.bind(null, "request"); - - return clientDefaults; -} diff --git a/node_modules/@octokit/rest/lib/register-plugin.js b/node_modules/@octokit/rest/lib/register-plugin.js deleted file mode 100644 index c1ae775..0000000 --- a/node_modules/@octokit/rest/lib/register-plugin.js +++ /dev/null @@ -1,9 +0,0 @@ -module.exports = registerPlugin; - -const factory = require("./factory"); - -function registerPlugin(plugins, pluginFunction) { - return factory( - plugins.includes(pluginFunction) ? plugins : plugins.concat(pluginFunction) - ); -} diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/LICENSE.md b/node_modules/@octokit/rest/node_modules/universal-user-agent/LICENSE.md deleted file mode 100644 index f105ab0..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/LICENSE.md +++ /dev/null @@ -1,7 +0,0 @@ -# [ISC License](https://spdx.org/licenses/ISC) - -Copyright (c) 2018, Gregor Martynus (https://github.com/gr2m) - -Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/README.md b/node_modules/@octokit/rest/node_modules/universal-user-agent/README.md deleted file mode 100644 index d00d14c..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# universal-user-agent - -> Get a user agent string in both browser and node - -[![@latest](https://img.shields.io/npm/v/universal-user-agent.svg)](https://www.npmjs.com/package/universal-user-agent) -[![Build Status](https://travis-ci.com/gr2m/universal-user-agent.svg?branch=master)](https://travis-ci.com/gr2m/universal-user-agent) -[![Greenkeeper](https://badges.greenkeeper.io/gr2m/universal-user-agent.svg)](https://greenkeeper.io/) - -```js -const { getUserAgent } = require("universal-user-agent"); -// or import { getUserAgent } from "universal-user-agent"; - -const userAgent = getUserAgent(); -// userAgent will look like this -// in browser: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:61.0) Gecko/20100101 Firefox/61.0" -// in node: Node.js/v8.9.4 (macOS High Sierra; x64) -``` - -## Credits - -The Node implementation was originally inspired by [default-user-agent](https://www.npmjs.com/package/default-user-agent). - -## License - -[ISC](LICENSE.md) diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js deleted file mode 100644 index 80a0710..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js +++ /dev/null @@ -1,22 +0,0 @@ -'use strict'; - -Object.defineProperty(exports, '__esModule', { value: true }); - -function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } - -var osName = _interopDefault(require('os-name')); - -function getUserAgent() { - try { - return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; - } catch (error) { - if (/wmic os get Caption/.test(error.message)) { - return "Windows "; - } - - throw error; - } -} - -exports.getUserAgent = getUserAgent; -//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js.map b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js.map deleted file mode 100644 index aff09ec..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-node/index.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.js","sources":["../dist-src/node.js"],"sourcesContent":["import osName from \"os-name\";\nexport function getUserAgent() {\n try {\n return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`;\n }\n catch (error) {\n if (/wmic os get Caption/.test(error.message)) {\n return \"Windows \";\n }\n throw error;\n }\n}\n"],"names":["getUserAgent","process","version","substr","osName","arch","error","test","message"],"mappings":";;;;;;;;AACO,SAASA,YAAT,GAAwB;MACvB;WACQ,WAAUC,OAAO,CAACC,OAAR,CAAgBC,MAAhB,CAAuB,CAAvB,CAA0B,KAAIC,MAAM,EAAG,KAAIH,OAAO,CAACI,IAAK,GAA1E;GADJ,CAGA,OAAOC,KAAP,EAAc;QACN,sBAAsBC,IAAtB,CAA2BD,KAAK,CAACE,OAAjC,CAAJ,EAA+C;aACpC,gCAAP;;;UAEEF,KAAN;;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/browser.js b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/browser.js deleted file mode 100644 index 6f52232..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/browser.js +++ /dev/null @@ -1,3 +0,0 @@ -export function getUserAgent() { - return navigator.userAgent; -} diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/index.js b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/index.js deleted file mode 100644 index c6253f5..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/index.js +++ /dev/null @@ -1 +0,0 @@ -export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/node.js b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/node.js deleted file mode 100644 index 8b70a03..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-src/node.js +++ /dev/null @@ -1,12 +0,0 @@ -import osName from "os-name"; -export function getUserAgent() { - try { - return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; - } - catch (error) { - if (/wmic os get Caption/.test(error.message)) { - return "Windows "; - } - throw error; - } -} diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/browser.d.ts b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/browser.d.ts deleted file mode 100644 index a7bb1c4..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/browser.d.ts +++ /dev/null @@ -1 +0,0 @@ -export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/index.d.ts b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/index.d.ts deleted file mode 100644 index c6253f5..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/index.d.ts +++ /dev/null @@ -1 +0,0 @@ -export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/node.d.ts b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/node.d.ts deleted file mode 100644 index a7bb1c4..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-types/node.d.ts +++ /dev/null @@ -1 +0,0 @@ -export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js deleted file mode 100644 index 11ec79b..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js +++ /dev/null @@ -1,6 +0,0 @@ -function getUserAgent() { - return navigator.userAgent; -} - -export { getUserAgent }; -//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js.map b/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js.map deleted file mode 100644 index 549407e..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/dist-web/index.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.js","sources":["../dist-src/browser.js"],"sourcesContent":["export function getUserAgent() {\n return navigator.userAgent;\n}\n"],"names":[],"mappings":"AAAO,SAAS,YAAY,GAAG;IAC3B,OAAO,SAAS,CAAC,SAAS,CAAC;CAC9B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/rest/node_modules/universal-user-agent/package.json b/node_modules/@octokit/rest/node_modules/universal-user-agent/package.json deleted file mode 100644 index 1999e09..0000000 --- a/node_modules/@octokit/rest/node_modules/universal-user-agent/package.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "_from": "universal-user-agent@^4.0.0", - "_id": "universal-user-agent@4.0.0", - "_inBundle": false, - "_integrity": "sha512-eM8knLpev67iBDizr/YtqkJsF3GK8gzDc6st/WKzrTuPtcsOKW/0IdL4cnMBsU69pOx0otavLWBDGTwg+dB0aA==", - "_location": "/@octokit/rest/universal-user-agent", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "universal-user-agent@^4.0.0", - "name": "universal-user-agent", - "escapedName": "universal-user-agent", - "rawSpec": "^4.0.0", - "saveSpec": null, - "fetchSpec": "^4.0.0" - }, - "_requiredBy": [ - "/@octokit/rest" - ], - "_resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-4.0.0.tgz", - "_shasum": "27da2ec87e32769619f68a14996465ea1cb9df16", - "_spec": "universal-user-agent@^4.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/rest", - "bugs": { - "url": "https://github.com/gr2m/universal-user-agent/issues" - }, - "bundleDependencies": false, - "dependencies": { - "os-name": "^3.1.0" - }, - "deprecated": false, - "description": "Get a user agent string in both browser and node", - "devDependencies": { - "@gr2m/pika-plugin-build-web": "^0.6.0-issue-84.1", - "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.6.0", - "@pika/plugin-ts-standard-pkg": "^0.6.0", - "@types/jest": "^24.0.18", - "jest": "^24.9.0", - "prettier": "^1.18.2", - "semantic-release": "^15.9.15", - "ts-jest": "^24.0.2", - "typescript": "^3.6.2" - }, - "files": [ - "dist-*/", - "bin/" - ], - "homepage": "https://github.com/gr2m/universal-user-agent#readme", - "keywords": [], - "license": "ISC", - "main": "dist-node/index.js", - "module": "dist-web/index.js", - "name": "universal-user-agent", - "pika": true, - "repository": { - "type": "git", - "url": "git+https://github.com/gr2m/universal-user-agent.git" - }, - "sideEffects": false, - "source": "dist-src/index.js", - "types": "dist-types/index.d.ts", - "version": "4.0.0" -} diff --git a/node_modules/@octokit/rest/package.json b/node_modules/@octokit/rest/package.json deleted file mode 100644 index ab175f7..0000000 --- a/node_modules/@octokit/rest/package.json +++ /dev/null @@ -1,173 +0,0 @@ -{ - "_from": "@octokit/rest@^16.15.0", - "_id": "@octokit/rest@16.35.0", - "_inBundle": false, - "_integrity": "sha512-9ShFqYWo0CLoGYhA1FdtdykJuMzS/9H6vSbbQWDX4pWr4p9v+15MsH/wpd/3fIU+tSxylaNO48+PIHqOkBRx3w==", - "_location": "/@octokit/rest", - "_phantomChildren": { - "os-name": "3.1.0" - }, - "_requested": { - "type": "range", - "registry": true, - "raw": "@octokit/rest@^16.15.0", - "name": "@octokit/rest", - "escapedName": "@octokit%2frest", - "scope": "@octokit", - "rawSpec": "^16.15.0", - "saveSpec": null, - "fetchSpec": "^16.15.0" - }, - "_requiredBy": [ - "/@actions/github" - ], - "_resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-16.35.0.tgz", - "_shasum": "7ccc1f802f407d5b8eb21768c6deca44e7b4c0d8", - "_spec": "@octokit/rest@^16.15.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@actions/github", - "author": { - "name": "Gregor Martynus", - "url": "https://github.com/gr2m" - }, - "bugs": { - "url": "https://github.com/octokit/rest.js/issues" - }, - "bundleDependencies": false, - "bundlesize": [ - { - "path": "./dist/octokit-rest.min.js.gz", - "maxSize": "33 kB" - } - ], - "contributors": [ - { - "name": "Mike de Boer", - "email": "info@mikedeboer.nl" - }, - { - "name": "Fabian Jakobs", - "email": "fabian@c9.io" - }, - { - "name": "Joe Gallo", - "email": "joe@brassafrax.com" - }, - { - "name": "Gregor Martynus", - "url": "https://github.com/gr2m" - } - ], - "dependencies": { - "@octokit/request": "^5.2.0", - "@octokit/request-error": "^1.0.2", - "atob-lite": "^2.0.0", - "before-after-hook": "^2.0.0", - "btoa-lite": "^1.0.0", - "deprecation": "^2.0.0", - "lodash.get": "^4.4.2", - "lodash.set": "^4.3.2", - "lodash.uniq": "^4.5.0", - "octokit-pagination-methods": "^1.1.0", - "once": "^1.4.0", - "universal-user-agent": "^4.0.0" - }, - "deprecated": false, - "description": "GitHub REST API client for Node.js", - "devDependencies": { - "@gimenete/type-writer": "^0.1.3", - "@octokit/fixtures-server": "^5.0.6", - "@octokit/graphql": "^4.2.0", - "@types/node": "^12.0.0", - "bundlesize": "^0.18.0", - "chai": "^4.1.2", - "compression-webpack-plugin": "^3.0.0", - "cypress": "^3.0.0", - "glob": "^7.1.2", - "http-proxy-agent": "^2.1.0", - "lodash.camelcase": "^4.3.0", - "lodash.merge": "^4.6.1", - "lodash.upperfirst": "^4.3.1", - "mkdirp": "^0.5.1", - "mocha": "^6.0.0", - "mustache": "^3.0.0", - "nock": "^11.3.3", - "npm-run-all": "^4.1.2", - "nyc": "^14.0.0", - "prettier": "^1.14.2", - "proxy": "^1.0.0", - "semantic-release": "^15.0.0", - "sinon": "^7.2.4", - "sinon-chai": "^3.0.0", - "sort-keys": "^4.0.0", - "string-to-arraybuffer": "^1.0.0", - "string-to-jsdoc-comment": "^1.0.0", - "typescript": "^3.3.1", - "webpack": "^4.0.0", - "webpack-bundle-analyzer": "^3.0.0", - "webpack-cli": "^3.0.0" - }, - "files": [ - "index.js", - "index.d.ts", - "lib", - "plugins" - ], - "homepage": "https://github.com/octokit/rest.js#readme", - "keywords": [ - "octokit", - "github", - "rest", - "api-client" - ], - "license": "MIT", - "name": "@octokit/rest", - "nyc": { - "ignore": [ - "test" - ] - }, - "publishConfig": { - "access": "public" - }, - "release": { - "publish": [ - "@semantic-release/npm", - { - "path": "@semantic-release/github", - "assets": [ - "dist/*", - "!dist/*.map.gz" - ] - } - ] - }, - "repository": { - "type": "git", - "url": "git+https://github.com/octokit/rest.js.git" - }, - "scripts": { - "build": "npm-run-all build:*", - "build:browser": "npm-run-all build:browser:*", - "build:browser:development": "webpack --mode development --entry . --output-library=Octokit --output=./dist/octokit-rest.js --profile --json > dist/bundle-stats.json", - "build:browser:production": "webpack --mode production --entry . --plugin=compression-webpack-plugin --output-library=Octokit --output-path=./dist --output-filename=octokit-rest.min.js --devtool source-map", - "build:ts": "npm run -s update-endpoints:typescript", - "coverage": "nyc report --reporter=html && open coverage/index.html", - "generate-bundle-report": "webpack-bundle-analyzer dist/bundle-stats.json --mode=static --no-open --report dist/bundle-report.html", - "lint": "prettier --check '{lib,plugins,scripts,test}/**/*.{js,json,ts}' 'docs/*.{js,json}' 'docs/src/**/*' index.js README.md package.json", - "lint:fix": "prettier --write '{lib,plugins,scripts,test}/**/*.{js,json,ts}' 'docs/*.{js,json}' 'docs/src/**/*' index.js README.md package.json", - "postvalidate:ts": "tsc --noEmit --target es6 test/typescript-validate.ts", - "prebuild:browser": "mkdirp dist/", - "pretest": "npm run -s lint", - "prevalidate:ts": "npm run -s build:ts", - "start-fixtures-server": "octokit-fixtures-server", - "test": "nyc mocha test/mocha-node-setup.js \"test/*/**/*-test.js\"", - "test:browser": "cypress run --browser chrome", - "update-endpoints": "npm-run-all update-endpoints:*", - "update-endpoints:code": "node scripts/update-endpoints/code", - "update-endpoints:fetch-json": "node scripts/update-endpoints/fetch-json", - "update-endpoints:typescript": "node scripts/update-endpoints/typescript", - "validate:ts": "tsc --target es6 --noImplicitAny index.d.ts" - }, - "types": "index.d.ts", - "version": "16.35.0" -} diff --git a/node_modules/@octokit/rest/plugins/authentication-deprecated/authenticate.js b/node_modules/@octokit/rest/plugins/authentication-deprecated/authenticate.js deleted file mode 100644 index 86ce9e9..0000000 --- a/node_modules/@octokit/rest/plugins/authentication-deprecated/authenticate.js +++ /dev/null @@ -1,52 +0,0 @@ -module.exports = authenticate; - -const { Deprecation } = require("deprecation"); -const once = require("once"); - -const deprecateAuthenticate = once((log, deprecation) => log.warn(deprecation)); - -function authenticate(state, options) { - deprecateAuthenticate( - state.octokit.log, - new Deprecation( - '[@octokit/rest] octokit.authenticate() is deprecated. Use "auth" constructor option instead.' - ) - ); - - if (!options) { - state.auth = false; - return; - } - - switch (options.type) { - case "basic": - if (!options.username || !options.password) { - throw new Error( - "Basic authentication requires both a username and password to be set" - ); - } - break; - - case "oauth": - if (!options.token && !(options.key && options.secret)) { - throw new Error( - "OAuth2 authentication requires a token or key & secret to be set" - ); - } - break; - - case "token": - case "app": - if (!options.token) { - throw new Error("Token authentication requires a token to be set"); - } - break; - - default: - throw new Error( - "Invalid authentication type, must be 'basic', 'oauth', 'token' or 'app'" - ); - } - - state.auth = options; -} diff --git a/node_modules/@octokit/rest/plugins/authentication-deprecated/before-request.js b/node_modules/@octokit/rest/plugins/authentication-deprecated/before-request.js deleted file mode 100644 index dbb83ab..0000000 --- a/node_modules/@octokit/rest/plugins/authentication-deprecated/before-request.js +++ /dev/null @@ -1,43 +0,0 @@ -module.exports = authenticationBeforeRequest; - -const btoa = require("btoa-lite"); -const uniq = require("lodash.uniq"); - -function authenticationBeforeRequest(state, options) { - if (!state.auth.type) { - return; - } - - if (state.auth.type === "basic") { - const hash = btoa(`${state.auth.username}:${state.auth.password}`); - options.headers.authorization = `Basic ${hash}`; - return; - } - - if (state.auth.type === "token") { - options.headers.authorization = `token ${state.auth.token}`; - return; - } - - if (state.auth.type === "app") { - options.headers.authorization = `Bearer ${state.auth.token}`; - const acceptHeaders = options.headers.accept - .split(",") - .concat("application/vnd.github.machine-man-preview+json"); - options.headers.accept = uniq(acceptHeaders) - .filter(Boolean) - .join(","); - return; - } - - options.url += options.url.indexOf("?") === -1 ? "?" : "&"; - - if (state.auth.token) { - options.url += `access_token=${encodeURIComponent(state.auth.token)}`; - return; - } - - const key = encodeURIComponent(state.auth.key); - const secret = encodeURIComponent(state.auth.secret); - options.url += `client_id=${key}&client_secret=${secret}`; -} diff --git a/node_modules/@octokit/rest/plugins/authentication-deprecated/index.js b/node_modules/@octokit/rest/plugins/authentication-deprecated/index.js deleted file mode 100644 index 7e0cc4f..0000000 --- a/node_modules/@octokit/rest/plugins/authentication-deprecated/index.js +++ /dev/null @@ -1,31 +0,0 @@ -module.exports = authenticationPlugin; - -const { Deprecation } = require("deprecation"); -const once = require("once"); - -const deprecateAuthenticate = once((log, deprecation) => log.warn(deprecation)); - -const authenticate = require("./authenticate"); -const beforeRequest = require("./before-request"); -const requestError = require("./request-error"); - -function authenticationPlugin(octokit, options) { - if (options.auth) { - octokit.authenticate = () => { - deprecateAuthenticate( - octokit.log, - new Deprecation( - '[@octokit/rest] octokit.authenticate() is deprecated and has no effect when "auth" option is set on Octokit constructor' - ) - ); - }; - return; - } - const state = { - octokit, - auth: false - }; - octokit.authenticate = authenticate.bind(null, state); - octokit.hook.before("request", beforeRequest.bind(null, state)); - octokit.hook.error("request", requestError.bind(null, state)); -} diff --git a/node_modules/@octokit/rest/plugins/authentication-deprecated/request-error.js b/node_modules/@octokit/rest/plugins/authentication-deprecated/request-error.js deleted file mode 100644 index d2e7baa..0000000 --- a/node_modules/@octokit/rest/plugins/authentication-deprecated/request-error.js +++ /dev/null @@ -1,55 +0,0 @@ -module.exports = authenticationRequestError; - -const { RequestError } = require("@octokit/request-error"); - -function authenticationRequestError(state, error, options) { - /* istanbul ignore next */ - if (!error.headers) throw error; - - const otpRequired = /required/.test(error.headers["x-github-otp"] || ""); - // handle "2FA required" error only - if (error.status !== 401 || !otpRequired) { - throw error; - } - - if ( - error.status === 401 && - otpRequired && - error.request && - error.request.headers["x-github-otp"] - ) { - throw new RequestError( - "Invalid one-time password for two-factor authentication", - 401, - { - headers: error.headers, - request: options - } - ); - } - - if (typeof state.auth.on2fa !== "function") { - throw new RequestError( - "2FA required, but options.on2fa is not a function. See https://github.com/octokit/rest.js#authentication", - 401, - { - headers: error.headers, - request: options - } - ); - } - - return Promise.resolve() - .then(() => { - return state.auth.on2fa(); - }) - .then(oneTimePassword => { - const newOptions = Object.assign(options, { - headers: Object.assign( - { "x-github-otp": oneTimePassword }, - options.headers - ) - }); - return state.octokit.request(newOptions); - }); -} diff --git a/node_modules/@octokit/rest/plugins/authentication/before-request.js b/node_modules/@octokit/rest/plugins/authentication/before-request.js deleted file mode 100644 index c18df95..0000000 --- a/node_modules/@octokit/rest/plugins/authentication/before-request.js +++ /dev/null @@ -1,65 +0,0 @@ -module.exports = authenticationBeforeRequest; - -const btoa = require("btoa-lite"); - -const withAuthorizationPrefix = require("./with-authorization-prefix"); - -function authenticationBeforeRequest(state, options) { - if (typeof state.auth === "string") { - options.headers.authorization = withAuthorizationPrefix(state.auth); - - // https://developer.github.com/v3/previews/#integrations - if ( - /^bearer /i.test(state.auth) && - !/machine-man/.test(options.headers.accept) - ) { - const acceptHeaders = options.headers.accept - .split(",") - .concat("application/vnd.github.machine-man-preview+json"); - options.headers.accept = acceptHeaders.filter(Boolean).join(","); - } - - return; - } - - if (state.auth.username) { - const hash = btoa(`${state.auth.username}:${state.auth.password}`); - options.headers.authorization = `Basic ${hash}`; - if (state.otp) { - options.headers["x-github-otp"] = state.otp; - } - return; - } - - if (state.auth.clientId) { - // There is a special case for OAuth applications, when `clientId` and `clientSecret` is passed as - // Basic Authorization instead of query parameters. The only routes where that applies share the same - // URL though: `/applications/:client_id/tokens/:access_token`. - // - // 1. [Check an authorization](https://developer.github.com/v3/oauth_authorizations/#check-an-authorization) - // 2. [Reset an authorization](https://developer.github.com/v3/oauth_authorizations/#reset-an-authorization) - // 3. [Revoke an authorization for an application](https://developer.github.com/v3/oauth_authorizations/#revoke-an-authorization-for-an-application) - // - // We identify by checking the URL. It must merge both "/applications/:client_id/tokens/:access_token" - // as well as "/applications/123/tokens/token456" - if (/\/applications\/:?[\w_]+\/tokens\/:?[\w_]+($|\?)/.test(options.url)) { - const hash = btoa(`${state.auth.clientId}:${state.auth.clientSecret}`); - options.headers.authorization = `Basic ${hash}`; - return; - } - - options.url += options.url.indexOf("?") === -1 ? "?" : "&"; - options.url += `client_id=${state.auth.clientId}&client_secret=${state.auth.clientSecret}`; - return; - } - - return Promise.resolve() - - .then(() => { - return state.auth(); - }) - - .then(authorization => { - options.headers.authorization = withAuthorizationPrefix(authorization); - }); -} diff --git a/node_modules/@octokit/rest/plugins/authentication/index.js b/node_modules/@octokit/rest/plugins/authentication/index.js deleted file mode 100644 index 6a51d42..0000000 --- a/node_modules/@octokit/rest/plugins/authentication/index.js +++ /dev/null @@ -1,21 +0,0 @@ -module.exports = authenticationPlugin; - -const beforeRequest = require("./before-request"); -const requestError = require("./request-error"); -const validate = require("./validate"); - -function authenticationPlugin(octokit, options) { - if (!options.auth) { - return; - } - - validate(options.auth); - - const state = { - octokit, - auth: options.auth - }; - - octokit.hook.before("request", beforeRequest.bind(null, state)); - octokit.hook.error("request", requestError.bind(null, state)); -} diff --git a/node_modules/@octokit/rest/plugins/authentication/request-error.js b/node_modules/@octokit/rest/plugins/authentication/request-error.js deleted file mode 100644 index 9c67d55..0000000 --- a/node_modules/@octokit/rest/plugins/authentication/request-error.js +++ /dev/null @@ -1,61 +0,0 @@ -module.exports = authenticationRequestError; - -const { RequestError } = require("@octokit/request-error"); - -function authenticationRequestError(state, error, options) { - if (!error.headers) throw error; - - const otpRequired = /required/.test(error.headers["x-github-otp"] || ""); - // handle "2FA required" error only - if (error.status !== 401 || !otpRequired) { - throw error; - } - - if ( - error.status === 401 && - otpRequired && - error.request && - error.request.headers["x-github-otp"] - ) { - if (state.otp) { - delete state.otp; // no longer valid, request again - } else { - throw new RequestError( - "Invalid one-time password for two-factor authentication", - 401, - { - headers: error.headers, - request: options - } - ); - } - } - - if (typeof state.auth.on2fa !== "function") { - throw new RequestError( - "2FA required, but options.on2fa is not a function. See https://github.com/octokit/rest.js#authentication", - 401, - { - headers: error.headers, - request: options - } - ); - } - - return Promise.resolve() - .then(() => { - return state.auth.on2fa(); - }) - .then(oneTimePassword => { - const newOptions = Object.assign(options, { - headers: Object.assign(options.headers, { - "x-github-otp": oneTimePassword - }) - }); - return state.octokit.request(newOptions).then(response => { - // If OTP still valid, then persist it for following requests - state.otp = oneTimePassword; - return response; - }); - }); -} diff --git a/node_modules/@octokit/rest/plugins/authentication/validate.js b/node_modules/@octokit/rest/plugins/authentication/validate.js deleted file mode 100644 index abf8377..0000000 --- a/node_modules/@octokit/rest/plugins/authentication/validate.js +++ /dev/null @@ -1,21 +0,0 @@ -module.exports = validateAuth; - -function validateAuth(auth) { - if (typeof auth === "string") { - return; - } - - if (typeof auth === "function") { - return; - } - - if (auth.username && auth.password) { - return; - } - - if (auth.clientId && auth.clientSecret) { - return; - } - - throw new Error(`Invalid "auth" option: ${JSON.stringify(auth)}`); -} diff --git a/node_modules/@octokit/rest/plugins/authentication/with-authorization-prefix.js b/node_modules/@octokit/rest/plugins/authentication/with-authorization-prefix.js deleted file mode 100644 index 122cab7..0000000 --- a/node_modules/@octokit/rest/plugins/authentication/with-authorization-prefix.js +++ /dev/null @@ -1,23 +0,0 @@ -module.exports = withAuthorizationPrefix; - -const atob = require("atob-lite"); - -const REGEX_IS_BASIC_AUTH = /^[\w-]+:/; - -function withAuthorizationPrefix(authorization) { - if (/^(basic|bearer|token) /i.test(authorization)) { - return authorization; - } - - try { - if (REGEX_IS_BASIC_AUTH.test(atob(authorization))) { - return `basic ${authorization}`; - } - } catch (error) {} - - if (authorization.split(/\./).length === 3) { - return `bearer ${authorization}`; - } - - return `token ${authorization}`; -} diff --git a/node_modules/@octokit/rest/plugins/log/index.js b/node_modules/@octokit/rest/plugins/log/index.js deleted file mode 100644 index fed446a..0000000 --- a/node_modules/@octokit/rest/plugins/log/index.js +++ /dev/null @@ -1,28 +0,0 @@ -module.exports = octokitDebug; - -function octokitDebug(octokit) { - octokit.hook.wrap("request", (request, options) => { - octokit.log.debug("request", options); - const start = Date.now(); - const requestOptions = octokit.request.endpoint.parse(options); - const path = requestOptions.url.replace(options.baseUrl, ""); - - return request(options) - .then(response => { - octokit.log.info( - `${requestOptions.method} ${path} - ${ - response.status - } in ${Date.now() - start}ms` - ); - return response; - }) - - .catch(error => { - octokit.log.info( - `${requestOptions.method} ${path} - ${error.status} in ${Date.now() - - start}ms` - ); - throw error; - }); - }); -} diff --git a/node_modules/@octokit/rest/plugins/pagination/index.js b/node_modules/@octokit/rest/plugins/pagination/index.js deleted file mode 100644 index e7673bc..0000000 --- a/node_modules/@octokit/rest/plugins/pagination/index.js +++ /dev/null @@ -1,9 +0,0 @@ -module.exports = paginatePlugin; - -const iterator = require("./iterator"); -const paginate = require("./paginate"); - -function paginatePlugin(octokit) { - octokit.paginate = paginate.bind(null, octokit); - octokit.paginate.iterator = iterator.bind(null, octokit); -} diff --git a/node_modules/@octokit/rest/plugins/pagination/iterator.js b/node_modules/@octokit/rest/plugins/pagination/iterator.js deleted file mode 100644 index 00ea8eb..0000000 --- a/node_modules/@octokit/rest/plugins/pagination/iterator.js +++ /dev/null @@ -1,34 +0,0 @@ -module.exports = iterator; - -const normalizePaginatedListResponse = require("./normalize-paginated-list-response"); - -function iterator(octokit, options) { - const headers = options.headers; - let url = octokit.request.endpoint(options).url; - - return { - [Symbol.asyncIterator]: () => ({ - next() { - if (!url) { - return Promise.resolve({ done: true }); - } - - return octokit - .request({ url, headers }) - - .then(response => { - normalizePaginatedListResponse(octokit, url, response); - - // `response.headers.link` format: - // '; rel="next", ; rel="last"' - // sets `url` to undefined if "next" URL is not present or `link` header is not set - url = ((response.headers.link || "").match( - /<([^>]+)>;\s*rel="next"/ - ) || [])[1]; - - return { value: response }; - }); - } - }) - }; -} diff --git a/node_modules/@octokit/rest/plugins/pagination/normalize-paginated-list-response.js b/node_modules/@octokit/rest/plugins/pagination/normalize-paginated-list-response.js deleted file mode 100644 index e664142..0000000 --- a/node_modules/@octokit/rest/plugins/pagination/normalize-paginated-list-response.js +++ /dev/null @@ -1,116 +0,0 @@ -/** - * Some “list” response that can be paginated have a different response structure - * - * They have a `total_count` key in the response (search also has `incomplete_results`, - * /installation/repositories also has `repository_selection`), as well as a key with - * the list of the items which name varies from endpoint to endpoint: - * - * - https://developer.github.com/v3/search/#example (key `items`) - * - https://developer.github.com/v3/checks/runs/#response-3 (key: `check_runs`) - * - https://developer.github.com/v3/checks/suites/#response-1 (key: `check_suites`) - * - https://developer.github.com/v3/apps/installations/#list-repositories (key: `repositories`) - * - https://developer.github.com/v3/apps/installations/#list-installations-for-a-user (key `installations`) - * - https://developer.github.com/v3/orgs/#list-installations-for-an-organization (key `installations`) - * - * Octokit normalizes these responses so that paginated results are always returned following - * the same structure. One challenge is that if the list response has only one page, no Link - * header is provided, so this header alone is not sufficient to check wether a response is - * paginated or not. For the exceptions with the namespace, a fallback check for the route - * paths has to be added in order to normalize the response. We cannot check for the total_count - * property because it also exists in the response of Get the combined status for a specific ref. - */ - -module.exports = normalizePaginatedListResponse; - -const { Deprecation } = require("deprecation"); -const once = require("once"); - -const deprecateIncompleteResults = once((log, deprecation) => - log.warn(deprecation) -); -const deprecateTotalCount = once((log, deprecation) => log.warn(deprecation)); -const deprecateNamespace = once((log, deprecation) => log.warn(deprecation)); - -const REGEX_IS_SEARCH_PATH = /^\/search\//; -const REGEX_IS_CHECKS_PATH = /^\/repos\/[^/]+\/[^/]+\/commits\/[^/]+\/(check-runs|check-suites)/; -const REGEX_IS_INSTALLATION_REPOSITORIES_PATH = /^\/installation\/repositories/; -const REGEX_IS_USER_INSTALLATIONS_PATH = /^\/user\/installations/; -const REGEX_IS_ORG_INSTALLATIONS_PATH = /^\/orgs\/[^/]+\/installations/; - -function normalizePaginatedListResponse(octokit, url, response) { - const path = url.replace(octokit.request.endpoint.DEFAULTS.baseUrl, ""); - if ( - !REGEX_IS_SEARCH_PATH.test(path) && - !REGEX_IS_CHECKS_PATH.test(path) && - !REGEX_IS_INSTALLATION_REPOSITORIES_PATH.test(path) && - !REGEX_IS_USER_INSTALLATIONS_PATH.test(path) && - !REGEX_IS_ORG_INSTALLATIONS_PATH.test(path) - ) { - return; - } - - // keep the additional properties intact to avoid a breaking change, - // but log a deprecation warning when accessed - const incompleteResults = response.data.incomplete_results; - const repositorySelection = response.data.repository_selection; - const totalCount = response.data.total_count; - delete response.data.incomplete_results; - delete response.data.repository_selection; - delete response.data.total_count; - - const namespaceKey = Object.keys(response.data)[0]; - - response.data = response.data[namespaceKey]; - - Object.defineProperty(response.data, namespaceKey, { - get() { - deprecateNamespace( - octokit.log, - new Deprecation( - `[@octokit/rest] "result.data.${namespaceKey}" is deprecated. Use "result.data" instead` - ) - ); - return response.data; - } - }); - - if (typeof incompleteResults !== "undefined") { - Object.defineProperty(response.data, "incomplete_results", { - get() { - deprecateIncompleteResults( - octokit.log, - new Deprecation( - '[@octokit/rest] "result.data.incomplete_results" is deprecated.' - ) - ); - return incompleteResults; - } - }); - } - - if (typeof repositorySelection !== "undefined") { - Object.defineProperty(response.data, "repository_selection", { - get() { - deprecateTotalCount( - octokit.log, - new Deprecation( - '[@octokit/rest] "result.data.repository_selection" is deprecated.' - ) - ); - return repositorySelection; - } - }); - } - - Object.defineProperty(response.data, "total_count", { - get() { - deprecateTotalCount( - octokit.log, - new Deprecation( - '[@octokit/rest] "result.data.total_count" is deprecated.' - ) - ); - return totalCount; - } - }); -} diff --git a/node_modules/@octokit/rest/plugins/pagination/paginate.js b/node_modules/@octokit/rest/plugins/pagination/paginate.js deleted file mode 100644 index db4752b..0000000 --- a/node_modules/@octokit/rest/plugins/pagination/paginate.js +++ /dev/null @@ -1,40 +0,0 @@ -module.exports = paginate; - -const iterator = require("./iterator"); - -function paginate(octokit, route, options, mapFn) { - if (typeof options === "function") { - mapFn = options; - options = undefined; - } - options = octokit.request.endpoint.merge(route, options); - return gather( - octokit, - [], - iterator(octokit, options)[Symbol.asyncIterator](), - mapFn - ); -} - -function gather(octokit, results, iterator, mapFn) { - return iterator.next().then(result => { - if (result.done) { - return results; - } - - let earlyExit = false; - function done() { - earlyExit = true; - } - - results = results.concat( - mapFn ? mapFn(result.value, done) : result.value.data - ); - - if (earlyExit) { - return results; - } - - return gather(octokit, results, iterator, mapFn); - }); -} diff --git a/node_modules/@octokit/rest/plugins/register-endpoints/index.js b/node_modules/@octokit/rest/plugins/register-endpoints/index.js deleted file mode 100644 index 8b92538..0000000 --- a/node_modules/@octokit/rest/plugins/register-endpoints/index.js +++ /dev/null @@ -1,7 +0,0 @@ -module.exports = octokitRegisterEndpoints; - -const registerEndpoints = require("./register-endpoints"); - -function octokitRegisterEndpoints(octokit) { - octokit.registerEndpoints = registerEndpoints.bind(null, octokit); -} diff --git a/node_modules/@octokit/rest/plugins/register-endpoints/register-endpoints.js b/node_modules/@octokit/rest/plugins/register-endpoints/register-endpoints.js deleted file mode 100644 index 0ffd784..0000000 --- a/node_modules/@octokit/rest/plugins/register-endpoints/register-endpoints.js +++ /dev/null @@ -1,98 +0,0 @@ -module.exports = registerEndpoints; - -const { Deprecation } = require("deprecation"); - -function registerEndpoints(octokit, routes) { - Object.keys(routes).forEach(namespaceName => { - if (!octokit[namespaceName]) { - octokit[namespaceName] = {}; - } - - Object.keys(routes[namespaceName]).forEach(apiName => { - const apiOptions = routes[namespaceName][apiName]; - - const endpointDefaults = ["method", "url", "headers"].reduce( - (map, key) => { - if (typeof apiOptions[key] !== "undefined") { - map[key] = apiOptions[key]; - } - - return map; - }, - {} - ); - - endpointDefaults.request = { - validate: apiOptions.params - }; - - let request = octokit.request.defaults(endpointDefaults); - - // patch request & endpoint methods to support deprecated parameters. - // Not the most elegant solution, but we don’t want to move deprecation - // logic into octokit/endpoint.js as it’s out of scope - const hasDeprecatedParam = Object.keys(apiOptions.params || {}).find( - key => apiOptions.params[key].deprecated - ); - if (hasDeprecatedParam) { - const patch = patchForDeprecation.bind(null, octokit, apiOptions); - request = patch( - octokit.request.defaults(endpointDefaults), - `.${namespaceName}.${apiName}()` - ); - request.endpoint = patch( - request.endpoint, - `.${namespaceName}.${apiName}.endpoint()` - ); - request.endpoint.merge = patch( - request.endpoint.merge, - `.${namespaceName}.${apiName}.endpoint.merge()` - ); - } - - if (apiOptions.deprecated) { - octokit[namespaceName][apiName] = function deprecatedEndpointMethod() { - octokit.log.warn( - new Deprecation(`[@octokit/rest] ${apiOptions.deprecated}`) - ); - octokit[namespaceName][apiName] = request; - return request.apply(null, arguments); - }; - - return; - } - - octokit[namespaceName][apiName] = request; - }); - }); -} - -function patchForDeprecation(octokit, apiOptions, method, methodName) { - const patchedMethod = options => { - options = Object.assign({}, options); - - Object.keys(options).forEach(key => { - if (apiOptions.params[key] && apiOptions.params[key].deprecated) { - const aliasKey = apiOptions.params[key].alias; - - octokit.log.warn( - new Deprecation( - `[@octokit/rest] "${key}" parameter is deprecated for "${methodName}". Use "${aliasKey}" instead` - ) - ); - - if (!(aliasKey in options)) { - options[aliasKey] = options[key]; - } - delete options[key]; - } - }); - - return method(options); - }; - Object.keys(method).forEach(key => { - patchedMethod[key] = method[key]; - }); - - return patchedMethod; -} diff --git a/node_modules/@octokit/rest/plugins/rest-api-endpoints/index.js b/node_modules/@octokit/rest/plugins/rest-api-endpoints/index.js deleted file mode 100644 index 4835cee..0000000 --- a/node_modules/@octokit/rest/plugins/rest-api-endpoints/index.js +++ /dev/null @@ -1,13 +0,0 @@ -module.exports = octokitRestApiEndpoints; - -const ROUTES = require("./routes.json"); - -function octokitRestApiEndpoints(octokit) { - // Aliasing scopes for backward compatibility - // See https://github.com/octokit/rest.js/pull/1134 - ROUTES.gitdata = ROUTES.git; - ROUTES.authorization = ROUTES.oauthAuthorizations; - ROUTES.pullRequests = ROUTES.pulls; - - octokit.registerEndpoints(ROUTES); -} diff --git a/node_modules/@octokit/rest/plugins/rest-api-endpoints/routes.json b/node_modules/@octokit/rest/plugins/rest-api-endpoints/routes.json deleted file mode 100644 index 31e3fca..0000000 --- a/node_modules/@octokit/rest/plugins/rest-api-endpoints/routes.json +++ /dev/null @@ -1,5927 +0,0 @@ -{ - "activity": { - "checkStarringRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/user/starred/:owner/:repo" - }, - "deleteRepoSubscription": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/subscription" - }, - "deleteThreadSubscription": { - "method": "DELETE", - "params": { "thread_id": { "required": true, "type": "integer" } }, - "url": "/notifications/threads/:thread_id/subscription" - }, - "getRepoSubscription": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/subscription" - }, - "getThread": { - "method": "GET", - "params": { "thread_id": { "required": true, "type": "integer" } }, - "url": "/notifications/threads/:thread_id" - }, - "getThreadSubscription": { - "method": "GET", - "params": { "thread_id": { "required": true, "type": "integer" } }, - "url": "/notifications/threads/:thread_id/subscription" - }, - "listEventsForOrg": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/events/orgs/:org" - }, - "listEventsForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/events" - }, - "listFeeds": { "method": "GET", "params": {}, "url": "/feeds" }, - "listNotifications": { - "method": "GET", - "params": { - "all": { "type": "boolean" }, - "before": { "type": "string" }, - "page": { "type": "integer" }, - "participating": { "type": "boolean" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/notifications" - }, - "listNotificationsForRepo": { - "method": "GET", - "params": { - "all": { "type": "boolean" }, - "before": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "participating": { "type": "boolean" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" } - }, - "url": "/repos/:owner/:repo/notifications" - }, - "listPublicEvents": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/events" - }, - "listPublicEventsForOrg": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/events" - }, - "listPublicEventsForRepoNetwork": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/networks/:owner/:repo/events" - }, - "listPublicEventsForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/events/public" - }, - "listReceivedEventsForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/received_events" - }, - "listReceivedPublicEventsForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/received_events/public" - }, - "listRepoEvents": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/events" - }, - "listReposStarredByAuthenticatedUser": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/user/starred" - }, - "listReposStarredByUser": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "sort": { "enum": ["created", "updated"], "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/starred" - }, - "listReposWatchedByUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/subscriptions" - }, - "listStargazersForRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/stargazers" - }, - "listWatchedReposForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/subscriptions" - }, - "listWatchersForRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/subscribers" - }, - "markAsRead": { - "method": "PUT", - "params": { "last_read_at": { "type": "string" } }, - "url": "/notifications" - }, - "markNotificationsAsReadForRepo": { - "method": "PUT", - "params": { - "last_read_at": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/notifications" - }, - "markThreadAsRead": { - "method": "PATCH", - "params": { "thread_id": { "required": true, "type": "integer" } }, - "url": "/notifications/threads/:thread_id" - }, - "setRepoSubscription": { - "method": "PUT", - "params": { - "ignored": { "type": "boolean" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "subscribed": { "type": "boolean" } - }, - "url": "/repos/:owner/:repo/subscription" - }, - "setThreadSubscription": { - "method": "PUT", - "params": { - "ignored": { "type": "boolean" }, - "thread_id": { "required": true, "type": "integer" } - }, - "url": "/notifications/threads/:thread_id/subscription" - }, - "starRepo": { - "method": "PUT", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/user/starred/:owner/:repo" - }, - "unstarRepo": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/user/starred/:owner/:repo" - } - }, - "apps": { - "addRepoToInstallation": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "PUT", - "params": { - "installation_id": { "required": true, "type": "integer" }, - "repository_id": { "required": true, "type": "integer" } - }, - "url": "/user/installations/:installation_id/repositories/:repository_id" - }, - "checkAccountIsAssociatedWithAny": { - "method": "GET", - "params": { - "account_id": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/marketplace_listing/accounts/:account_id" - }, - "checkAccountIsAssociatedWithAnyStubbed": { - "method": "GET", - "params": { - "account_id": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/marketplace_listing/stubbed/accounts/:account_id" - }, - "checkAuthorization": { - "deprecated": "octokit.oauthAuthorizations.checkAuthorization() has been renamed to octokit.apps.checkAuthorization() (2019-11-05)", - "method": "GET", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/tokens/:access_token" - }, - "checkToken": { - "headers": { - "accept": "application/vnd.github.doctor-strange-preview+json" - }, - "method": "POST", - "params": { - "access_token": { "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/token" - }, - "createContentAttachment": { - "headers": { "accept": "application/vnd.github.corsair-preview+json" }, - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "content_reference_id": { "required": true, "type": "integer" }, - "title": { "required": true, "type": "string" } - }, - "url": "/content_references/:content_reference_id/attachments" - }, - "createFromManifest": { - "headers": { "accept": "application/vnd.github.fury-preview+json" }, - "method": "POST", - "params": { "code": { "required": true, "type": "string" } }, - "url": "/app-manifests/:code/conversions" - }, - "createInstallationToken": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "POST", - "params": { - "installation_id": { "required": true, "type": "integer" }, - "permissions": { "type": "object" }, - "repository_ids": { "type": "integer[]" } - }, - "url": "/app/installations/:installation_id/access_tokens" - }, - "deleteAuthorization": { - "headers": { - "accept": "application/vnd.github.doctor-strange-preview+json" - }, - "method": "DELETE", - "params": { - "access_token": { "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/grant" - }, - "deleteInstallation": { - "headers": { - "accept": "application/vnd.github.gambit-preview+json,application/vnd.github.machine-man-preview+json" - }, - "method": "DELETE", - "params": { "installation_id": { "required": true, "type": "integer" } }, - "url": "/app/installations/:installation_id" - }, - "deleteToken": { - "headers": { - "accept": "application/vnd.github.doctor-strange-preview+json" - }, - "method": "DELETE", - "params": { - "access_token": { "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/token" - }, - "findOrgInstallation": { - "deprecated": "octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() (2019-04-10)", - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/orgs/:org/installation" - }, - "findRepoInstallation": { - "deprecated": "octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() (2019-04-10)", - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/installation" - }, - "findUserInstallation": { - "deprecated": "octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() (2019-04-10)", - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/users/:username/installation" - }, - "getAuthenticated": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": {}, - "url": "/app" - }, - "getBySlug": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { "app_slug": { "required": true, "type": "string" } }, - "url": "/apps/:app_slug" - }, - "getInstallation": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { "installation_id": { "required": true, "type": "integer" } }, - "url": "/app/installations/:installation_id" - }, - "getOrgInstallation": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/orgs/:org/installation" - }, - "getRepoInstallation": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/installation" - }, - "getUserInstallation": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/users/:username/installation" - }, - "listAccountsUserOrOrgOnPlan": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "plan_id": { "required": true, "type": "integer" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/marketplace_listing/plans/:plan_id/accounts" - }, - "listAccountsUserOrOrgOnPlanStubbed": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "plan_id": { "required": true, "type": "integer" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/marketplace_listing/stubbed/plans/:plan_id/accounts" - }, - "listInstallationReposForAuthenticatedUser": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "installation_id": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/installations/:installation_id/repositories" - }, - "listInstallations": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/app/installations" - }, - "listInstallationsForAuthenticatedUser": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/installations" - }, - "listMarketplacePurchasesForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/marketplace_purchases" - }, - "listMarketplacePurchasesForAuthenticatedUserStubbed": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/marketplace_purchases/stubbed" - }, - "listPlans": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/marketplace_listing/plans" - }, - "listPlansStubbed": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/marketplace_listing/stubbed/plans" - }, - "listRepos": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/installation/repositories" - }, - "removeRepoFromInstallation": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "DELETE", - "params": { - "installation_id": { "required": true, "type": "integer" }, - "repository_id": { "required": true, "type": "integer" } - }, - "url": "/user/installations/:installation_id/repositories/:repository_id" - }, - "resetAuthorization": { - "deprecated": "octokit.oauthAuthorizations.resetAuthorization() has been renamed to octokit.apps.resetAuthorization() (2019-11-05)", - "method": "POST", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/tokens/:access_token" - }, - "resetToken": { - "headers": { - "accept": "application/vnd.github.doctor-strange-preview+json" - }, - "method": "PATCH", - "params": { - "access_token": { "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/token" - }, - "revokeAuthorizationForApplication": { - "deprecated": "octokit.oauthAuthorizations.revokeAuthorizationForApplication() has been renamed to octokit.apps.revokeAuthorizationForApplication() (2019-11-05)", - "method": "DELETE", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/tokens/:access_token" - }, - "revokeGrantForApplication": { - "deprecated": "octokit.oauthAuthorizations.revokeGrantForApplication() has been renamed to octokit.apps.revokeGrantForApplication() (2019-11-05)", - "method": "DELETE", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/grants/:access_token" - } - }, - "checks": { - "create": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "POST", - "params": { - "actions": { "type": "object[]" }, - "actions[].description": { "required": true, "type": "string" }, - "actions[].identifier": { "required": true, "type": "string" }, - "actions[].label": { "required": true, "type": "string" }, - "completed_at": { "type": "string" }, - "conclusion": { - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required" - ], - "type": "string" - }, - "details_url": { "type": "string" }, - "external_id": { "type": "string" }, - "head_sha": { "required": true, "type": "string" }, - "name": { "required": true, "type": "string" }, - "output": { "type": "object" }, - "output.annotations": { "type": "object[]" }, - "output.annotations[].annotation_level": { - "enum": ["notice", "warning", "failure"], - "required": true, - "type": "string" - }, - "output.annotations[].end_column": { "type": "integer" }, - "output.annotations[].end_line": { - "required": true, - "type": "integer" - }, - "output.annotations[].message": { "required": true, "type": "string" }, - "output.annotations[].path": { "required": true, "type": "string" }, - "output.annotations[].raw_details": { "type": "string" }, - "output.annotations[].start_column": { "type": "integer" }, - "output.annotations[].start_line": { - "required": true, - "type": "integer" - }, - "output.annotations[].title": { "type": "string" }, - "output.images": { "type": "object[]" }, - "output.images[].alt": { "required": true, "type": "string" }, - "output.images[].caption": { "type": "string" }, - "output.images[].image_url": { "required": true, "type": "string" }, - "output.summary": { "required": true, "type": "string" }, - "output.text": { "type": "string" }, - "output.title": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "started_at": { "type": "string" }, - "status": { - "enum": ["queued", "in_progress", "completed"], - "type": "string" - } - }, - "url": "/repos/:owner/:repo/check-runs" - }, - "createSuite": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "POST", - "params": { - "head_sha": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/check-suites" - }, - "get": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "GET", - "params": { - "check_run_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/check-runs/:check_run_id" - }, - "getSuite": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "GET", - "params": { - "check_suite_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/check-suites/:check_suite_id" - }, - "listAnnotations": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "GET", - "params": { - "check_run_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/check-runs/:check_run_id/annotations" - }, - "listForRef": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "GET", - "params": { - "check_name": { "type": "string" }, - "filter": { "enum": ["latest", "all"], "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "status": { - "enum": ["queued", "in_progress", "completed"], - "type": "string" - } - }, - "url": "/repos/:owner/:repo/commits/:ref/check-runs" - }, - "listForSuite": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "GET", - "params": { - "check_name": { "type": "string" }, - "check_suite_id": { "required": true, "type": "integer" }, - "filter": { "enum": ["latest", "all"], "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "status": { - "enum": ["queued", "in_progress", "completed"], - "type": "string" - } - }, - "url": "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs" - }, - "listSuitesForRef": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "GET", - "params": { - "app_id": { "type": "integer" }, - "check_name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:ref/check-suites" - }, - "rerequestSuite": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "POST", - "params": { - "check_suite_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest" - }, - "setSuitesPreferences": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "PATCH", - "params": { - "auto_trigger_checks": { "type": "object[]" }, - "auto_trigger_checks[].app_id": { "required": true, "type": "integer" }, - "auto_trigger_checks[].setting": { - "required": true, - "type": "boolean" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/check-suites/preferences" - }, - "update": { - "headers": { "accept": "application/vnd.github.antiope-preview+json" }, - "method": "PATCH", - "params": { - "actions": { "type": "object[]" }, - "actions[].description": { "required": true, "type": "string" }, - "actions[].identifier": { "required": true, "type": "string" }, - "actions[].label": { "required": true, "type": "string" }, - "check_run_id": { "required": true, "type": "integer" }, - "completed_at": { "type": "string" }, - "conclusion": { - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required" - ], - "type": "string" - }, - "details_url": { "type": "string" }, - "external_id": { "type": "string" }, - "name": { "type": "string" }, - "output": { "type": "object" }, - "output.annotations": { "type": "object[]" }, - "output.annotations[].annotation_level": { - "enum": ["notice", "warning", "failure"], - "required": true, - "type": "string" - }, - "output.annotations[].end_column": { "type": "integer" }, - "output.annotations[].end_line": { - "required": true, - "type": "integer" - }, - "output.annotations[].message": { "required": true, "type": "string" }, - "output.annotations[].path": { "required": true, "type": "string" }, - "output.annotations[].raw_details": { "type": "string" }, - "output.annotations[].start_column": { "type": "integer" }, - "output.annotations[].start_line": { - "required": true, - "type": "integer" - }, - "output.annotations[].title": { "type": "string" }, - "output.images": { "type": "object[]" }, - "output.images[].alt": { "required": true, "type": "string" }, - "output.images[].caption": { "type": "string" }, - "output.images[].image_url": { "required": true, "type": "string" }, - "output.summary": { "required": true, "type": "string" }, - "output.text": { "type": "string" }, - "output.title": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "started_at": { "type": "string" }, - "status": { - "enum": ["queued", "in_progress", "completed"], - "type": "string" - } - }, - "url": "/repos/:owner/:repo/check-runs/:check_run_id" - } - }, - "codesOfConduct": { - "getConductCode": { - "headers": { - "accept": "application/vnd.github.scarlet-witch-preview+json" - }, - "method": "GET", - "params": { "key": { "required": true, "type": "string" } }, - "url": "/codes_of_conduct/:key" - }, - "getForRepo": { - "headers": { - "accept": "application/vnd.github.scarlet-witch-preview+json" - }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/community/code_of_conduct" - }, - "listConductCodes": { - "headers": { - "accept": "application/vnd.github.scarlet-witch-preview+json" - }, - "method": "GET", - "params": {}, - "url": "/codes_of_conduct" - } - }, - "emojis": { "get": { "method": "GET", "params": {}, "url": "/emojis" } }, - "gists": { - "checkIsStarred": { - "method": "GET", - "params": { "gist_id": { "required": true, "type": "string" } }, - "url": "/gists/:gist_id/star" - }, - "create": { - "method": "POST", - "params": { - "description": { "type": "string" }, - "files": { "required": true, "type": "object" }, - "files.content": { "type": "string" }, - "public": { "type": "boolean" } - }, - "url": "/gists" - }, - "createComment": { - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "gist_id": { "required": true, "type": "string" } - }, - "url": "/gists/:gist_id/comments" - }, - "delete": { - "method": "DELETE", - "params": { "gist_id": { "required": true, "type": "string" } }, - "url": "/gists/:gist_id" - }, - "deleteComment": { - "method": "DELETE", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "gist_id": { "required": true, "type": "string" } - }, - "url": "/gists/:gist_id/comments/:comment_id" - }, - "fork": { - "method": "POST", - "params": { "gist_id": { "required": true, "type": "string" } }, - "url": "/gists/:gist_id/forks" - }, - "get": { - "method": "GET", - "params": { "gist_id": { "required": true, "type": "string" } }, - "url": "/gists/:gist_id" - }, - "getComment": { - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "gist_id": { "required": true, "type": "string" } - }, - "url": "/gists/:gist_id/comments/:comment_id" - }, - "getRevision": { - "method": "GET", - "params": { - "gist_id": { "required": true, "type": "string" }, - "sha": { "required": true, "type": "string" } - }, - "url": "/gists/:gist_id/:sha" - }, - "list": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/gists" - }, - "listComments": { - "method": "GET", - "params": { - "gist_id": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/gists/:gist_id/comments" - }, - "listCommits": { - "method": "GET", - "params": { - "gist_id": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/gists/:gist_id/commits" - }, - "listForks": { - "method": "GET", - "params": { - "gist_id": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/gists/:gist_id/forks" - }, - "listPublic": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/gists/public" - }, - "listPublicForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/gists" - }, - "listStarred": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/gists/starred" - }, - "star": { - "method": "PUT", - "params": { "gist_id": { "required": true, "type": "string" } }, - "url": "/gists/:gist_id/star" - }, - "unstar": { - "method": "DELETE", - "params": { "gist_id": { "required": true, "type": "string" } }, - "url": "/gists/:gist_id/star" - }, - "update": { - "method": "PATCH", - "params": { - "description": { "type": "string" }, - "files": { "type": "object" }, - "files.content": { "type": "string" }, - "files.filename": { "type": "string" }, - "gist_id": { "required": true, "type": "string" } - }, - "url": "/gists/:gist_id" - }, - "updateComment": { - "method": "PATCH", - "params": { - "body": { "required": true, "type": "string" }, - "comment_id": { "required": true, "type": "integer" }, - "gist_id": { "required": true, "type": "string" } - }, - "url": "/gists/:gist_id/comments/:comment_id" - } - }, - "git": { - "createBlob": { - "method": "POST", - "params": { - "content": { "required": true, "type": "string" }, - "encoding": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/blobs" - }, - "createCommit": { - "method": "POST", - "params": { - "author": { "type": "object" }, - "author.date": { "type": "string" }, - "author.email": { "type": "string" }, - "author.name": { "type": "string" }, - "committer": { "type": "object" }, - "committer.date": { "type": "string" }, - "committer.email": { "type": "string" }, - "committer.name": { "type": "string" }, - "message": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "parents": { "required": true, "type": "string[]" }, - "repo": { "required": true, "type": "string" }, - "signature": { "type": "string" }, - "tree": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/commits" - }, - "createRef": { - "method": "POST", - "params": { - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/refs" - }, - "createTag": { - "method": "POST", - "params": { - "message": { "required": true, "type": "string" }, - "object": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "tag": { "required": true, "type": "string" }, - "tagger": { "type": "object" }, - "tagger.date": { "type": "string" }, - "tagger.email": { "type": "string" }, - "tagger.name": { "type": "string" }, - "type": { - "enum": ["commit", "tree", "blob"], - "required": true, - "type": "string" - } - }, - "url": "/repos/:owner/:repo/git/tags" - }, - "createTree": { - "method": "POST", - "params": { - "base_tree": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "tree": { "required": true, "type": "object[]" }, - "tree[].content": { "type": "string" }, - "tree[].mode": { - "enum": ["100644", "100755", "040000", "160000", "120000"], - "type": "string" - }, - "tree[].path": { "type": "string" }, - "tree[].sha": { "allowNull": true, "type": "string" }, - "tree[].type": { "enum": ["blob", "tree", "commit"], "type": "string" } - }, - "url": "/repos/:owner/:repo/git/trees" - }, - "deleteRef": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/refs/:ref" - }, - "getBlob": { - "method": "GET", - "params": { - "file_sha": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/blobs/:file_sha" - }, - "getCommit": { - "method": "GET", - "params": { - "commit_sha": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/commits/:commit_sha" - }, - "getRef": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/ref/:ref" - }, - "getTag": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "tag_sha": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/tags/:tag_sha" - }, - "getTree": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "recursive": { "enum": ["1"], "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "tree_sha": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/trees/:tree_sha" - }, - "listMatchingRefs": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/matching-refs/:ref" - }, - "listRefs": { - "method": "GET", - "params": { - "namespace": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/refs/:namespace" - }, - "updateRef": { - "method": "PATCH", - "params": { - "force": { "type": "boolean" }, - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/git/refs/:ref" - } - }, - "gitignore": { - "getTemplate": { - "method": "GET", - "params": { "name": { "required": true, "type": "string" } }, - "url": "/gitignore/templates/:name" - }, - "listTemplates": { - "method": "GET", - "params": {}, - "url": "/gitignore/templates" - } - }, - "interactions": { - "addOrUpdateRestrictionsForOrg": { - "headers": { "accept": "application/vnd.github.sombra-preview+json" }, - "method": "PUT", - "params": { - "limit": { - "enum": ["existing_users", "contributors_only", "collaborators_only"], - "required": true, - "type": "string" - }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/interaction-limits" - }, - "addOrUpdateRestrictionsForRepo": { - "headers": { "accept": "application/vnd.github.sombra-preview+json" }, - "method": "PUT", - "params": { - "limit": { - "enum": ["existing_users", "contributors_only", "collaborators_only"], - "required": true, - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/interaction-limits" - }, - "getRestrictionsForOrg": { - "headers": { "accept": "application/vnd.github.sombra-preview+json" }, - "method": "GET", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/orgs/:org/interaction-limits" - }, - "getRestrictionsForRepo": { - "headers": { "accept": "application/vnd.github.sombra-preview+json" }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/interaction-limits" - }, - "removeRestrictionsForOrg": { - "headers": { "accept": "application/vnd.github.sombra-preview+json" }, - "method": "DELETE", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/orgs/:org/interaction-limits" - }, - "removeRestrictionsForRepo": { - "headers": { "accept": "application/vnd.github.sombra-preview+json" }, - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/interaction-limits" - } - }, - "issues": { - "addAssignees": { - "method": "POST", - "params": { - "assignees": { "type": "string[]" }, - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/assignees" - }, - "addLabels": { - "method": "POST", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "labels": { "required": true, "type": "string[]" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/labels" - }, - "checkAssignee": { - "method": "GET", - "params": { - "assignee": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/assignees/:assignee" - }, - "create": { - "method": "POST", - "params": { - "assignee": { "type": "string" }, - "assignees": { "type": "string[]" }, - "body": { "type": "string" }, - "labels": { "type": "string[]" }, - "milestone": { "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "title": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues" - }, - "createComment": { - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/comments" - }, - "createLabel": { - "method": "POST", - "params": { - "color": { "required": true, "type": "string" }, - "description": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/labels" - }, - "createMilestone": { - "method": "POST", - "params": { - "description": { "type": "string" }, - "due_on": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "state": { "enum": ["open", "closed"], "type": "string" }, - "title": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/milestones" - }, - "deleteComment": { - "method": "DELETE", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/comments/:comment_id" - }, - "deleteLabel": { - "method": "DELETE", - "params": { - "name": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/labels/:name" - }, - "deleteMilestone": { - "method": "DELETE", - "params": { - "milestone_number": { "required": true, "type": "integer" }, - "number": { - "alias": "milestone_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/milestones/:milestone_number" - }, - "get": { - "method": "GET", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number" - }, - "getComment": { - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/comments/:comment_id" - }, - "getEvent": { - "method": "GET", - "params": { - "event_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/events/:event_id" - }, - "getLabel": { - "method": "GET", - "params": { - "name": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/labels/:name" - }, - "getMilestone": { - "method": "GET", - "params": { - "milestone_number": { "required": true, "type": "integer" }, - "number": { - "alias": "milestone_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/milestones/:milestone_number" - }, - "list": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "filter": { - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "type": "string" - }, - "labels": { "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" }, - "sort": { - "enum": ["created", "updated", "comments"], - "type": "string" - }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/issues" - }, - "listAssignees": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/assignees" - }, - "listComments": { - "method": "GET", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/comments" - }, - "listCommentsForRepo": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/comments" - }, - "listEvents": { - "method": "GET", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/events" - }, - "listEventsForRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/events" - }, - "listEventsForTimeline": { - "headers": { - "accept": "application/vnd.github.mockingbird-preview+json" - }, - "method": "GET", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/timeline" - }, - "listForAuthenticatedUser": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "filter": { - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "type": "string" - }, - "labels": { "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" }, - "sort": { - "enum": ["created", "updated", "comments"], - "type": "string" - }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/user/issues" - }, - "listForOrg": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "filter": { - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "type": "string" - }, - "labels": { "type": "string" }, - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" }, - "sort": { - "enum": ["created", "updated", "comments"], - "type": "string" - }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/orgs/:org/issues" - }, - "listForRepo": { - "method": "GET", - "params": { - "assignee": { "type": "string" }, - "creator": { "type": "string" }, - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "labels": { "type": "string" }, - "mentioned": { "type": "string" }, - "milestone": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" }, - "sort": { - "enum": ["created", "updated", "comments"], - "type": "string" - }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/repos/:owner/:repo/issues" - }, - "listLabelsForMilestone": { - "method": "GET", - "params": { - "milestone_number": { "required": true, "type": "integer" }, - "number": { - "alias": "milestone_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/milestones/:milestone_number/labels" - }, - "listLabelsForRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/labels" - }, - "listLabelsOnIssue": { - "method": "GET", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/labels" - }, - "listMilestonesForRepo": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "sort": { "enum": ["due_on", "completeness"], "type": "string" }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/repos/:owner/:repo/milestones" - }, - "lock": { - "method": "PUT", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "lock_reason": { - "enum": ["off-topic", "too heated", "resolved", "spam"], - "type": "string" - }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/lock" - }, - "removeAssignees": { - "method": "DELETE", - "params": { - "assignees": { "type": "string[]" }, - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/assignees" - }, - "removeLabel": { - "method": "DELETE", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "name": { "required": true, "type": "string" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/labels/:name" - }, - "removeLabels": { - "method": "DELETE", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/labels" - }, - "replaceLabels": { - "method": "PUT", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "labels": { "type": "string[]" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/labels" - }, - "unlock": { - "method": "DELETE", - "params": { - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/lock" - }, - "update": { - "method": "PATCH", - "params": { - "assignee": { "type": "string" }, - "assignees": { "type": "string[]" }, - "body": { "type": "string" }, - "issue_number": { "required": true, "type": "integer" }, - "labels": { "type": "string[]" }, - "milestone": { "allowNull": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "state": { "enum": ["open", "closed"], "type": "string" }, - "title": { "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number" - }, - "updateComment": { - "method": "PATCH", - "params": { - "body": { "required": true, "type": "string" }, - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/comments/:comment_id" - }, - "updateLabel": { - "method": "PATCH", - "params": { - "color": { "type": "string" }, - "current_name": { "required": true, "type": "string" }, - "description": { "type": "string" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/labels/:current_name" - }, - "updateMilestone": { - "method": "PATCH", - "params": { - "description": { "type": "string" }, - "due_on": { "type": "string" }, - "milestone_number": { "required": true, "type": "integer" }, - "number": { - "alias": "milestone_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "state": { "enum": ["open", "closed"], "type": "string" }, - "title": { "type": "string" } - }, - "url": "/repos/:owner/:repo/milestones/:milestone_number" - } - }, - "licenses": { - "get": { - "method": "GET", - "params": { "license": { "required": true, "type": "string" } }, - "url": "/licenses/:license" - }, - "getForRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/license" - }, - "list": { - "deprecated": "octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed() (2019-03-05)", - "method": "GET", - "params": {}, - "url": "/licenses" - }, - "listCommonlyUsed": { "method": "GET", "params": {}, "url": "/licenses" } - }, - "markdown": { - "render": { - "method": "POST", - "params": { - "context": { "type": "string" }, - "mode": { "enum": ["markdown", "gfm"], "type": "string" }, - "text": { "required": true, "type": "string" } - }, - "url": "/markdown" - }, - "renderRaw": { - "headers": { "content-type": "text/plain; charset=utf-8" }, - "method": "POST", - "params": { - "data": { "mapTo": "data", "required": true, "type": "string" } - }, - "url": "/markdown/raw" - } - }, - "meta": { "get": { "method": "GET", "params": {}, "url": "/meta" } }, - "migrations": { - "cancelImport": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/import" - }, - "deleteArchiveForAuthenticatedUser": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "DELETE", - "params": { "migration_id": { "required": true, "type": "integer" } }, - "url": "/user/migrations/:migration_id/archive" - }, - "deleteArchiveForOrg": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "DELETE", - "params": { - "migration_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/migrations/:migration_id/archive" - }, - "getArchiveForAuthenticatedUser": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "GET", - "params": { "migration_id": { "required": true, "type": "integer" } }, - "url": "/user/migrations/:migration_id/archive" - }, - "getArchiveForOrg": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "GET", - "params": { - "migration_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/migrations/:migration_id/archive" - }, - "getCommitAuthors": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" } - }, - "url": "/repos/:owner/:repo/import/authors" - }, - "getImportProgress": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/import" - }, - "getLargeFiles": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/import/large_files" - }, - "getStatusForAuthenticatedUser": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "GET", - "params": { "migration_id": { "required": true, "type": "integer" } }, - "url": "/user/migrations/:migration_id" - }, - "getStatusForOrg": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "GET", - "params": { - "migration_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/migrations/:migration_id" - }, - "listForAuthenticatedUser": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/migrations" - }, - "listForOrg": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/migrations" - }, - "mapCommitAuthor": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "PATCH", - "params": { - "author_id": { "required": true, "type": "integer" }, - "email": { "type": "string" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/import/authors/:author_id" - }, - "setLfsPreference": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "PATCH", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "use_lfs": { - "enum": ["opt_in", "opt_out"], - "required": true, - "type": "string" - } - }, - "url": "/repos/:owner/:repo/import/lfs" - }, - "startForAuthenticatedUser": { - "method": "POST", - "params": { - "exclude_attachments": { "type": "boolean" }, - "lock_repositories": { "type": "boolean" }, - "repositories": { "required": true, "type": "string[]" } - }, - "url": "/user/migrations" - }, - "startForOrg": { - "method": "POST", - "params": { - "exclude_attachments": { "type": "boolean" }, - "lock_repositories": { "type": "boolean" }, - "org": { "required": true, "type": "string" }, - "repositories": { "required": true, "type": "string[]" } - }, - "url": "/orgs/:org/migrations" - }, - "startImport": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "PUT", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "tfvc_project": { "type": "string" }, - "vcs": { - "enum": ["subversion", "git", "mercurial", "tfvc"], - "type": "string" - }, - "vcs_password": { "type": "string" }, - "vcs_url": { "required": true, "type": "string" }, - "vcs_username": { "type": "string" } - }, - "url": "/repos/:owner/:repo/import" - }, - "unlockRepoForAuthenticatedUser": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "DELETE", - "params": { - "migration_id": { "required": true, "type": "integer" }, - "repo_name": { "required": true, "type": "string" } - }, - "url": "/user/migrations/:migration_id/repos/:repo_name/lock" - }, - "unlockRepoForOrg": { - "headers": { "accept": "application/vnd.github.wyandotte-preview+json" }, - "method": "DELETE", - "params": { - "migration_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" }, - "repo_name": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/migrations/:migration_id/repos/:repo_name/lock" - }, - "updateImport": { - "headers": { - "accept": "application/vnd.github.barred-rock-preview+json" - }, - "method": "PATCH", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "vcs_password": { "type": "string" }, - "vcs_username": { "type": "string" } - }, - "url": "/repos/:owner/:repo/import" - } - }, - "oauthAuthorizations": { - "checkAuthorization": { - "deprecated": "octokit.oauthAuthorizations.checkAuthorization() has been renamed to octokit.apps.checkAuthorization() (2019-11-05)", - "method": "GET", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/tokens/:access_token" - }, - "createAuthorization": { - "deprecated": "octokit.oauthAuthorizations.createAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization", - "method": "POST", - "params": { - "client_id": { "type": "string" }, - "client_secret": { "type": "string" }, - "fingerprint": { "type": "string" }, - "note": { "required": true, "type": "string" }, - "note_url": { "type": "string" }, - "scopes": { "type": "string[]" } - }, - "url": "/authorizations" - }, - "deleteAuthorization": { - "deprecated": "octokit.oauthAuthorizations.deleteAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization", - "method": "DELETE", - "params": { "authorization_id": { "required": true, "type": "integer" } }, - "url": "/authorizations/:authorization_id" - }, - "deleteGrant": { - "deprecated": "octokit.oauthAuthorizations.deleteGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-a-grant", - "method": "DELETE", - "params": { "grant_id": { "required": true, "type": "integer" } }, - "url": "/applications/grants/:grant_id" - }, - "getAuthorization": { - "deprecated": "octokit.oauthAuthorizations.getAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization", - "method": "GET", - "params": { "authorization_id": { "required": true, "type": "integer" } }, - "url": "/authorizations/:authorization_id" - }, - "getGrant": { - "deprecated": "octokit.oauthAuthorizations.getGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant", - "method": "GET", - "params": { "grant_id": { "required": true, "type": "integer" } }, - "url": "/applications/grants/:grant_id" - }, - "getOrCreateAuthorizationForApp": { - "deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForApp() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app", - "method": "PUT", - "params": { - "client_id": { "required": true, "type": "string" }, - "client_secret": { "required": true, "type": "string" }, - "fingerprint": { "type": "string" }, - "note": { "type": "string" }, - "note_url": { "type": "string" }, - "scopes": { "type": "string[]" } - }, - "url": "/authorizations/clients/:client_id" - }, - "getOrCreateAuthorizationForAppAndFingerprint": { - "deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint", - "method": "PUT", - "params": { - "client_id": { "required": true, "type": "string" }, - "client_secret": { "required": true, "type": "string" }, - "fingerprint": { "required": true, "type": "string" }, - "note": { "type": "string" }, - "note_url": { "type": "string" }, - "scopes": { "type": "string[]" } - }, - "url": "/authorizations/clients/:client_id/:fingerprint" - }, - "getOrCreateAuthorizationForAppFingerprint": { - "deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() has been renamed to octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() (2018-12-27)", - "method": "PUT", - "params": { - "client_id": { "required": true, "type": "string" }, - "client_secret": { "required": true, "type": "string" }, - "fingerprint": { "required": true, "type": "string" }, - "note": { "type": "string" }, - "note_url": { "type": "string" }, - "scopes": { "type": "string[]" } - }, - "url": "/authorizations/clients/:client_id/:fingerprint" - }, - "listAuthorizations": { - "deprecated": "octokit.oauthAuthorizations.listAuthorizations() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations", - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/authorizations" - }, - "listGrants": { - "deprecated": "octokit.oauthAuthorizations.listGrants() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-grants", - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/applications/grants" - }, - "resetAuthorization": { - "deprecated": "octokit.oauthAuthorizations.resetAuthorization() has been renamed to octokit.apps.resetAuthorization() (2019-11-05)", - "method": "POST", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/tokens/:access_token" - }, - "revokeAuthorizationForApplication": { - "deprecated": "octokit.oauthAuthorizations.revokeAuthorizationForApplication() has been renamed to octokit.apps.revokeAuthorizationForApplication() (2019-11-05)", - "method": "DELETE", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/tokens/:access_token" - }, - "revokeGrantForApplication": { - "deprecated": "octokit.oauthAuthorizations.revokeGrantForApplication() has been renamed to octokit.apps.revokeGrantForApplication() (2019-11-05)", - "method": "DELETE", - "params": { - "access_token": { "required": true, "type": "string" }, - "client_id": { "required": true, "type": "string" } - }, - "url": "/applications/:client_id/grants/:access_token" - }, - "updateAuthorization": { - "deprecated": "octokit.oauthAuthorizations.updateAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization", - "method": "PATCH", - "params": { - "add_scopes": { "type": "string[]" }, - "authorization_id": { "required": true, "type": "integer" }, - "fingerprint": { "type": "string" }, - "note": { "type": "string" }, - "note_url": { "type": "string" }, - "remove_scopes": { "type": "string[]" }, - "scopes": { "type": "string[]" } - }, - "url": "/authorizations/:authorization_id" - } - }, - "orgs": { - "addOrUpdateMembership": { - "method": "PUT", - "params": { - "org": { "required": true, "type": "string" }, - "role": { "enum": ["admin", "member"], "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/memberships/:username" - }, - "blockUser": { - "method": "PUT", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/blocks/:username" - }, - "checkBlockedUser": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/blocks/:username" - }, - "checkMembership": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/members/:username" - }, - "checkPublicMembership": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/public_members/:username" - }, - "concealMembership": { - "method": "DELETE", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/public_members/:username" - }, - "convertMemberToOutsideCollaborator": { - "method": "PUT", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/outside_collaborators/:username" - }, - "createHook": { - "method": "POST", - "params": { - "active": { "type": "boolean" }, - "config": { "required": true, "type": "object" }, - "config.content_type": { "type": "string" }, - "config.insecure_ssl": { "type": "string" }, - "config.secret": { "type": "string" }, - "config.url": { "required": true, "type": "string" }, - "events": { "type": "string[]" }, - "name": { "required": true, "type": "string" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/hooks" - }, - "createInvitation": { - "method": "POST", - "params": { - "email": { "type": "string" }, - "invitee_id": { "type": "integer" }, - "org": { "required": true, "type": "string" }, - "role": { - "enum": ["admin", "direct_member", "billing_manager"], - "type": "string" - }, - "team_ids": { "type": "integer[]" } - }, - "url": "/orgs/:org/invitations" - }, - "deleteHook": { - "method": "DELETE", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/hooks/:hook_id" - }, - "get": { - "method": "GET", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/orgs/:org" - }, - "getHook": { - "method": "GET", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/hooks/:hook_id" - }, - "getMembership": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/memberships/:username" - }, - "getMembershipForAuthenticatedUser": { - "method": "GET", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/user/memberships/orgs/:org" - }, - "list": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/organizations" - }, - "listBlockedUsers": { - "method": "GET", - "params": { "org": { "required": true, "type": "string" } }, - "url": "/orgs/:org/blocks" - }, - "listForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/orgs" - }, - "listForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/orgs" - }, - "listHooks": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/hooks" - }, - "listInstallations": { - "headers": { - "accept": "application/vnd.github.machine-man-preview+json" - }, - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/installations" - }, - "listInvitationTeams": { - "method": "GET", - "params": { - "invitation_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/invitations/:invitation_id/teams" - }, - "listMembers": { - "method": "GET", - "params": { - "filter": { "enum": ["2fa_disabled", "all"], "type": "string" }, - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "role": { "enum": ["all", "admin", "member"], "type": "string" } - }, - "url": "/orgs/:org/members" - }, - "listMemberships": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "state": { "enum": ["active", "pending"], "type": "string" } - }, - "url": "/user/memberships/orgs" - }, - "listOutsideCollaborators": { - "method": "GET", - "params": { - "filter": { "enum": ["2fa_disabled", "all"], "type": "string" }, - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/outside_collaborators" - }, - "listPendingInvitations": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/invitations" - }, - "listPublicMembers": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/public_members" - }, - "pingHook": { - "method": "POST", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/hooks/:hook_id/pings" - }, - "publicizeMembership": { - "method": "PUT", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/public_members/:username" - }, - "removeMember": { - "method": "DELETE", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/members/:username" - }, - "removeMembership": { - "method": "DELETE", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/memberships/:username" - }, - "removeOutsideCollaborator": { - "method": "DELETE", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/outside_collaborators/:username" - }, - "unblockUser": { - "method": "DELETE", - "params": { - "org": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/blocks/:username" - }, - "update": { - "method": "PATCH", - "params": { - "billing_email": { "type": "string" }, - "company": { "type": "string" }, - "default_repository_permission": { - "enum": ["read", "write", "admin", "none"], - "type": "string" - }, - "description": { "type": "string" }, - "email": { "type": "string" }, - "has_organization_projects": { "type": "boolean" }, - "has_repository_projects": { "type": "boolean" }, - "location": { "type": "string" }, - "members_allowed_repository_creation_type": { - "enum": ["all", "private", "none"], - "type": "string" - }, - "members_can_create_repositories": { "type": "boolean" }, - "name": { "type": "string" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org" - }, - "updateHook": { - "method": "PATCH", - "params": { - "active": { "type": "boolean" }, - "config": { "type": "object" }, - "config.content_type": { "type": "string" }, - "config.insecure_ssl": { "type": "string" }, - "config.secret": { "type": "string" }, - "config.url": { "required": true, "type": "string" }, - "events": { "type": "string[]" }, - "hook_id": { "required": true, "type": "integer" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/hooks/:hook_id" - }, - "updateMembership": { - "method": "PATCH", - "params": { - "org": { "required": true, "type": "string" }, - "state": { "enum": ["active"], "required": true, "type": "string" } - }, - "url": "/user/memberships/orgs/:org" - } - }, - "projects": { - "addCollaborator": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "PUT", - "params": { - "permission": { "enum": ["read", "write", "admin"], "type": "string" }, - "project_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/projects/:project_id/collaborators/:username" - }, - "createCard": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "column_id": { "required": true, "type": "integer" }, - "content_id": { "type": "integer" }, - "content_type": { "type": "string" }, - "note": { "type": "string" } - }, - "url": "/projects/columns/:column_id/cards" - }, - "createColumn": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "name": { "required": true, "type": "string" }, - "project_id": { "required": true, "type": "integer" } - }, - "url": "/projects/:project_id/columns" - }, - "createForAuthenticatedUser": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "body": { "type": "string" }, - "name": { "required": true, "type": "string" } - }, - "url": "/user/projects" - }, - "createForOrg": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "body": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "org": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/projects" - }, - "createForRepo": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "body": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/projects" - }, - "delete": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "DELETE", - "params": { "project_id": { "required": true, "type": "integer" } }, - "url": "/projects/:project_id" - }, - "deleteCard": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "DELETE", - "params": { "card_id": { "required": true, "type": "integer" } }, - "url": "/projects/columns/cards/:card_id" - }, - "deleteColumn": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "DELETE", - "params": { "column_id": { "required": true, "type": "integer" } }, - "url": "/projects/columns/:column_id" - }, - "get": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "project_id": { "required": true, "type": "integer" } - }, - "url": "/projects/:project_id" - }, - "getCard": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { "card_id": { "required": true, "type": "integer" } }, - "url": "/projects/columns/cards/:card_id" - }, - "getColumn": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { "column_id": { "required": true, "type": "integer" } }, - "url": "/projects/columns/:column_id" - }, - "listCards": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "archived_state": { - "enum": ["all", "archived", "not_archived"], - "type": "string" - }, - "column_id": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/projects/columns/:column_id/cards" - }, - "listCollaborators": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "affiliation": { - "enum": ["outside", "direct", "all"], - "type": "string" - }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "project_id": { "required": true, "type": "integer" } - }, - "url": "/projects/:project_id/collaborators" - }, - "listColumns": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "project_id": { "required": true, "type": "integer" } - }, - "url": "/projects/:project_id/columns" - }, - "listForOrg": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/orgs/:org/projects" - }, - "listForRepo": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/repos/:owner/:repo/projects" - }, - "listForUser": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "state": { "enum": ["open", "closed", "all"], "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/projects" - }, - "moveCard": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "card_id": { "required": true, "type": "integer" }, - "column_id": { "type": "integer" }, - "position": { - "required": true, - "type": "string", - "validation": "^(top|bottom|after:\\d+)$" - } - }, - "url": "/projects/columns/cards/:card_id/moves" - }, - "moveColumn": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "POST", - "params": { - "column_id": { "required": true, "type": "integer" }, - "position": { - "required": true, - "type": "string", - "validation": "^(first|last|after:\\d+)$" - } - }, - "url": "/projects/columns/:column_id/moves" - }, - "removeCollaborator": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "DELETE", - "params": { - "project_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/projects/:project_id/collaborators/:username" - }, - "reviewUserPermissionLevel": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "project_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/projects/:project_id/collaborators/:username/permission" - }, - "update": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "PATCH", - "params": { - "body": { "type": "string" }, - "name": { "type": "string" }, - "organization_permission": { "type": "string" }, - "private": { "type": "boolean" }, - "project_id": { "required": true, "type": "integer" }, - "state": { "enum": ["open", "closed"], "type": "string" } - }, - "url": "/projects/:project_id" - }, - "updateCard": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "PATCH", - "params": { - "archived": { "type": "boolean" }, - "card_id": { "required": true, "type": "integer" }, - "note": { "type": "string" } - }, - "url": "/projects/columns/cards/:card_id" - }, - "updateColumn": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "PATCH", - "params": { - "column_id": { "required": true, "type": "integer" }, - "name": { "required": true, "type": "string" } - }, - "url": "/projects/columns/:column_id" - } - }, - "pulls": { - "checkIfMerged": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/merge" - }, - "create": { - "method": "POST", - "params": { - "base": { "required": true, "type": "string" }, - "body": { "type": "string" }, - "draft": { "type": "boolean" }, - "head": { "required": true, "type": "string" }, - "maintainer_can_modify": { "type": "boolean" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "title": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls" - }, - "createComment": { - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "commit_id": { "required": true, "type": "string" }, - "in_reply_to": { - "deprecated": true, - "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", - "type": "integer" - }, - "line": { "type": "integer" }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "position": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "side": { "enum": ["LEFT", "RIGHT"], "type": "string" }, - "start_line": { "type": "integer" }, - "start_side": { "enum": ["LEFT", "RIGHT", "side"], "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/comments" - }, - "createCommentReply": { - "deprecated": "octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() (2019-09-09)", - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "commit_id": { "required": true, "type": "string" }, - "in_reply_to": { - "deprecated": true, - "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", - "type": "integer" - }, - "line": { "type": "integer" }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "position": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "side": { "enum": ["LEFT", "RIGHT"], "type": "string" }, - "start_line": { "type": "integer" }, - "start_side": { "enum": ["LEFT", "RIGHT", "side"], "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/comments" - }, - "createFromIssue": { - "deprecated": "octokit.pulls.createFromIssue() is deprecated, see https://developer.github.com/v3/pulls/#create-a-pull-request", - "method": "POST", - "params": { - "base": { "required": true, "type": "string" }, - "draft": { "type": "boolean" }, - "head": { "required": true, "type": "string" }, - "issue": { "required": true, "type": "integer" }, - "maintainer_can_modify": { "type": "boolean" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls" - }, - "createReview": { - "method": "POST", - "params": { - "body": { "type": "string" }, - "comments": { "type": "object[]" }, - "comments[].body": { "required": true, "type": "string" }, - "comments[].path": { "required": true, "type": "string" }, - "comments[].position": { "required": true, "type": "integer" }, - "commit_id": { "type": "string" }, - "event": { - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "type": "string" - }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews" - }, - "createReviewCommentReply": { - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies" - }, - "createReviewRequest": { - "method": "POST", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "reviewers": { "type": "string[]" }, - "team_reviewers": { "type": "string[]" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" - }, - "deleteComment": { - "method": "DELETE", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/comments/:comment_id" - }, - "deletePendingReview": { - "method": "DELETE", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "review_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" - }, - "deleteReviewRequest": { - "method": "DELETE", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "reviewers": { "type": "string[]" }, - "team_reviewers": { "type": "string[]" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" - }, - "dismissReview": { - "method": "PUT", - "params": { - "message": { "required": true, "type": "string" }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "review_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals" - }, - "get": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number" - }, - "getComment": { - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/comments/:comment_id" - }, - "getCommentsForReview": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "review_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments" - }, - "getReview": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "review_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" - }, - "list": { - "method": "GET", - "params": { - "base": { "type": "string" }, - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "head": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "sort": { - "enum": ["created", "updated", "popularity", "long-running"], - "type": "string" - }, - "state": { "enum": ["open", "closed", "all"], "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls" - }, - "listComments": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/comments" - }, - "listCommentsForRepo": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "since": { "type": "string" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/comments" - }, - "listCommits": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/commits" - }, - "listFiles": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/files" - }, - "listReviewRequests": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" - }, - "listReviews": { - "method": "GET", - "params": { - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews" - }, - "merge": { - "method": "PUT", - "params": { - "commit_message": { "type": "string" }, - "commit_title": { "type": "string" }, - "merge_method": { - "enum": ["merge", "squash", "rebase"], - "type": "string" - }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "sha": { "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/merge" - }, - "submitReview": { - "method": "POST", - "params": { - "body": { "type": "string" }, - "event": { - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "required": true, - "type": "string" - }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "review_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events" - }, - "update": { - "method": "PATCH", - "params": { - "base": { "type": "string" }, - "body": { "type": "string" }, - "maintainer_can_modify": { "type": "boolean" }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "state": { "enum": ["open", "closed"], "type": "string" }, - "title": { "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number" - }, - "updateBranch": { - "headers": { "accept": "application/vnd.github.lydian-preview+json" }, - "method": "PUT", - "params": { - "expected_head_sha": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/update-branch" - }, - "updateComment": { - "method": "PATCH", - "params": { - "body": { "required": true, "type": "string" }, - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/comments/:comment_id" - }, - "updateReview": { - "method": "PUT", - "params": { - "body": { "required": true, "type": "string" }, - "number": { - "alias": "pull_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "pull_number": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "review_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" - } - }, - "rateLimit": { - "get": { "method": "GET", "params": {}, "url": "/rate_limit" } - }, - "reactions": { - "createForCommitComment": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "POST", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "required": true, - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/comments/:comment_id/reactions" - }, - "createForIssue": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "POST", - "params": { - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "required": true, - "type": "string" - }, - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/reactions" - }, - "createForIssueComment": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "POST", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "required": true, - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/comments/:comment_id/reactions" - }, - "createForPullRequestReviewComment": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "POST", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "required": true, - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/comments/:comment_id/reactions" - }, - "createForTeamDiscussion": { - "headers": { - "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" - }, - "method": "POST", - "params": { - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "required": true, - "type": "string" - }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/reactions" - }, - "createForTeamDiscussionComment": { - "headers": { - "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" - }, - "method": "POST", - "params": { - "comment_number": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "required": true, - "type": "string" - }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions" - }, - "delete": { - "headers": { - "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" - }, - "method": "DELETE", - "params": { "reaction_id": { "required": true, "type": "integer" } }, - "url": "/reactions/:reaction_id" - }, - "listForCommitComment": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/comments/:comment_id/reactions" - }, - "listForIssue": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "GET", - "params": { - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "type": "string" - }, - "issue_number": { "required": true, "type": "integer" }, - "number": { - "alias": "issue_number", - "deprecated": true, - "type": "integer" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/:issue_number/reactions" - }, - "listForIssueComment": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/issues/comments/:comment_id/reactions" - }, - "listForPullRequestReviewComment": { - "headers": { - "accept": "application/vnd.github.squirrel-girl-preview+json" - }, - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pulls/comments/:comment_id/reactions" - }, - "listForTeamDiscussion": { - "headers": { - "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" - }, - "method": "GET", - "params": { - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "type": "string" - }, - "discussion_number": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/reactions" - }, - "listForTeamDiscussionComment": { - "headers": { - "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" - }, - "method": "GET", - "params": { - "comment_number": { "required": true, "type": "integer" }, - "content": { - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "type": "string" - }, - "discussion_number": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions" - } - }, - "repos": { - "acceptInvitation": { - "method": "PATCH", - "params": { "invitation_id": { "required": true, "type": "integer" } }, - "url": "/user/repository_invitations/:invitation_id" - }, - "addCollaborator": { - "method": "PUT", - "params": { - "owner": { "required": true, "type": "string" }, - "permission": { "enum": ["pull", "push", "admin"], "type": "string" }, - "repo": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/collaborators/:username" - }, - "addDeployKey": { - "method": "POST", - "params": { - "key": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "read_only": { "type": "boolean" }, - "repo": { "required": true, "type": "string" }, - "title": { "type": "string" } - }, - "url": "/repos/:owner/:repo/keys" - }, - "addProtectedBranchAdminEnforcement": { - "method": "POST", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" - }, - "addProtectedBranchAppRestrictions": { - "method": "POST", - "params": { - "apps": { "mapTo": "data", "required": true, "type": "string[]" }, - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - "addProtectedBranchRequiredSignatures": { - "headers": { "accept": "application/vnd.github.zzzax-preview+json" }, - "method": "POST", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures" - }, - "addProtectedBranchRequiredStatusChecksContexts": { - "method": "POST", - "params": { - "branch": { "required": true, "type": "string" }, - "contexts": { "mapTo": "data", "required": true, "type": "string[]" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" - }, - "addProtectedBranchTeamRestrictions": { - "method": "POST", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "teams": { "mapTo": "data", "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - "addProtectedBranchUserRestrictions": { - "method": "POST", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "users": { "mapTo": "data", "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - "checkCollaborator": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/collaborators/:username" - }, - "checkVulnerabilityAlerts": { - "headers": { "accept": "application/vnd.github.dorian-preview+json" }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/vulnerability-alerts" - }, - "compareCommits": { - "method": "GET", - "params": { - "base": { "required": true, "type": "string" }, - "head": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/compare/:base...:head" - }, - "createCommitComment": { - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "commit_sha": { "required": true, "type": "string" }, - "line": { "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "path": { "type": "string" }, - "position": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "sha": { "alias": "commit_sha", "deprecated": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:commit_sha/comments" - }, - "createDeployment": { - "method": "POST", - "params": { - "auto_merge": { "type": "boolean" }, - "description": { "type": "string" }, - "environment": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "payload": { "type": "string" }, - "production_environment": { "type": "boolean" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "required_contexts": { "type": "string[]" }, - "task": { "type": "string" }, - "transient_environment": { "type": "boolean" } - }, - "url": "/repos/:owner/:repo/deployments" - }, - "createDeploymentStatus": { - "method": "POST", - "params": { - "auto_inactive": { "type": "boolean" }, - "deployment_id": { "required": true, "type": "integer" }, - "description": { "type": "string" }, - "environment": { - "enum": ["production", "staging", "qa"], - "type": "string" - }, - "environment_url": { "type": "string" }, - "log_url": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "state": { - "enum": [ - "error", - "failure", - "inactive", - "in_progress", - "queued", - "pending", - "success" - ], - "required": true, - "type": "string" - }, - "target_url": { "type": "string" } - }, - "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses" - }, - "createDispatchEvent": { - "headers": { "accept": "application/vnd.github.everest-preview+json" }, - "method": "POST", - "params": { - "client_payload": { "type": "object" }, - "event_type": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/dispatches" - }, - "createFile": { - "deprecated": "octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)", - "method": "PUT", - "params": { - "author": { "type": "object" }, - "author.email": { "required": true, "type": "string" }, - "author.name": { "required": true, "type": "string" }, - "branch": { "type": "string" }, - "committer": { "type": "object" }, - "committer.email": { "required": true, "type": "string" }, - "committer.name": { "required": true, "type": "string" }, - "content": { "required": true, "type": "string" }, - "message": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "type": "string" } - }, - "url": "/repos/:owner/:repo/contents/:path" - }, - "createForAuthenticatedUser": { - "method": "POST", - "params": { - "allow_merge_commit": { "type": "boolean" }, - "allow_rebase_merge": { "type": "boolean" }, - "allow_squash_merge": { "type": "boolean" }, - "auto_init": { "type": "boolean" }, - "description": { "type": "string" }, - "gitignore_template": { "type": "string" }, - "has_issues": { "type": "boolean" }, - "has_projects": { "type": "boolean" }, - "has_wiki": { "type": "boolean" }, - "homepage": { "type": "string" }, - "is_template": { "type": "boolean" }, - "license_template": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "private": { "type": "boolean" }, - "team_id": { "type": "integer" } - }, - "url": "/user/repos" - }, - "createFork": { - "method": "POST", - "params": { - "organization": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/forks" - }, - "createHook": { - "method": "POST", - "params": { - "active": { "type": "boolean" }, - "config": { "required": true, "type": "object" }, - "config.content_type": { "type": "string" }, - "config.insecure_ssl": { "type": "string" }, - "config.secret": { "type": "string" }, - "config.url": { "required": true, "type": "string" }, - "events": { "type": "string[]" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks" - }, - "createInOrg": { - "method": "POST", - "params": { - "allow_merge_commit": { "type": "boolean" }, - "allow_rebase_merge": { "type": "boolean" }, - "allow_squash_merge": { "type": "boolean" }, - "auto_init": { "type": "boolean" }, - "description": { "type": "string" }, - "gitignore_template": { "type": "string" }, - "has_issues": { "type": "boolean" }, - "has_projects": { "type": "boolean" }, - "has_wiki": { "type": "boolean" }, - "homepage": { "type": "string" }, - "is_template": { "type": "boolean" }, - "license_template": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "org": { "required": true, "type": "string" }, - "private": { "type": "boolean" }, - "team_id": { "type": "integer" } - }, - "url": "/orgs/:org/repos" - }, - "createOrUpdateFile": { - "method": "PUT", - "params": { - "author": { "type": "object" }, - "author.email": { "required": true, "type": "string" }, - "author.name": { "required": true, "type": "string" }, - "branch": { "type": "string" }, - "committer": { "type": "object" }, - "committer.email": { "required": true, "type": "string" }, - "committer.name": { "required": true, "type": "string" }, - "content": { "required": true, "type": "string" }, - "message": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "type": "string" } - }, - "url": "/repos/:owner/:repo/contents/:path" - }, - "createRelease": { - "method": "POST", - "params": { - "body": { "type": "string" }, - "draft": { "type": "boolean" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "prerelease": { "type": "boolean" }, - "repo": { "required": true, "type": "string" }, - "tag_name": { "required": true, "type": "string" }, - "target_commitish": { "type": "string" } - }, - "url": "/repos/:owner/:repo/releases" - }, - "createStatus": { - "method": "POST", - "params": { - "context": { "type": "string" }, - "description": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "required": true, "type": "string" }, - "state": { - "enum": ["error", "failure", "pending", "success"], - "required": true, - "type": "string" - }, - "target_url": { "type": "string" } - }, - "url": "/repos/:owner/:repo/statuses/:sha" - }, - "createUsingTemplate": { - "headers": { "accept": "application/vnd.github.baptiste-preview+json" }, - "method": "POST", - "params": { - "description": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "owner": { "type": "string" }, - "private": { "type": "boolean" }, - "template_owner": { "required": true, "type": "string" }, - "template_repo": { "required": true, "type": "string" } - }, - "url": "/repos/:template_owner/:template_repo/generate" - }, - "declineInvitation": { - "method": "DELETE", - "params": { "invitation_id": { "required": true, "type": "integer" } }, - "url": "/user/repository_invitations/:invitation_id" - }, - "delete": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo" - }, - "deleteCommitComment": { - "method": "DELETE", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/comments/:comment_id" - }, - "deleteDownload": { - "method": "DELETE", - "params": { - "download_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/downloads/:download_id" - }, - "deleteFile": { - "method": "DELETE", - "params": { - "author": { "type": "object" }, - "author.email": { "type": "string" }, - "author.name": { "type": "string" }, - "branch": { "type": "string" }, - "committer": { "type": "object" }, - "committer.email": { "type": "string" }, - "committer.name": { "type": "string" }, - "message": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/contents/:path" - }, - "deleteHook": { - "method": "DELETE", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks/:hook_id" - }, - "deleteInvitation": { - "method": "DELETE", - "params": { - "invitation_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/invitations/:invitation_id" - }, - "deleteRelease": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "release_id": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/:release_id" - }, - "deleteReleaseAsset": { - "method": "DELETE", - "params": { - "asset_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/assets/:asset_id" - }, - "disableAutomatedSecurityFixes": { - "headers": { "accept": "application/vnd.github.london-preview+json" }, - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/automated-security-fixes" - }, - "disablePagesSite": { - "headers": { "accept": "application/vnd.github.switcheroo-preview+json" }, - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pages" - }, - "disableVulnerabilityAlerts": { - "headers": { "accept": "application/vnd.github.dorian-preview+json" }, - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/vulnerability-alerts" - }, - "enableAutomatedSecurityFixes": { - "headers": { "accept": "application/vnd.github.london-preview+json" }, - "method": "PUT", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/automated-security-fixes" - }, - "enablePagesSite": { - "headers": { "accept": "application/vnd.github.switcheroo-preview+json" }, - "method": "POST", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "source": { "type": "object" }, - "source.branch": { "enum": ["master", "gh-pages"], "type": "string" }, - "source.path": { "type": "string" } - }, - "url": "/repos/:owner/:repo/pages" - }, - "enableVulnerabilityAlerts": { - "headers": { "accept": "application/vnd.github.dorian-preview+json" }, - "method": "PUT", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/vulnerability-alerts" - }, - "get": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo" - }, - "getAppsWithAccessToProtectedBranch": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - "getArchiveLink": { - "method": "GET", - "params": { - "archive_format": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/:archive_format/:ref" - }, - "getBranch": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch" - }, - "getBranchProtection": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection" - }, - "getClones": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "per": { "enum": ["day", "week"], "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/traffic/clones" - }, - "getCodeFrequencyStats": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/stats/code_frequency" - }, - "getCollaboratorPermissionLevel": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/collaborators/:username/permission" - }, - "getCombinedStatusForRef": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:ref/status" - }, - "getCommit": { - "method": "GET", - "params": { - "commit_sha": { "alias": "ref", "deprecated": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "alias": "ref", "deprecated": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:ref" - }, - "getCommitActivityStats": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/stats/commit_activity" - }, - "getCommitComment": { - "method": "GET", - "params": { - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/comments/:comment_id" - }, - "getCommitRefSha": { - "deprecated": "octokit.repos.getCommitRefSha() is deprecated, see https://developer.github.com/v3/repos/commits/#get-a-single-commit", - "headers": { "accept": "application/vnd.github.v3.sha" }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:ref" - }, - "getContents": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "ref": { "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/contents/:path" - }, - "getContributorsStats": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/stats/contributors" - }, - "getDeployKey": { - "method": "GET", - "params": { - "key_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/keys/:key_id" - }, - "getDeployment": { - "method": "GET", - "params": { - "deployment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/deployments/:deployment_id" - }, - "getDeploymentStatus": { - "method": "GET", - "params": { - "deployment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "status_id": { "required": true, "type": "integer" } - }, - "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id" - }, - "getDownload": { - "method": "GET", - "params": { - "download_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/downloads/:download_id" - }, - "getHook": { - "method": "GET", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks/:hook_id" - }, - "getLatestPagesBuild": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pages/builds/latest" - }, - "getLatestRelease": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/latest" - }, - "getPages": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pages" - }, - "getPagesBuild": { - "method": "GET", - "params": { - "build_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pages/builds/:build_id" - }, - "getParticipationStats": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/stats/participation" - }, - "getProtectedBranchAdminEnforcement": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" - }, - "getProtectedBranchPullRequestReviewEnforcement": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" - }, - "getProtectedBranchRequiredSignatures": { - "headers": { "accept": "application/vnd.github.zzzax-preview+json" }, - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures" - }, - "getProtectedBranchRequiredStatusChecks": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" - }, - "getProtectedBranchRestrictions": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions" - }, - "getPunchCardStats": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/stats/punch_card" - }, - "getReadme": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "ref": { "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/readme" - }, - "getRelease": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "release_id": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/:release_id" - }, - "getReleaseAsset": { - "method": "GET", - "params": { - "asset_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/assets/:asset_id" - }, - "getReleaseByTag": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "tag": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/tags/:tag" - }, - "getTeamsWithAccessToProtectedBranch": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - "getTopPaths": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/traffic/popular/paths" - }, - "getTopReferrers": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/traffic/popular/referrers" - }, - "getUsersWithAccessToProtectedBranch": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - "getViews": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "per": { "enum": ["day", "week"], "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/traffic/views" - }, - "list": { - "method": "GET", - "params": { - "affiliation": { "type": "string" }, - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "sort": { - "enum": ["created", "updated", "pushed", "full_name"], - "type": "string" - }, - "type": { - "enum": ["all", "owner", "public", "private", "member"], - "type": "string" - }, - "visibility": { "enum": ["all", "public", "private"], "type": "string" } - }, - "url": "/user/repos" - }, - "listAppsWithAccessToProtectedBranch": { - "deprecated": "octokit.repos.listAppsWithAccessToProtectedBranch() has been renamed to octokit.repos.getAppsWithAccessToProtectedBranch() (2019-09-13)", - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - "listAssetsForRelease": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "release_id": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/:release_id/assets" - }, - "listBranches": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "protected": { "type": "boolean" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches" - }, - "listBranchesForHeadCommit": { - "headers": { "accept": "application/vnd.github.groot-preview+json" }, - "method": "GET", - "params": { - "commit_sha": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:commit_sha/branches-where-head" - }, - "listCollaborators": { - "method": "GET", - "params": { - "affiliation": { - "enum": ["outside", "direct", "all"], - "type": "string" - }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/collaborators" - }, - "listCommentsForCommit": { - "method": "GET", - "params": { - "commit_sha": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "ref": { "alias": "commit_sha", "deprecated": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:commit_sha/comments" - }, - "listCommitComments": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/comments" - }, - "listCommits": { - "method": "GET", - "params": { - "author": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "path": { "type": "string" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "sha": { "type": "string" }, - "since": { "type": "string" }, - "until": { "type": "string" } - }, - "url": "/repos/:owner/:repo/commits" - }, - "listContributors": { - "method": "GET", - "params": { - "anon": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/contributors" - }, - "listDeployKeys": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/keys" - }, - "listDeploymentStatuses": { - "method": "GET", - "params": { - "deployment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses" - }, - "listDeployments": { - "method": "GET", - "params": { - "environment": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "ref": { "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "type": "string" }, - "task": { "type": "string" } - }, - "url": "/repos/:owner/:repo/deployments" - }, - "listDownloads": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/downloads" - }, - "listForOrg": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "sort": { - "enum": ["created", "updated", "pushed", "full_name"], - "type": "string" - }, - "type": { - "enum": ["all", "public", "private", "forks", "sources", "member"], - "type": "string" - } - }, - "url": "/orgs/:org/repos" - }, - "listForUser": { - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "sort": { - "enum": ["created", "updated", "pushed", "full_name"], - "type": "string" - }, - "type": { "enum": ["all", "owner", "member"], "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/repos" - }, - "listForks": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "sort": { "enum": ["newest", "oldest", "stargazers"], "type": "string" } - }, - "url": "/repos/:owner/:repo/forks" - }, - "listHooks": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks" - }, - "listInvitations": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/invitations" - }, - "listInvitationsForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/repository_invitations" - }, - "listLanguages": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/languages" - }, - "listPagesBuilds": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pages/builds" - }, - "listProtectedBranchRequiredStatusChecksContexts": { - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" - }, - "listProtectedBranchTeamRestrictions": { - "deprecated": "octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09)", - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - "listProtectedBranchUserRestrictions": { - "deprecated": "octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09)", - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - "listPublic": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/repositories" - }, - "listPullRequestsAssociatedWithCommit": { - "headers": { "accept": "application/vnd.github.groot-preview+json" }, - "method": "GET", - "params": { - "commit_sha": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:commit_sha/pulls" - }, - "listReleases": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases" - }, - "listStatusesForRef": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "ref": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/commits/:ref/statuses" - }, - "listTags": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/tags" - }, - "listTeams": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/teams" - }, - "listTeamsWithAccessToProtectedBranch": { - "deprecated": "octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13)", - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - "listTopics": { - "headers": { "accept": "application/vnd.github.mercy-preview+json" }, - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/topics" - }, - "listUsersWithAccessToProtectedBranch": { - "deprecated": "octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13)", - "method": "GET", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - "merge": { - "method": "POST", - "params": { - "base": { "required": true, "type": "string" }, - "commit_message": { "type": "string" }, - "head": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/merges" - }, - "pingHook": { - "method": "POST", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks/:hook_id/pings" - }, - "removeBranchProtection": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection" - }, - "removeCollaborator": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/collaborators/:username" - }, - "removeDeployKey": { - "method": "DELETE", - "params": { - "key_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/keys/:key_id" - }, - "removeProtectedBranchAdminEnforcement": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" - }, - "removeProtectedBranchAppRestrictions": { - "method": "DELETE", - "params": { - "apps": { "mapTo": "data", "required": true, "type": "string[]" }, - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - "removeProtectedBranchPullRequestReviewEnforcement": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" - }, - "removeProtectedBranchRequiredSignatures": { - "headers": { "accept": "application/vnd.github.zzzax-preview+json" }, - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures" - }, - "removeProtectedBranchRequiredStatusChecks": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" - }, - "removeProtectedBranchRequiredStatusChecksContexts": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "contexts": { "mapTo": "data", "required": true, "type": "string[]" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" - }, - "removeProtectedBranchRestrictions": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions" - }, - "removeProtectedBranchTeamRestrictions": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "teams": { "mapTo": "data", "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - "removeProtectedBranchUserRestrictions": { - "method": "DELETE", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "users": { "mapTo": "data", "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - "replaceProtectedBranchAppRestrictions": { - "method": "PUT", - "params": { - "apps": { "mapTo": "data", "required": true, "type": "string[]" }, - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - "replaceProtectedBranchRequiredStatusChecksContexts": { - "method": "PUT", - "params": { - "branch": { "required": true, "type": "string" }, - "contexts": { "mapTo": "data", "required": true, "type": "string[]" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" - }, - "replaceProtectedBranchTeamRestrictions": { - "method": "PUT", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "teams": { "mapTo": "data", "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - "replaceProtectedBranchUserRestrictions": { - "method": "PUT", - "params": { - "branch": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "users": { "mapTo": "data", "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - "replaceTopics": { - "headers": { "accept": "application/vnd.github.mercy-preview+json" }, - "method": "PUT", - "params": { - "names": { "required": true, "type": "string[]" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/topics" - }, - "requestPageBuild": { - "method": "POST", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/pages/builds" - }, - "retrieveCommunityProfileMetrics": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/community/profile" - }, - "testPushHook": { - "method": "POST", - "params": { - "hook_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks/:hook_id/tests" - }, - "transfer": { - "headers": { "accept": "application/vnd.github.nightshade-preview+json" }, - "method": "POST", - "params": { - "new_owner": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "team_ids": { "type": "integer[]" } - }, - "url": "/repos/:owner/:repo/transfer" - }, - "update": { - "method": "PATCH", - "params": { - "allow_merge_commit": { "type": "boolean" }, - "allow_rebase_merge": { "type": "boolean" }, - "allow_squash_merge": { "type": "boolean" }, - "archived": { "type": "boolean" }, - "default_branch": { "type": "string" }, - "description": { "type": "string" }, - "has_issues": { "type": "boolean" }, - "has_projects": { "type": "boolean" }, - "has_wiki": { "type": "boolean" }, - "homepage": { "type": "string" }, - "is_template": { "type": "boolean" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "private": { "type": "boolean" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo" - }, - "updateBranchProtection": { - "method": "PUT", - "params": { - "branch": { "required": true, "type": "string" }, - "enforce_admins": { - "allowNull": true, - "required": true, - "type": "boolean" - }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "required_pull_request_reviews": { - "allowNull": true, - "required": true, - "type": "object" - }, - "required_pull_request_reviews.dismiss_stale_reviews": { - "type": "boolean" - }, - "required_pull_request_reviews.dismissal_restrictions": { - "type": "object" - }, - "required_pull_request_reviews.dismissal_restrictions.teams": { - "type": "string[]" - }, - "required_pull_request_reviews.dismissal_restrictions.users": { - "type": "string[]" - }, - "required_pull_request_reviews.require_code_owner_reviews": { - "type": "boolean" - }, - "required_pull_request_reviews.required_approving_review_count": { - "type": "integer" - }, - "required_status_checks": { - "allowNull": true, - "required": true, - "type": "object" - }, - "required_status_checks.contexts": { - "required": true, - "type": "string[]" - }, - "required_status_checks.strict": { - "required": true, - "type": "boolean" - }, - "restrictions": { - "allowNull": true, - "required": true, - "type": "object" - }, - "restrictions.apps": { "type": "string[]" }, - "restrictions.teams": { "required": true, "type": "string[]" }, - "restrictions.users": { "required": true, "type": "string[]" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection" - }, - "updateCommitComment": { - "method": "PATCH", - "params": { - "body": { "required": true, "type": "string" }, - "comment_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/comments/:comment_id" - }, - "updateFile": { - "deprecated": "octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)", - "method": "PUT", - "params": { - "author": { "type": "object" }, - "author.email": { "required": true, "type": "string" }, - "author.name": { "required": true, "type": "string" }, - "branch": { "type": "string" }, - "committer": { "type": "object" }, - "committer.email": { "required": true, "type": "string" }, - "committer.name": { "required": true, "type": "string" }, - "content": { "required": true, "type": "string" }, - "message": { "required": true, "type": "string" }, - "owner": { "required": true, "type": "string" }, - "path": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "sha": { "type": "string" } - }, - "url": "/repos/:owner/:repo/contents/:path" - }, - "updateHook": { - "method": "PATCH", - "params": { - "active": { "type": "boolean" }, - "add_events": { "type": "string[]" }, - "config": { "type": "object" }, - "config.content_type": { "type": "string" }, - "config.insecure_ssl": { "type": "string" }, - "config.secret": { "type": "string" }, - "config.url": { "required": true, "type": "string" }, - "events": { "type": "string[]" }, - "hook_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "remove_events": { "type": "string[]" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/hooks/:hook_id" - }, - "updateInformationAboutPagesSite": { - "method": "PUT", - "params": { - "cname": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "source": { - "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""], - "type": "string" - } - }, - "url": "/repos/:owner/:repo/pages" - }, - "updateInvitation": { - "method": "PATCH", - "params": { - "invitation_id": { "required": true, "type": "integer" }, - "owner": { "required": true, "type": "string" }, - "permissions": { "enum": ["read", "write", "admin"], "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/invitations/:invitation_id" - }, - "updateProtectedBranchPullRequestReviewEnforcement": { - "method": "PATCH", - "params": { - "branch": { "required": true, "type": "string" }, - "dismiss_stale_reviews": { "type": "boolean" }, - "dismissal_restrictions": { "type": "object" }, - "dismissal_restrictions.teams": { "type": "string[]" }, - "dismissal_restrictions.users": { "type": "string[]" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "require_code_owner_reviews": { "type": "boolean" }, - "required_approving_review_count": { "type": "integer" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" - }, - "updateProtectedBranchRequiredStatusChecks": { - "method": "PATCH", - "params": { - "branch": { "required": true, "type": "string" }, - "contexts": { "type": "string[]" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "strict": { "type": "boolean" } - }, - "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" - }, - "updateRelease": { - "method": "PATCH", - "params": { - "body": { "type": "string" }, - "draft": { "type": "boolean" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "prerelease": { "type": "boolean" }, - "release_id": { "required": true, "type": "integer" }, - "repo": { "required": true, "type": "string" }, - "tag_name": { "type": "string" }, - "target_commitish": { "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/:release_id" - }, - "updateReleaseAsset": { - "method": "PATCH", - "params": { - "asset_id": { "required": true, "type": "integer" }, - "label": { "type": "string" }, - "name": { "type": "string" }, - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" } - }, - "url": "/repos/:owner/:repo/releases/assets/:asset_id" - }, - "uploadReleaseAsset": { - "method": "POST", - "params": { - "file": { - "mapTo": "data", - "required": true, - "type": "string | object" - }, - "headers": { "required": true, "type": "object" }, - "headers.content-length": { "required": true, "type": "integer" }, - "headers.content-type": { "required": true, "type": "string" }, - "label": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "url": { "required": true, "type": "string" } - }, - "url": ":url" - } - }, - "search": { - "code": { - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "q": { "required": true, "type": "string" }, - "sort": { "enum": ["indexed"], "type": "string" } - }, - "url": "/search/code" - }, - "commits": { - "headers": { "accept": "application/vnd.github.cloak-preview+json" }, - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "q": { "required": true, "type": "string" }, - "sort": { "enum": ["author-date", "committer-date"], "type": "string" } - }, - "url": "/search/commits" - }, - "issues": { - "deprecated": "octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27)", - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "q": { "required": true, "type": "string" }, - "sort": { - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - "type": "string" - } - }, - "url": "/search/issues" - }, - "issuesAndPullRequests": { - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "q": { "required": true, "type": "string" }, - "sort": { - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - "type": "string" - } - }, - "url": "/search/issues" - }, - "labels": { - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "q": { "required": true, "type": "string" }, - "repository_id": { "required": true, "type": "integer" }, - "sort": { "enum": ["created", "updated"], "type": "string" } - }, - "url": "/search/labels" - }, - "repos": { - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "q": { "required": true, "type": "string" }, - "sort": { - "enum": ["stars", "forks", "help-wanted-issues", "updated"], - "type": "string" - } - }, - "url": "/search/repositories" - }, - "topics": { - "method": "GET", - "params": { "q": { "required": true, "type": "string" } }, - "url": "/search/topics" - }, - "users": { - "method": "GET", - "params": { - "order": { "enum": ["desc", "asc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "q": { "required": true, "type": "string" }, - "sort": { - "enum": ["followers", "repositories", "joined"], - "type": "string" - } - }, - "url": "/search/users" - } - }, - "teams": { - "addMember": { - "deprecated": "octokit.teams.addMember() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member", - "method": "PUT", - "params": { - "team_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/members/:username" - }, - "addOrUpdateMembership": { - "method": "PUT", - "params": { - "role": { "enum": ["member", "maintainer"], "type": "string" }, - "team_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/memberships/:username" - }, - "addOrUpdateProject": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "PUT", - "params": { - "permission": { "enum": ["read", "write", "admin"], "type": "string" }, - "project_id": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/projects/:project_id" - }, - "addOrUpdateRepo": { - "method": "PUT", - "params": { - "owner": { "required": true, "type": "string" }, - "permission": { "enum": ["pull", "push", "admin"], "type": "string" }, - "repo": { "required": true, "type": "string" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/repos/:owner/:repo" - }, - "checkManagesRepo": { - "method": "GET", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/repos/:owner/:repo" - }, - "create": { - "method": "POST", - "params": { - "description": { "type": "string" }, - "maintainers": { "type": "string[]" }, - "name": { "required": true, "type": "string" }, - "org": { "required": true, "type": "string" }, - "parent_team_id": { "type": "integer" }, - "permission": { "enum": ["pull", "push", "admin"], "type": "string" }, - "privacy": { "enum": ["secret", "closed"], "type": "string" }, - "repo_names": { "type": "string[]" } - }, - "url": "/orgs/:org/teams" - }, - "createDiscussion": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "private": { "type": "boolean" }, - "team_id": { "required": true, "type": "integer" }, - "title": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/discussions" - }, - "createDiscussionComment": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "POST", - "params": { - "body": { "required": true, "type": "string" }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments" - }, - "delete": { - "method": "DELETE", - "params": { "team_id": { "required": true, "type": "integer" } }, - "url": "/teams/:team_id" - }, - "deleteDiscussion": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "DELETE", - "params": { - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number" - }, - "deleteDiscussionComment": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "DELETE", - "params": { - "comment_number": { "required": true, "type": "integer" }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" - }, - "get": { - "method": "GET", - "params": { "team_id": { "required": true, "type": "integer" } }, - "url": "/teams/:team_id" - }, - "getByName": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "team_slug": { "required": true, "type": "string" } - }, - "url": "/orgs/:org/teams/:team_slug" - }, - "getDiscussion": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "GET", - "params": { - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number" - }, - "getDiscussionComment": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "GET", - "params": { - "comment_number": { "required": true, "type": "integer" }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" - }, - "getMember": { - "deprecated": "octokit.teams.getMember() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member", - "method": "GET", - "params": { - "team_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/members/:username" - }, - "getMembership": { - "method": "GET", - "params": { - "team_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/memberships/:username" - }, - "list": { - "method": "GET", - "params": { - "org": { "required": true, "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/orgs/:org/teams" - }, - "listChild": { - "headers": { "accept": "application/vnd.github.hellcat-preview+json" }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/teams" - }, - "listDiscussionComments": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "discussion_number": { "required": true, "type": "integer" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments" - }, - "listDiscussions": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "GET", - "params": { - "direction": { "enum": ["asc", "desc"], "type": "string" }, - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions" - }, - "listForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/teams" - }, - "listMembers": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "role": { "enum": ["member", "maintainer", "all"], "type": "string" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/members" - }, - "listPendingInvitations": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/invitations" - }, - "listProjects": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/projects" - }, - "listRepos": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/repos" - }, - "removeMember": { - "deprecated": "octokit.teams.removeMember() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member", - "method": "DELETE", - "params": { - "team_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/members/:username" - }, - "removeMembership": { - "method": "DELETE", - "params": { - "team_id": { "required": true, "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/teams/:team_id/memberships/:username" - }, - "removeProject": { - "method": "DELETE", - "params": { - "project_id": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/projects/:project_id" - }, - "removeRepo": { - "method": "DELETE", - "params": { - "owner": { "required": true, "type": "string" }, - "repo": { "required": true, "type": "string" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/repos/:owner/:repo" - }, - "reviewProject": { - "headers": { "accept": "application/vnd.github.inertia-preview+json" }, - "method": "GET", - "params": { - "project_id": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/projects/:project_id" - }, - "update": { - "method": "PATCH", - "params": { - "description": { "type": "string" }, - "name": { "required": true, "type": "string" }, - "parent_team_id": { "type": "integer" }, - "permission": { "enum": ["pull", "push", "admin"], "type": "string" }, - "privacy": { "enum": ["secret", "closed"], "type": "string" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id" - }, - "updateDiscussion": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "PATCH", - "params": { - "body": { "type": "string" }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" }, - "title": { "type": "string" } - }, - "url": "/teams/:team_id/discussions/:discussion_number" - }, - "updateDiscussionComment": { - "headers": { "accept": "application/vnd.github.echo-preview+json" }, - "method": "PATCH", - "params": { - "body": { "required": true, "type": "string" }, - "comment_number": { "required": true, "type": "integer" }, - "discussion_number": { "required": true, "type": "integer" }, - "team_id": { "required": true, "type": "integer" } - }, - "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" - } - }, - "users": { - "addEmails": { - "method": "POST", - "params": { "emails": { "required": true, "type": "string[]" } }, - "url": "/user/emails" - }, - "block": { - "method": "PUT", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/user/blocks/:username" - }, - "checkBlocked": { - "method": "GET", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/user/blocks/:username" - }, - "checkFollowing": { - "method": "GET", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/user/following/:username" - }, - "checkFollowingForUser": { - "method": "GET", - "params": { - "target_user": { "required": true, "type": "string" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/following/:target_user" - }, - "createGpgKey": { - "method": "POST", - "params": { "armored_public_key": { "type": "string" } }, - "url": "/user/gpg_keys" - }, - "createPublicKey": { - "method": "POST", - "params": { "key": { "type": "string" }, "title": { "type": "string" } }, - "url": "/user/keys" - }, - "deleteEmails": { - "method": "DELETE", - "params": { "emails": { "required": true, "type": "string[]" } }, - "url": "/user/emails" - }, - "deleteGpgKey": { - "method": "DELETE", - "params": { "gpg_key_id": { "required": true, "type": "integer" } }, - "url": "/user/gpg_keys/:gpg_key_id" - }, - "deletePublicKey": { - "method": "DELETE", - "params": { "key_id": { "required": true, "type": "integer" } }, - "url": "/user/keys/:key_id" - }, - "follow": { - "method": "PUT", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/user/following/:username" - }, - "getAuthenticated": { "method": "GET", "params": {}, "url": "/user" }, - "getByUsername": { - "method": "GET", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/users/:username" - }, - "getContextForUser": { - "headers": { "accept": "application/vnd.github.hagar-preview+json" }, - "method": "GET", - "params": { - "subject_id": { "type": "string" }, - "subject_type": { - "enum": ["organization", "repository", "issue", "pull_request"], - "type": "string" - }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/hovercard" - }, - "getGpgKey": { - "method": "GET", - "params": { "gpg_key_id": { "required": true, "type": "integer" } }, - "url": "/user/gpg_keys/:gpg_key_id" - }, - "getPublicKey": { - "method": "GET", - "params": { "key_id": { "required": true, "type": "integer" } }, - "url": "/user/keys/:key_id" - }, - "list": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "since": { "type": "string" } - }, - "url": "/users" - }, - "listBlocked": { "method": "GET", "params": {}, "url": "/user/blocks" }, - "listEmails": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/emails" - }, - "listFollowersForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/followers" - }, - "listFollowersForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/followers" - }, - "listFollowingForAuthenticatedUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/following" - }, - "listFollowingForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/following" - }, - "listGpgKeys": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/gpg_keys" - }, - "listGpgKeysForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/gpg_keys" - }, - "listPublicEmails": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/public_emails" - }, - "listPublicKeys": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" } - }, - "url": "/user/keys" - }, - "listPublicKeysForUser": { - "method": "GET", - "params": { - "page": { "type": "integer" }, - "per_page": { "type": "integer" }, - "username": { "required": true, "type": "string" } - }, - "url": "/users/:username/keys" - }, - "togglePrimaryEmailVisibility": { - "method": "PATCH", - "params": { - "email": { "required": true, "type": "string" }, - "visibility": { "required": true, "type": "string" } - }, - "url": "/user/email/visibility" - }, - "unblock": { - "method": "DELETE", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/user/blocks/:username" - }, - "unfollow": { - "method": "DELETE", - "params": { "username": { "required": true, "type": "string" } }, - "url": "/user/following/:username" - }, - "updateAuthenticated": { - "method": "PATCH", - "params": { - "bio": { "type": "string" }, - "blog": { "type": "string" }, - "company": { "type": "string" }, - "email": { "type": "string" }, - "hireable": { "type": "boolean" }, - "location": { "type": "string" }, - "name": { "type": "string" } - }, - "url": "/user" - } - } -} diff --git a/node_modules/@octokit/rest/plugins/validate/index.js b/node_modules/@octokit/rest/plugins/validate/index.js deleted file mode 100644 index 9954751..0000000 --- a/node_modules/@octokit/rest/plugins/validate/index.js +++ /dev/null @@ -1,7 +0,0 @@ -module.exports = octokitValidate; - -const validate = require("./validate"); - -function octokitValidate(octokit) { - octokit.hook.before("request", validate.bind(null, octokit)); -} diff --git a/node_modules/@octokit/rest/plugins/validate/validate.js b/node_modules/@octokit/rest/plugins/validate/validate.js deleted file mode 100644 index 00b3008..0000000 --- a/node_modules/@octokit/rest/plugins/validate/validate.js +++ /dev/null @@ -1,151 +0,0 @@ -"use strict"; - -module.exports = validate; - -const { RequestError } = require("@octokit/request-error"); -const get = require("lodash.get"); -const set = require("lodash.set"); - -function validate(octokit, options) { - if (!options.request.validate) { - return; - } - const { validate: params } = options.request; - - Object.keys(params).forEach(parameterName => { - const parameter = get(params, parameterName); - - const expectedType = parameter.type; - let parentParameterName; - let parentValue; - let parentParamIsPresent = true; - let parentParameterIsArray = false; - - if (/\./.test(parameterName)) { - parentParameterName = parameterName.replace(/\.[^.]+$/, ""); - parentParameterIsArray = parentParameterName.slice(-2) === "[]"; - if (parentParameterIsArray) { - parentParameterName = parentParameterName.slice(0, -2); - } - parentValue = get(options, parentParameterName); - parentParamIsPresent = - parentParameterName === "headers" || - (typeof parentValue === "object" && parentValue !== null); - } - - const values = parentParameterIsArray - ? (get(options, parentParameterName) || []).map( - value => value[parameterName.split(/\./).pop()] - ) - : [get(options, parameterName)]; - - values.forEach((value, i) => { - const valueIsPresent = typeof value !== "undefined"; - const valueIsNull = value === null; - const currentParameterName = parentParameterIsArray - ? parameterName.replace(/\[\]/, `[${i}]`) - : parameterName; - - if (!parameter.required && !valueIsPresent) { - return; - } - - // if the parent parameter is of type object but allows null - // then the child parameters can be ignored - if (!parentParamIsPresent) { - return; - } - - if (parameter.allowNull && valueIsNull) { - return; - } - - if (!parameter.allowNull && valueIsNull) { - throw new RequestError( - `'${currentParameterName}' cannot be null`, - 400, - { - request: options - } - ); - } - - if (parameter.required && !valueIsPresent) { - throw new RequestError( - `Empty value for parameter '${currentParameterName}': ${JSON.stringify( - value - )}`, - 400, - { - request: options - } - ); - } - - // parse to integer before checking for enum - // so that string "1" will match enum with number 1 - if (expectedType === "integer") { - const unparsedValue = value; - value = parseInt(value, 10); - if (isNaN(value)) { - throw new RequestError( - `Invalid value for parameter '${currentParameterName}': ${JSON.stringify( - unparsedValue - )} is NaN`, - 400, - { - request: options - } - ); - } - } - - if (parameter.enum && parameter.enum.indexOf(String(value)) === -1) { - throw new RequestError( - `Invalid value for parameter '${currentParameterName}': ${JSON.stringify( - value - )}`, - 400, - { - request: options - } - ); - } - - if (parameter.validation) { - const regex = new RegExp(parameter.validation); - if (!regex.test(value)) { - throw new RequestError( - `Invalid value for parameter '${currentParameterName}': ${JSON.stringify( - value - )}`, - 400, - { - request: options - } - ); - } - } - - if (expectedType === "object" && typeof value === "string") { - try { - value = JSON.parse(value); - } catch (exception) { - throw new RequestError( - `JSON parse error of value for parameter '${currentParameterName}': ${JSON.stringify( - value - )}`, - 400, - { - request: options - } - ); - } - } - - set(options, parameter.mapTo || currentParameterName, value); - }); - }); - - return options; -} diff --git a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md b/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md deleted file mode 100644 index b518515..0000000 --- a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -name: "🆘 Help" -about: "How does this even work 🤷‍♂️" -labels: support ---- diff --git a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md b/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md deleted file mode 100644 index d7e8325..0000000 --- a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: "🐛 Bug Report" -about: "If something isn't working as expected 🤔" -labels: bug ---- - - - -**What happened?** - - - -**What did you expect to happen?** - - - -**What the problem might be** - - diff --git a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md b/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md deleted file mode 100644 index 89a5481..0000000 --- a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: "🧚‍♂️ Feature Request" -about: "Wouldn’t it be nice if 💭" -labels: feature ---- - - - -**What’s missing?** - - - -**Why?** - - - -**Alternatives you tried** - - diff --git a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md b/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md deleted file mode 100644 index c67ce83..0000000 --- a/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: "💝 Thank you" -about: "@octokit/types is awesome 🙌" -labels: thanks ---- - - - -**How do you use @octokit/types?** - - - -**What do you love about it?** - - - -**How did you learn about it?** - - diff --git a/node_modules/@octokit/types/.github/workflows/release.yml b/node_modules/@octokit/types/.github/workflows/release.yml deleted file mode 100644 index b315607..0000000 --- a/node_modules/@octokit/types/.github/workflows/release.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: Release -on: - push: - branches: - - master - -jobs: - release: - name: release - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - uses: actions/setup-node@v1 - with: - node-version: "12.x" - - run: npm ci - - run: npx semantic-release - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - NPM_TOKEN: ${{ secrets.NPM_TOKEN }} - - run: npm run docs - env: - # workaround "Failed to replace env in config: ${NPM_TOKEN}" error - NPM_TOKEN: ${{ secrets.NPM_TOKEN }} - - uses: maxheld83/ghpages@master - env: - BUILD_DIR: docs/ - GH_PAT: ${{ secrets.OCTOKIT_PAT }} diff --git a/node_modules/@octokit/types/.github/workflows/routes-update.yml b/node_modules/@octokit/types/.github/workflows/routes-update.yml deleted file mode 100644 index 38d841d..0000000 --- a/node_modules/@octokit/types/.github/workflows/routes-update.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: octokit/routes update -on: - repository_dispatch: - types: [octokit-routes-release] - -jobs: - update_routes: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - uses: actions/setup-node@v1 - with: - node-version: "12.x" - # try checking out routes-update branch. Ignore error if it does not exist - - run: git checkout routes-update || true - - run: npm ci - - run: npm run update-endpoints - env: - VERSION: ${{ github.event.client_payload.version }} - - name: Create Pull Request - uses: gr2m/create-or-update-pull-request-action@v1.x - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - title: "🚧 GitHub REST Endpoints changed" - body: | - See what changed at https://github.com/octokit/routes/releases/latest. - - Make sure to update the commits so that the merge results in helpful release notes, see [Merging the Pull Request & releasing a new version](https://github.com/octokit/rest.js/blob/master/CONTRIBUTING.md#merging-the-pull-request--releasing-a-new-version). - - In general - - - Avoid breaking changes at all costs - - If there are no typescript or code changes, use a `docs` prefix - - If there are typescript changes but no code changes, use `fix(typescript)` prefix - - If there are code changes, use `fix` if a problem was resolved, `feat` if new endpoints / parameters were added, and `feat(deprecation)` if a method was deprecated. - branch: "routes-update" - commit-message: "WIP octokit/routes updated" - author: "Octokit Bot <33075676+octokitbot@users.noreply.github.com>" diff --git a/node_modules/@octokit/types/.github/workflows/test.yml b/node_modules/@octokit/types/.github/workflows/test.yml deleted file mode 100644 index 702220f..0000000 --- a/node_modules/@octokit/types/.github/workflows/test.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: Test -on: - push: - branches: - - master - - "greenkeeper/*" - pull_request: - types: [opened, synchronize] - -jobs: - test: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - uses: actions/setup-node@v1 - with: - node-version: 12 - - run: npm ci - - run: npm test diff --git a/node_modules/@octokit/types/CONTRIBUTING.md b/node_modules/@octokit/types/CONTRIBUTING.md deleted file mode 100644 index 6b27599..0000000 --- a/node_modules/@octokit/types/CONTRIBUTING.md +++ /dev/null @@ -1,59 +0,0 @@ -# How to contribute - -Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). -By participating in this project you agree to abide by its terms. - -## Creating an Issue - -Before you create a new Issue: - -1. Please make sure there is no [open issue](https://github.com/octokit/plugin-paginate-rest/issues?utf8=%E2%9C%93&q=is%3Aissue) yet. -2. If it is a bug report, include the steps to reproduce the issue and please create a reproducible test case on [runkit.com](https://runkit.com/). Example: https://runkit.com/gr2m/5aa034f1440b420012a6eebf -3. If it is a feature request, please share the motivation for the new feature, what alternatives you tried, and how you would implement it. -4. Please include links to the corresponding github documentation. - -## Setup the repository locally - -First, fork the repository. - -Setup the repository locally. Replace `` with the name of the account you forked to. - -```shell -git clone https://github.com//plugin-paginate-rest.js.git -cd plugin-paginate-rest.js -npm install -``` - -Run the tests before making changes to make sure the local setup is working as expected - -```shell -npm test -``` - -## Submitting the Pull Request - -- Create a new branch locally. -- Make your changes in that branch to your fork repository -- Submit a pull request from your topic branch to the master branch on the `octokit/plugin-paginate-rest.js` repository. -- Be sure to tag any issues your pull request is taking care of / contributing to. Adding "Closes #123" to a pull request description will automatically close the issue once the pull request is merged in. - -## Testing a pull request from github repo locally: - -You can install `@octokit/plugin-paginate-rest` from each pull request. Replace `[PULL REQUEST NUMBER]` - -Once you are done testing, you can revert back to the default module `@octokit/plugin-paginate-rest` from npm with `npm install @octokit/plugin-paginate-rest` - -## Merging the Pull Request & releasing a new version - -Releases are automated using [semantic-release](https://github.com/semantic-release/semantic-release). -The following commit message conventions determine which version is released: - -1. `fix: ...` or `fix(scope name): ...` prefix in subject: bumps fix version, e.g. `1.2.3` → `1.2.4` -2. `feat: ...` or `feat(scope name): ...` prefix in subject: bumps feature version, e.g. `1.2.3` → `1.3.0` -3. `BREAKING CHANGE:` in body: bumps breaking version, e.g. `1.2.3` → `2.0.0` - -Only one version number is bumped at a time, the highest version change trumps the others. -Besides publishing a new version to npm, semantic-release also creates a git tag and release -on GitHub, generates changelogs from the commit messages and puts them into the release notes. -s -If the pull request looks good but does not follow the commit conventions, use the Squash & merge button. diff --git a/node_modules/@octokit/types/README.md b/node_modules/@octokit/types/README.md index 482dae0..3c34447 100644 --- a/node_modules/@octokit/types/README.md +++ b/node_modules/@octokit/types/README.md @@ -4,11 +4,56 @@ [![@latest](https://img.shields.io/npm/v/@octokit/types.svg)](https://www.npmjs.com/package/@octokit/types) [![Build Status](https://github.com/octokit/types.ts/workflows/Test/badge.svg)](https://github.com/octokit/types.ts/actions?workflow=Test) -[![Greenkeeper](https://badges.greenkeeper.io/octokit/types.ts.svg)](https://greenkeeper.io/) + + + +- [Usage](#usage) +- [Examples](#examples) + - [Get parameter and response data types for a REST API endpoint](#get-parameter-and-response-data-types-for-a-rest-api-endpoint) + - [Get response types from endpoint methods](#get-response-types-from-endpoint-methods) +- [Contributing](#contributing) +- [License](#license) + + ## Usage -See https://octokit.github.io/types.ts for all exported types +See all exported types at https://octokit.github.io/types.ts + +## Examples + +### Get parameter and response data types for a REST API endpoint + +```ts +import { Endpoints } from "@octokit/types"; + +type listUserReposParameters = Endpoints["GET /repos/{owner}/{repo}"]["parameters"]; +type listUserReposResponse = Endpoints["GET /repos/{owner}/{repo}"]["response"]; + +async function listRepos( + options: listUserReposParameters +): listUserReposResponse["data"] { + // ... +} +``` + +### Get response types from endpoint methods + +```ts +import { + GetResponseTypeFromEndpointMethod, + GetResponseDataTypeFromEndpointMethod, +} from "@octokit/types"; +import { Octokit } from "@octokit/rest"; + +const octokit = new Octokit(); +type CreateLabelResponseType = GetResponseTypeFromEndpointMethod< + typeof octokit.issues.createLabel +>; +type CreateLabelResponseDataType = GetResponseDataTypeFromEndpointMethod< + typeof octokit.issues.createLabel +>; +``` ## Contributing diff --git a/node_modules/@octokit/types/dist-node/index.js b/node_modules/@octokit/types/dist-node/index.js new file mode 100644 index 0000000..f147b05 --- /dev/null +++ b/node_modules/@octokit/types/dist-node/index.js @@ -0,0 +1,8 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +const VERSION = "6.3.2"; + +exports.VERSION = VERSION; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/types/dist-node/index.js.map b/node_modules/@octokit/types/dist-node/index.js.map new file mode 100644 index 0000000..2d148d3 --- /dev/null +++ b/node_modules/@octokit/types/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/VERSION.js"],"sourcesContent":["export const VERSION = \"0.0.0-development\";\n"],"names":["VERSION"],"mappings":";;;;MAAaA,OAAO,GAAG;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/types/dist-src/AuthInterface.js b/node_modules/@octokit/types/dist-src/AuthInterface.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/AuthInterface.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/EndpointDefaults.js b/node_modules/@octokit/types/dist-src/EndpointDefaults.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/EndpointDefaults.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/EndpointInterface.js b/node_modules/@octokit/types/dist-src/EndpointInterface.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/EndpointInterface.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/EndpointOptions.js b/node_modules/@octokit/types/dist-src/EndpointOptions.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/EndpointOptions.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/Fetch.js b/node_modules/@octokit/types/dist-src/Fetch.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/Fetch.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js b/node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/OctokitResponse.js b/node_modules/@octokit/types/dist-src/OctokitResponse.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/OctokitResponse.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestError.js b/node_modules/@octokit/types/dist-src/RequestError.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestError.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestHeaders.js b/node_modules/@octokit/types/dist-src/RequestHeaders.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestHeaders.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestInterface.js b/node_modules/@octokit/types/dist-src/RequestInterface.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestInterface.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestMethod.js b/node_modules/@octokit/types/dist-src/RequestMethod.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestMethod.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestOptions.js b/node_modules/@octokit/types/dist-src/RequestOptions.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestOptions.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestParameters.js b/node_modules/@octokit/types/dist-src/RequestParameters.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestParameters.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestRequestOptions.js b/node_modules/@octokit/types/dist-src/RequestRequestOptions.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestRequestOptions.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/ResponseHeaders.js b/node_modules/@octokit/types/dist-src/ResponseHeaders.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/ResponseHeaders.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/Route.js b/node_modules/@octokit/types/dist-src/Route.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/Route.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/Signal.js b/node_modules/@octokit/types/dist-src/Signal.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/Signal.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/StrategyInterface.js b/node_modules/@octokit/types/dist-src/StrategyInterface.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/StrategyInterface.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/Url.js b/node_modules/@octokit/types/dist-src/Url.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/Url.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/VERSION.js b/node_modules/@octokit/types/dist-src/VERSION.js new file mode 100644 index 0000000..09cd978 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/VERSION.js @@ -0,0 +1 @@ +export const VERSION = "6.3.2"; diff --git a/node_modules/@octokit/types/dist-src/generated/Endpoints.js b/node_modules/@octokit/types/dist-src/generated/Endpoints.js new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/node_modules/@octokit/types/dist-src/generated/Endpoints.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/src/index.ts b/node_modules/@octokit/types/dist-src/index.js similarity index 82% rename from node_modules/@octokit/types/src/index.ts rename to node_modules/@octokit/types/dist-src/index.js index 200f0a2..004ae9b 100644 --- a/node_modules/@octokit/types/src/index.ts +++ b/node_modules/@octokit/types/dist-src/index.js @@ -4,6 +4,7 @@ export * from "./EndpointInterface"; export * from "./EndpointOptions"; export * from "./Fetch"; export * from "./OctokitResponse"; +export * from "./RequestError"; export * from "./RequestHeaders"; export * from "./RequestInterface"; export * from "./RequestMethod"; @@ -16,3 +17,5 @@ export * from "./Signal"; export * from "./StrategyInterface"; export * from "./Url"; export * from "./VERSION"; +export * from "./GetResponseTypeFromEndpointMethod"; +export * from "./generated/Endpoints"; diff --git a/node_modules/@octokit/types/dist-types/AuthInterface.d.ts b/node_modules/@octokit/types/dist-types/AuthInterface.d.ts new file mode 100644 index 0000000..8b39d61 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/AuthInterface.d.ts @@ -0,0 +1,31 @@ +import { EndpointOptions } from "./EndpointOptions"; +import { OctokitResponse } from "./OctokitResponse"; +import { RequestInterface } from "./RequestInterface"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; +/** + * Interface to implement complex authentication strategies for Octokit. + * An object Implementing the AuthInterface can directly be passed as the + * `auth` option in the Octokit constructor. + * + * For the official implementations of the most common authentication + * strategies, see https://github.com/octokit/auth.js + */ +export interface AuthInterface { + (...args: AuthOptions): Promise; + hook: { + /** + * Sends a request using the passed `request` instance + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: RequestInterface, options: EndpointOptions): Promise>; + /** + * Sends a request using the passed `request` instance + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: RequestInterface, route: Route, parameters?: RequestParameters): Promise>; + }; +} diff --git a/node_modules/@octokit/types/src/EndpointDefaults.ts b/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts similarity index 52% rename from node_modules/@octokit/types/src/EndpointDefaults.ts rename to node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts index 024f6eb..a2c2307 100644 --- a/node_modules/@octokit/types/src/EndpointDefaults.ts +++ b/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts @@ -2,21 +2,20 @@ import { RequestHeaders } from "./RequestHeaders"; import { RequestMethod } from "./RequestMethod"; import { RequestParameters } from "./RequestParameters"; import { Url } from "./Url"; - /** * The `.endpoint()` method is guaranteed to set all keys defined by RequestParameters * as well as the method property. */ -export type EndpointDefaults = RequestParameters & { - baseUrl: Url; - method: RequestMethod; - url?: Url; - headers: RequestHeaders & { - accept: string; - "user-agent": string; - }; - mediaType: { - format: string; - previews: string[]; - }; +export declare type EndpointDefaults = RequestParameters & { + baseUrl: Url; + method: RequestMethod; + url?: Url; + headers: RequestHeaders & { + accept: string; + "user-agent": string; + }; + mediaType: { + format: string; + previews: string[]; + }; }; diff --git a/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts b/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts new file mode 100644 index 0000000..d7b4009 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts @@ -0,0 +1,65 @@ +import { EndpointDefaults } from "./EndpointDefaults"; +import { RequestOptions } from "./RequestOptions"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; +import { Endpoints } from "./generated/Endpoints"; +export interface EndpointInterface { + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {object} endpoint Must set `url` unless it's set defaults. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: O & { + method?: string; + } & ("url" extends keyof D ? { + url?: string; + } : { + url: string; + })): RequestOptions & Pick; + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: keyof Endpoints | R, parameters?: P): (R extends keyof Endpoints ? Endpoints[R]["request"] : RequestOptions) & Pick; + /** + * Object with current default route and parameters + */ + DEFAULTS: D & EndpointDefaults; + /** + * Returns a new `endpoint` interface with new defaults + */ + defaults: (newDefaults: O) => EndpointInterface; + merge: { + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * + */ + (route: keyof Endpoints | R, parameters?: P): D & (R extends keyof Endpoints ? Endpoints[R]["request"] & Endpoints[R]["parameters"] : EndpointDefaults) & P; + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ +

(options: P): EndpointDefaults & D & P; + /** + * Returns current default options. + * + * @deprecated use endpoint.DEFAULTS instead + */ + (): D & EndpointDefaults; + }; + /** + * Stateless method to turn endpoint options into request options. + * Calling `endpoint(options)` is the same as calling `endpoint.parse(endpoint.merge(options))`. + * + * @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + parse: (options: O) => RequestOptions & Pick; +} diff --git a/node_modules/@octokit/types/src/EndpointOptions.ts b/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts similarity index 57% rename from node_modules/@octokit/types/src/EndpointOptions.ts rename to node_modules/@octokit/types/dist-types/EndpointOptions.d.ts index 0170604..b1b91f1 100644 --- a/node_modules/@octokit/types/src/EndpointOptions.ts +++ b/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts @@ -1,8 +1,7 @@ import { RequestMethod } from "./RequestMethod"; import { Url } from "./Url"; import { RequestParameters } from "./RequestParameters"; - -export type EndpointOptions = RequestParameters & { - method: RequestMethod; - url: Url; +export declare type EndpointOptions = RequestParameters & { + method: RequestMethod; + url: Url; }; diff --git a/node_modules/@octokit/types/src/Fetch.ts b/node_modules/@octokit/types/dist-types/Fetch.d.ts similarity index 67% rename from node_modules/@octokit/types/src/Fetch.ts rename to node_modules/@octokit/types/dist-types/Fetch.d.ts index 983c79b..cbbd5e8 100644 --- a/node_modules/@octokit/types/src/Fetch.ts +++ b/node_modules/@octokit/types/dist-types/Fetch.d.ts @@ -1,4 +1,4 @@ /** * Browser's fetch method (or compatible such as fetch-mock) */ -export type Fetch = any; +export declare type Fetch = any; diff --git a/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts b/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts new file mode 100644 index 0000000..70e1a8d --- /dev/null +++ b/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts @@ -0,0 +1,5 @@ +declare type Unwrap = T extends Promise ? U : T; +declare type AnyFunction = (...args: any[]) => any; +export declare type GetResponseTypeFromEndpointMethod = Unwrap>; +export declare type GetResponseDataTypeFromEndpointMethod = Unwrap>["data"]; +export {}; diff --git a/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts b/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts new file mode 100644 index 0000000..19ffff8 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts @@ -0,0 +1,17 @@ +import { ResponseHeaders } from "./ResponseHeaders"; +import { Url } from "./Url"; +export declare type OctokitResponse = { + headers: ResponseHeaders; + /** + * http response code + */ + status: S; + /** + * URL of response after all redirects + */ + url: Url; + /** + * This is the data you would see in https://developer.Octokit.com/v3/ + */ + data: T; +}; diff --git a/node_modules/@octokit/types/dist-types/RequestError.d.ts b/node_modules/@octokit/types/dist-types/RequestError.d.ts new file mode 100644 index 0000000..89174e6 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestError.d.ts @@ -0,0 +1,11 @@ +export declare type RequestError = { + name: string; + status: number; + documentation_url: string; + errors?: Array<{ + resource: string; + code: string; + field: string; + message?: string; + }>; +}; diff --git a/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts b/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts new file mode 100644 index 0000000..ac5aae0 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts @@ -0,0 +1,15 @@ +export declare type RequestHeaders = { + /** + * Avoid setting `headers.accept`, use `mediaType.{format|previews}` option instead. + */ + accept?: string; + /** + * Use `authorization` to send authenticated request, remember `token ` / `bearer ` prefixes. Example: `token 1234567890abcdef1234567890abcdef12345678` + */ + authorization?: string; + /** + * `user-agent` is set do a default and can be overwritten as needed. + */ + "user-agent"?: string; + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/types/dist-types/RequestInterface.d.ts b/node_modules/@octokit/types/dist-types/RequestInterface.d.ts new file mode 100644 index 0000000..851811f --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestInterface.d.ts @@ -0,0 +1,34 @@ +import { EndpointInterface } from "./EndpointInterface"; +import { OctokitResponse } from "./OctokitResponse"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; +import { Endpoints } from "./generated/Endpoints"; +export interface RequestInterface { + /** + * Sends a request based on endpoint options + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: O & { + method?: string; + } & ("url" extends keyof D ? { + url?: string; + } : { + url: string; + })): Promise>; + /** + * Sends a request based on endpoint options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: keyof Endpoints | R, options?: R extends keyof Endpoints ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters): R extends keyof Endpoints ? Promise : Promise>; + /** + * Returns a new `request` with updated route and parameters + */ + defaults: (newDefaults: O) => RequestInterface; + /** + * Octokit endpoint API, see {@link https://github.com/octokit/endpoint.js|@octokit/endpoint} + */ + endpoint: EndpointInterface; +} diff --git a/node_modules/@octokit/types/dist-types/RequestMethod.d.ts b/node_modules/@octokit/types/dist-types/RequestMethod.d.ts new file mode 100644 index 0000000..e999c8d --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestMethod.d.ts @@ -0,0 +1,4 @@ +/** + * HTTP Verb supported by GitHub's REST API + */ +export declare type RequestMethod = "DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT"; diff --git a/node_modules/@octokit/types/src/RequestOptions.ts b/node_modules/@octokit/types/dist-types/RequestOptions.d.ts similarity index 63% rename from node_modules/@octokit/types/src/RequestOptions.ts rename to node_modules/@octokit/types/dist-types/RequestOptions.d.ts index 4d765c0..97e2181 100644 --- a/node_modules/@octokit/types/src/RequestOptions.ts +++ b/node_modules/@octokit/types/dist-types/RequestOptions.d.ts @@ -2,14 +2,13 @@ import { RequestHeaders } from "./RequestHeaders"; import { RequestMethod } from "./RequestMethod"; import { RequestRequestOptions } from "./RequestRequestOptions"; import { Url } from "./Url"; - /** * Generic request options as they are returned by the `endpoint()` method */ -export type RequestOptions = { - method: RequestMethod; - url: Url; - headers: RequestHeaders; - body?: any; - request?: RequestRequestOptions; +export declare type RequestOptions = { + method: RequestMethod; + url: Url; + headers: RequestHeaders; + body?: any; + request?: RequestRequestOptions; }; diff --git a/node_modules/@octokit/types/dist-types/RequestParameters.d.ts b/node_modules/@octokit/types/dist-types/RequestParameters.d.ts new file mode 100644 index 0000000..b056a0e --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestParameters.d.ts @@ -0,0 +1,45 @@ +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { RequestHeaders } from "./RequestHeaders"; +import { Url } from "./Url"; +/** + * Parameters that can be passed into `request(route, parameters)` or `endpoint(route, parameters)` methods + */ +export declare type RequestParameters = { + /** + * Base URL to be used when a relative URL is passed, such as `/orgs/{org}`. + * If `baseUrl` is `https://enterprise.acme-inc.com/api/v3`, then the request + * will be sent to `https://enterprise.acme-inc.com/api/v3/orgs/{org}`. + */ + baseUrl?: Url; + /** + * HTTP headers. Use lowercase keys. + */ + headers?: RequestHeaders; + /** + * Media type options, see {@link https://developer.github.com/v3/media/|GitHub Developer Guide} + */ + mediaType?: { + /** + * `json` by default. Can be `raw`, `text`, `html`, `full`, `diff`, `patch`, `sha`, `base64`. Depending on endpoint + */ + format?: string; + /** + * Custom media type names of {@link https://developer.github.com/v3/media/|API Previews} without the `-preview` suffix. + * Example for single preview: `['squirrel-girl']`. + * Example for multiple previews: `['squirrel-girl', 'mister-fantastic']`. + */ + previews?: string[]; + }; + /** + * Pass custom meta information for the request. The `request` object will be returned as is. + */ + request?: RequestRequestOptions; + /** + * Any additional parameter will be passed as follows + * 1. URL parameter if `':parameter'` or `{parameter}` is part of `url` + * 2. Query parameter if `method` is `'GET'` or `'HEAD'` + * 3. Request body if `parameter` is `'data'` + * 4. JSON in the request body in the form of `body[parameter]` unless `parameter` key is `'data'` + */ + [parameter: string]: unknown; +}; diff --git a/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts b/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts new file mode 100644 index 0000000..4482a8a --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts @@ -0,0 +1,26 @@ +/// +import { Agent } from "http"; +import { Fetch } from "./Fetch"; +import { Signal } from "./Signal"; +/** + * Octokit-specific request options which are ignored for the actual request, but can be used by Octokit or plugins to manipulate how the request is sent or how a response is handled + */ +export declare type RequestRequestOptions = { + /** + * Node only. Useful for custom proxy, certificate, or dns lookup. + */ + agent?: Agent; + /** + * Custom replacement for built-in fetch method. Useful for testing or request hooks. + */ + fetch?: Fetch; + /** + * Use an `AbortController` instance to cancel a request. In node you can only cancel streamed requests. + */ + signal?: Signal; + /** + * Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). `options.request.signal` is recommended instead. + */ + timeout?: number; + [option: string]: any; +}; diff --git a/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts b/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts new file mode 100644 index 0000000..c8fbe43 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts @@ -0,0 +1,20 @@ +export declare type ResponseHeaders = { + "cache-control"?: string; + "content-length"?: number; + "content-type"?: string; + date?: string; + etag?: string; + "last-modified"?: string; + link?: string; + location?: string; + server?: string; + status?: string; + vary?: string; + "x-github-mediatype"?: string; + "x-github-request-id"?: string; + "x-oauth-scopes"?: string; + "x-ratelimit-limit"?: string; + "x-ratelimit-remaining"?: string; + "x-ratelimit-reset"?: string; + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/types/dist-types/Route.d.ts b/node_modules/@octokit/types/dist-types/Route.d.ts new file mode 100644 index 0000000..dcaac75 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/Route.d.ts @@ -0,0 +1,4 @@ +/** + * String consisting of an optional HTTP method and relative path or absolute URL. Examples: `'/orgs/{org}'`, `'PUT /orgs/{org}'`, `GET https://example.com/foo/bar` + */ +export declare type Route = string; diff --git a/node_modules/@octokit/types/src/Signal.ts b/node_modules/@octokit/types/dist-types/Signal.d.ts similarity index 73% rename from node_modules/@octokit/types/src/Signal.ts rename to node_modules/@octokit/types/dist-types/Signal.d.ts index bdf9700..4ebcf24 100644 --- a/node_modules/@octokit/types/src/Signal.ts +++ b/node_modules/@octokit/types/dist-types/Signal.d.ts @@ -3,4 +3,4 @@ * * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal */ -export type Signal = any; +export declare type Signal = any; diff --git a/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts b/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts new file mode 100644 index 0000000..405cbd2 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts @@ -0,0 +1,4 @@ +import { AuthInterface } from "./AuthInterface"; +export interface StrategyInterface { + (...args: StrategyOptions): AuthInterface; +} diff --git a/node_modules/@octokit/types/dist-types/Url.d.ts b/node_modules/@octokit/types/dist-types/Url.d.ts new file mode 100644 index 0000000..3e69916 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/Url.d.ts @@ -0,0 +1,4 @@ +/** + * Relative or absolute URL. Examples: `'/orgs/{org}'`, `https://example.com/foo/bar` + */ +export declare type Url = string; diff --git a/node_modules/@octokit/types/dist-types/VERSION.d.ts b/node_modules/@octokit/types/dist-types/VERSION.d.ts new file mode 100644 index 0000000..86e1450 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/VERSION.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "6.3.2"; diff --git a/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts b/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts new file mode 100644 index 0000000..e743758 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts @@ -0,0 +1,3006 @@ +import { paths } from "@octokit/openapi-types"; +import { OctokitResponse } from "../OctokitResponse"; +import { RequestHeaders } from "../RequestHeaders"; +import { RequestRequestOptions } from "../RequestRequestOptions"; +declare type UnionToIntersection = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never; +declare type ExtractParameters = "parameters" extends keyof T ? UnionToIntersection<{ + [K in keyof T["parameters"]]: T["parameters"][K]; +}[keyof T["parameters"]]> : {}; +declare type ExtractRequestBody = "requestBody" extends keyof T ? "application/json" extends keyof T["requestBody"] ? T["requestBody"]["application/json"] : { + data: { + [K in keyof T["requestBody"]]: T["requestBody"][K]; + }[keyof T["requestBody"]]; +} : {}; +declare type ToOctokitParameters = ExtractParameters & ExtractRequestBody; +declare type RequiredPreview = T extends string ? { + mediaType: { + previews: [T, ...string[]]; + }; +} : {}; +declare type Operation = { + parameters: ToOctokitParameters & RequiredPreview; + request: { + method: Method extends keyof MethodsMap ? MethodsMap[Method] : never; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; + }; + response: Url extends keyof EndpointsWithMissingRequiredResponseDataSchema ? Method extends EndpointsWithMissingRequiredResponseDataSchema[Url] ? DeepRequired> : ExtractOctokitResponse : ExtractOctokitResponse; +}; +declare type MethodsMap = { + delete: "DELETE"; + get: "GET"; + patch: "PATCH"; + post: "POST"; + put: "PUT"; +}; +declare type SuccessStatusesMap = { + "200": 200; + "201": 201; + "204": 204; +}; +declare type RedirectStatusesMap = { + "301": 301; + "302": 302; +}; +declare type SuccessStatuses = keyof SuccessStatusesMap; +declare type RedirectStatuses = keyof RedirectStatusesMap; +declare type KnownJsonResponseTypes = "application/json" | "application/scim+json"; +declare type SuccessResponseDataType = { + [K in SuccessStatuses & keyof Responses]: OctokitResponse extends never ? unknown : DataType, SuccessStatusesMap[K]>; +}[SuccessStatuses & keyof Responses]; +declare type RedirectResponseDataType = { + [K in RedirectStatuses & keyof Responses]: OctokitResponse; +}[RedirectStatuses & keyof Responses]; +declare type DataType = { + [K in KnownJsonResponseTypes & keyof T]: T[K]; +}[KnownJsonResponseTypes & keyof T]; +declare type ExtractOctokitResponse = "responses" extends keyof R ? SuccessResponseDataType extends never ? RedirectResponseDataType extends never ? never : RedirectResponseDataType : SuccessResponseDataType : unknown; +declare type EndpointsWithMissingRequiredResponseDataSchema = { + "/app/hook/config": "get" | "patch"; + "/app/installations/{installation_id}/access_tokens": "post"; + "/emojis": "get"; + "/enterprises/{enterprise}/actions/permissions": "get"; + "/enterprises/{enterprise}/actions/permissions/organizations": "get"; + "/enterprises/{enterprise}/actions/permissions/selected-actions": "get"; + "/enterprises/{enterprise}/actions/runner-groups": "get" | "post"; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": "get" | "patch"; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": "get"; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": "get"; + "/enterprises/{enterprise}/actions/runners": "get"; + "/enterprises/{enterprise}/actions/runners/downloads": "get"; + "/enterprises/{enterprise}/settings/billing/actions": "get"; + "/enterprises/{enterprise}/settings/billing/packages": "get"; + "/enterprises/{enterprise}/settings/billing/shared-storage": "get"; + "/installation/repositories": "get"; + "/notifications": "get"; + "/notifications/threads/{thread_id}": "get"; + "/orgs/{org}/actions/permissions": "get"; + "/orgs/{org}/actions/permissions/repositories": "get"; + "/orgs/{org}/actions/permissions/selected-actions": "get"; + "/orgs/{org}/actions/runner-groups": "get" | "post"; + "/orgs/{org}/actions/runner-groups/{runner_group_id}": "get" | "patch"; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": "get"; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": "get"; + "/orgs/{org}/actions/runners": "get"; + "/orgs/{org}/actions/runners/downloads": "get"; + "/orgs/{org}/actions/secrets": "get"; + "/orgs/{org}/actions/secrets/{secret_name}/repositories": "get"; + "/orgs/{org}/hooks/{hook_id}/config": "get" | "patch"; + "/orgs/{org}/installations": "get"; + "/orgs/{org}/invitations": "get" | "post"; + "/orgs/{org}/settings/billing/actions": "get"; + "/orgs/{org}/settings/billing/packages": "get"; + "/orgs/{org}/settings/billing/shared-storage": "get"; + "/orgs/{org}/team-sync/groups": "get"; + "/orgs/{org}/teams/{team_slug}/invitations": "get"; + "/orgs/{org}/teams/{team_slug}/projects": "get"; + "/orgs/{org}/teams/{team_slug}/projects/{project_id}": "get"; + "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": "get" | "patch"; + "/projects/columns/cards/{card_id}/moves": "post"; + "/projects/columns/{column_id}/moves": "post"; + "/repos/{owner}/{repo}/actions/artifacts": "get"; + "/repos/{owner}/{repo}/actions/permissions": "get"; + "/repos/{owner}/{repo}/actions/permissions/selected-actions": "get"; + "/repos/{owner}/{repo}/actions/runners": "get"; + "/repos/{owner}/{repo}/actions/runners/downloads": "get"; + "/repos/{owner}/{repo}/actions/runs": "get"; + "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": "get"; + "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": "get"; + "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": "get"; + "/repos/{owner}/{repo}/actions/secrets": "get"; + "/repos/{owner}/{repo}/actions/workflows": "get"; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": "get"; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": "get"; + "/repos/{owner}/{repo}/check-suites/preferences": "patch"; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": "get"; + "/repos/{owner}/{repo}/code-scanning/alerts": "get"; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": "get" | "patch"; + "/repos/{owner}/{repo}/code-scanning/analyses": "get"; + "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": "get"; + "/repos/{owner}/{repo}/commits/{ref}/check-runs": "get"; + "/repos/{owner}/{repo}/commits/{ref}/check-suites": "get"; + "/repos/{owner}/{repo}/commits/{ref}/statuses": "get"; + "/repos/{owner}/{repo}/contents/{path}": "put" | "delete"; + "/repos/{owner}/{repo}/git/blobs": "post"; + "/repos/{owner}/{repo}/git/commits": "post"; + "/repos/{owner}/{repo}/git/commits/{commit_sha}": "get"; + "/repos/{owner}/{repo}/git/matching-refs/{ref}": "get"; + "/repos/{owner}/{repo}/git/ref/{ref}": "get"; + "/repos/{owner}/{repo}/git/refs": "post"; + "/repos/{owner}/{repo}/git/refs/{ref}": "patch"; + "/repos/{owner}/{repo}/hooks/{hook_id}/config": "get" | "patch"; + "/repos/{owner}/{repo}/issues/{issue_number}/events": "get"; + "/repos/{owner}/{repo}/issues/{issue_number}/timeline": "get"; + "/repos/{owner}/{repo}/keys": "get" | "post"; + "/repos/{owner}/{repo}/keys/{key_id}": "get"; + "/repos/{owner}/{repo}/languages": "get"; + "/repos/{owner}/{repo}/notifications": "get"; + "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": "get"; + "/repos/{owner}/{repo}/stats/participation": "get"; + "/repos/{owner}/{repo}/statuses/{sha}": "post"; + "/repos/{owner}/{repo}/topics": "get" | "put"; + "/scim/v2/enterprises/{enterprise}/Groups": "get" | "post"; + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": "get" | "put" | "patch"; + "/scim/v2/enterprises/{enterprise}/Users": "get" | "post"; + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": "get" | "put" | "patch"; + "/search/code": "get"; + "/search/commits": "get"; + "/search/issues": "get"; + "/search/labels": "get"; + "/search/repositories": "get"; + "/search/topics": "get"; + "/search/users": "get"; + "/teams/{team_id}/invitations": "get"; + "/teams/{team_id}/projects": "get"; + "/teams/{team_id}/projects/{project_id}": "get"; + "/teams/{team_id}/team-sync/group-mappings": "get" | "patch"; + "/user/installations": "get"; + "/user/installations/{installation_id}/repositories": "get"; + "/user/keys": "get" | "post"; + "/user/keys/{key_id}": "get"; + "/users/{username}/settings/billing/actions": "get"; + "/users/{username}/settings/billing/packages": "get"; + "/users/{username}/settings/billing/shared-storage": "get"; +}; +declare type NotNill = T extends null | undefined ? never : T; +declare type Primitive = undefined | null | boolean | string | number | Function; +declare type DeepRequired = T extends Primitive ? NotNill : { + [P in keyof T]-?: T[P] extends Array ? Array> : T[P] extends ReadonlyArray ? DeepRequired : DeepRequired; +}; +export interface Endpoints { + /** + * @see https://docs.github.com/v3/apps/#delete-an-installation-for-the-authenticated-app + */ + "DELETE /app/installations/{installation_id}": Operation<"/app/installations/{installation_id}", "delete">; + /** + * @see https://docs.github.com/v3/apps/#unsuspend-an-app-installation + */ + "DELETE /app/installations/{installation_id}/suspended": Operation<"/app/installations/{installation_id}/suspended", "delete">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#delete-a-grant + */ + "DELETE /applications/grants/{grant_id}": Operation<"/applications/grants/{grant_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#delete-an-app-authorization + */ + "DELETE /applications/{client_id}/grant": Operation<"/applications/{client_id}/grant", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#revoke-a-grant-for-an-application + */ + "DELETE /applications/{client_id}/grants/{access_token}": Operation<"/applications/{client_id}/grants/{access_token}", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#delete-an-app-token + */ + "DELETE /applications/{client_id}/token": Operation<"/applications/{client_id}/token", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#revoke-an-authorization-for-an-application + */ + "DELETE /applications/{client_id}/tokens/{access_token}": Operation<"/applications/{client_id}/tokens/{access_token}", "delete">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#delete-an-authorization + */ + "DELETE /authorizations/{authorization_id}": Operation<"/authorizations/{authorization_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise + */ + "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}": Operation<"/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise + */ + "DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + */ + "DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise + */ + "DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise + */ + "DELETE /enterprises/{enterprise}/actions/runners/{runner_id}": Operation<"/enterprises/{enterprise}/actions/runners/{runner_id}", "delete">; + /** + * @see https://docs.github.com/v3/gists/#delete-a-gist + */ + "DELETE /gists/{gist_id}": Operation<"/gists/{gist_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/gists#delete-a-gist-comment + */ + "DELETE /gists/{gist_id}/comments/{comment_id}": Operation<"/gists/{gist_id}/comments/{comment_id}", "delete">; + /** + * @see https://docs.github.com/v3/gists/#unstar-a-gist + */ + "DELETE /gists/{gist_id}/star": Operation<"/gists/{gist_id}/star", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#revoke-an-installation-access-token + */ + "DELETE /installation/token": Operation<"/installation/token", "delete">; + /** + * @see https://docs.github.com/rest/reference/activity#delete-a-thread-subscription + */ + "DELETE /notifications/threads/{thread_id}/subscription": Operation<"/notifications/threads/{thread_id}/subscription", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization + */ + "DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}": Operation<"/orgs/{org}/actions/permissions/repositories/{repository_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-group-from-an-organization + */ + "DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization + */ + "DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization + */ + "DELETE /orgs/{org}/actions/runners/{runner_id}": Operation<"/orgs/{org}/actions/runners/{runner_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-an-organization-secret + */ + "DELETE /orgs/{org}/actions/secrets/{secret_name}": Operation<"/orgs/{org}/actions/secrets/{secret_name}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret + */ + "DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": Operation<"/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/orgs#unblock-a-user-from-an-organization + */ + "DELETE /orgs/{org}/blocks/{username}": Operation<"/orgs/{org}/blocks/{username}", "delete">; + /** + * @see https://docs.github.com/v3/orgs/#remove-a-saml-sso-authorization-for-an-organization + */ + "DELETE /orgs/{org}/credential-authorizations/{credential_id}": Operation<"/orgs/{org}/credential-authorizations/{credential_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/orgs#delete-an-organization-webhook + */ + "DELETE /orgs/{org}/hooks/{hook_id}": Operation<"/orgs/{org}/hooks/{hook_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-an-organization + */ + "DELETE /orgs/{org}/interaction-limits": Operation<"/orgs/{org}/interaction-limits", "delete">; + /** + * @see https://docs.github.com/rest/reference/orgs#remove-an-organization-member + */ + "DELETE /orgs/{org}/members/{username}": Operation<"/orgs/{org}/members/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/orgs#remove-organization-membership-for-a-user + */ + "DELETE /orgs/{org}/memberships/{username}": Operation<"/orgs/{org}/memberships/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/migrations#delete-an-organization-migration-archive + */ + "DELETE /orgs/{org}/migrations/{migration_id}/archive": Operation<"/orgs/{org}/migrations/{migration_id}/archive", "delete", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#unlock-an-organization-repository + */ + "DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": Operation<"/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", "delete", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/orgs#remove-outside-collaborator-from-an-organization + */ + "DELETE /orgs/{org}/outside_collaborators/{username}": Operation<"/orgs/{org}/outside_collaborators/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user + */ + "DELETE /orgs/{org}/public_members/{username}": Operation<"/orgs/{org}/public_members/{username}", "delete">; + /** + * @see https://docs.github.com/v3/teams/#delete-a-team + */ + "DELETE /orgs/{org}/teams/{team_slug}": Operation<"/orgs/{org}/teams/{team_slug}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#delete-a-discussion + */ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#delete-a-discussion-comment + */ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "delete">; + /** + * @see https://docs.github.com/v3/reactions/#delete-team-discussion-comment-reaction + */ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/v3/reactions/#delete-team-discussion-reaction + */ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user + */ + "DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}": Operation<"/orgs/{org}/teams/{team_slug}/memberships/{username}", "delete">; + /** + * @see https://docs.github.com/v3/teams/#remove-a-project-from-a-team + */ + "DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}": Operation<"/orgs/{org}/teams/{team_slug}/projects/{project_id}", "delete">; + /** + * @see https://docs.github.com/v3/teams/#remove-a-repository-from-a-team + */ + "DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": Operation<"/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "delete">; + /** + * @see https://docs.github.com/rest/reference/projects#delete-a-project-card + */ + "DELETE /projects/columns/cards/{card_id}": Operation<"/projects/columns/cards/{card_id}", "delete", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#delete-a-project-column + */ + "DELETE /projects/columns/{column_id}": Operation<"/projects/columns/{column_id}", "delete", "inertia">; + /** + * @see https://docs.github.com/v3/projects/#delete-a-project + */ + "DELETE /projects/{project_id}": Operation<"/projects/{project_id}", "delete", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#remove-project-collaborator + */ + "DELETE /projects/{project_id}/collaborators/{username}": Operation<"/projects/{project_id}/collaborators/{username}", "delete", "inertia">; + /** + * @see https://docs.github.com/v3/reactions/#delete-a-reaction-legacy + */ + "DELETE /reactions/{reaction_id}": Operation<"/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/v3/repos/#delete-a-repository + */ + "DELETE /repos/{owner}/{repo}": Operation<"/repos/{owner}/{repo}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-an-artifact + */ + "DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}": Operation<"/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository + */ + "DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}": Operation<"/repos/{owner}/{repo}/actions/runners/{runner_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-a-workflow-run + */ + "DELETE /repos/{owner}/{repo}/actions/runs/{run_id}": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-workflow-run-logs + */ + "DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/logs", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-a-repository-secret + */ + "DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}": Operation<"/repos/{owner}/{repo}/actions/secrets/{secret_name}", "delete">; + /** + * @see https://docs.github.com/v3/repos/#disable-automated-security-fixes + */ + "DELETE /repos/{owner}/{repo}/automated-security-fixes": Operation<"/repos/{owner}/{repo}/automated-security-fixes", "delete", "london">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-branch-protection + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-admin-branch-protection + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-pull-request-review-protection + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-commit-signature-protection + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "delete", "zzzax">; + /** + * @see https://docs.github.com/rest/reference/repos#remove-status-check-protection + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#remove-status-check-contexts + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-access-restrictions + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#remove-app-access-restrictions + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#remove-team-access-restrictions + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#remove-user-access-restrictions + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#remove-a-repository-collaborator + */ + "DELETE /repos/{owner}/{repo}/collaborators/{username}": Operation<"/repos/{owner}/{repo}/collaborators/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-commit-comment + */ + "DELETE /repos/{owner}/{repo}/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/comments/{comment_id}", "delete">; + /** + * @see https://docs.github.com/v3/reactions/#delete-a-commit-comment-reaction + */ + "DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": Operation<"/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-file + */ + "DELETE /repos/{owner}/{repo}/contents/{path}": Operation<"/repos/{owner}/{repo}/contents/{path}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-deployment + */ + "DELETE /repos/{owner}/{repo}/deployments/{deployment_id}": Operation<"/repos/{owner}/{repo}/deployments/{deployment_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/git#delete-a-reference + */ + "DELETE /repos/{owner}/{repo}/git/refs/{ref}": Operation<"/repos/{owner}/{repo}/git/refs/{ref}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-repository-webhook + */ + "DELETE /repos/{owner}/{repo}/hooks/{hook_id}": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/migrations#cancel-an-import + */ + "DELETE /repos/{owner}/{repo}/import": Operation<"/repos/{owner}/{repo}/import", "delete">; + /** + * @see https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-a-repository + */ + "DELETE /repos/{owner}/{repo}/interaction-limits": Operation<"/repos/{owner}/{repo}/interaction-limits", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-repository-invitation + */ + "DELETE /repos/{owner}/{repo}/invitations/{invitation_id}": Operation<"/repos/{owner}/{repo}/invitations/{invitation_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/issues#delete-an-issue-comment + */ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/issues/comments/{comment_id}", "delete">; + /** + * @see https://docs.github.com/v3/reactions/#delete-an-issue-comment-reaction + */ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": Operation<"/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue + */ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/assignees", "delete">; + /** + * @see https://docs.github.com/rest/reference/issues#remove-all-labels-from-an-issue + */ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/labels", "delete">; + /** + * @see https://docs.github.com/rest/reference/issues#remove-a-label-from-an-issue + */ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", "delete">; + /** + * @see https://docs.github.com/v3/issues/#unlock-an-issue + */ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/lock", "delete">; + /** + * @see https://docs.github.com/v3/reactions/#delete-an-issue-reaction + */ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-deploy-key + */ + "DELETE /repos/{owner}/{repo}/keys/{key_id}": Operation<"/repos/{owner}/{repo}/keys/{key_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/issues#delete-a-label + */ + "DELETE /repos/{owner}/{repo}/labels/{name}": Operation<"/repos/{owner}/{repo}/labels/{name}", "delete">; + /** + * @see https://docs.github.com/rest/reference/issues#delete-a-milestone + */ + "DELETE /repos/{owner}/{repo}/milestones/{milestone_number}": Operation<"/repos/{owner}/{repo}/milestones/{milestone_number}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-github-pages-site + */ + "DELETE /repos/{owner}/{repo}/pages": Operation<"/repos/{owner}/{repo}/pages", "delete", "switcheroo">; + /** + * @see https://docs.github.com/rest/reference/pulls#delete-a-review-comment-for-a-pull-request + */ + "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/pulls/comments/{comment_id}", "delete">; + /** + * @see https://docs.github.com/v3/reactions/#delete-a-pull-request-comment-reaction + */ + "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": Operation<"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request + */ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "delete">; + /** + * @see https://docs.github.com/rest/reference/pulls#delete-a-pending-review-for-a-pull-request + */ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-release-asset + */ + "DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}": Operation<"/repos/{owner}/{repo}/releases/assets/{asset_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-release + */ + "DELETE /repos/{owner}/{repo}/releases/{release_id}": Operation<"/repos/{owner}/{repo}/releases/{release_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/activity#delete-a-repository-subscription + */ + "DELETE /repos/{owner}/{repo}/subscription": Operation<"/repos/{owner}/{repo}/subscription", "delete">; + /** + * @see https://docs.github.com/v3/repos/#disable-vulnerability-alerts + */ + "DELETE /repos/{owner}/{repo}/vulnerability-alerts": Operation<"/repos/{owner}/{repo}/vulnerability-alerts", "delete", "dorian">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise + */ + "DELETE /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": Operation<"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#delete-a-scim-user-from-an-enterprise + */ + "DELETE /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": Operation<"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "delete">; + /** + * @see https://docs.github.com/v3/scim/#delete-a-scim-user-from-an-organization + */ + "DELETE /scim/v2/organizations/{org}/Users/{scim_user_id}": Operation<"/scim/v2/organizations/{org}/Users/{scim_user_id}", "delete">; + /** + * @see https://docs.github.com/v3/teams/#delete-a-team-legacy + */ + "DELETE /teams/{team_id}": Operation<"/teams/{team_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#delete-a-discussion-legacy + */ + "DELETE /teams/{team_id}/discussions/{discussion_number}": Operation<"/teams/{team_id}/discussions/{discussion_number}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#delete-a-discussion-comment-legacy + */ + "DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#remove-team-member-legacy + */ + "DELETE /teams/{team_id}/members/{username}": Operation<"/teams/{team_id}/members/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user-legacy + */ + "DELETE /teams/{team_id}/memberships/{username}": Operation<"/teams/{team_id}/memberships/{username}", "delete">; + /** + * @see https://docs.github.com/v3/teams/#remove-a-project-from-a-team-legacy + */ + "DELETE /teams/{team_id}/projects/{project_id}": Operation<"/teams/{team_id}/projects/{project_id}", "delete">; + /** + * @see https://docs.github.com/v3/teams/#remove-a-repository-from-a-team-legacy + */ + "DELETE /teams/{team_id}/repos/{owner}/{repo}": Operation<"/teams/{team_id}/repos/{owner}/{repo}", "delete">; + /** + * @see https://docs.github.com/rest/reference/users#unblock-a-user + */ + "DELETE /user/blocks/{username}": Operation<"/user/blocks/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user + */ + "DELETE /user/emails": Operation<"/user/emails", "delete">; + /** + * @see https://docs.github.com/rest/reference/users#unfollow-a-user + */ + "DELETE /user/following/{username}": Operation<"/user/following/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user + */ + "DELETE /user/gpg_keys/{gpg_key_id}": Operation<"/user/gpg_keys/{gpg_key_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation + */ + "DELETE /user/installations/{installation_id}/repositories/{repository_id}": Operation<"/user/installations/{installation_id}/repositories/{repository_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories + */ + "DELETE /user/interaction-limits": Operation<"/user/interaction-limits", "delete">; + /** + * @see https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user + */ + "DELETE /user/keys/{key_id}": Operation<"/user/keys/{key_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/migrations#delete-a-user-migration-archive + */ + "DELETE /user/migrations/{migration_id}/archive": Operation<"/user/migrations/{migration_id}/archive", "delete", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#unlock-a-user-repository + */ + "DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock": Operation<"/user/migrations/{migration_id}/repos/{repo_name}/lock", "delete", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/repos#decline-a-repository-invitation + */ + "DELETE /user/repository_invitations/{invitation_id}": Operation<"/user/repository_invitations/{invitation_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/activity#unstar-a-repository-for-the-authenticated-user + */ + "DELETE /user/starred/{owner}/{repo}": Operation<"/user/starred/{owner}/{repo}", "delete">; + /** + * @see + */ + "GET /": Operation<"/", "get">; + /** + * @see https://docs.github.com/v3/apps/#get-the-authenticated-app + */ + "GET /app": Operation<"/app", "get">; + /** + * @see https://docs.github.com/v3/apps#get-a-webhook-configuration-for-an-app + */ + "GET /app/hook/config": Operation<"/app/hook/config", "get">; + /** + * @see https://docs.github.com/v3/apps/#list-installations-for-the-authenticated-app + */ + "GET /app/installations": Operation<"/app/installations", "get">; + /** + * @see https://docs.github.com/v3/apps/#get-an-installation-for-the-authenticated-app + */ + "GET /app/installations/{installation_id}": Operation<"/app/installations/{installation_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#list-your-grants + */ + "GET /applications/grants": Operation<"/applications/grants", "get">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#get-a-single-grant + */ + "GET /applications/grants/{grant_id}": Operation<"/applications/grants/{grant_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#check-an-authorization + */ + "GET /applications/{client_id}/tokens/{access_token}": Operation<"/applications/{client_id}/tokens/{access_token}", "get">; + /** + * @see https://docs.github.com/v3/apps/#get-an-app + */ + "GET /apps/{app_slug}": Operation<"/apps/{app_slug}", "get">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations + */ + "GET /authorizations": Operation<"/authorizations", "get">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#get-a-single-authorization + */ + "GET /authorizations/{authorization_id}": Operation<"/authorizations/{authorization_id}", "get">; + /** + * @see https://docs.github.com/v3/codes_of_conduct/#get-all-codes-of-conduct + */ + "GET /codes_of_conduct": Operation<"/codes_of_conduct", "get", "scarlet-witch">; + /** + * @see https://docs.github.com/v3/codes_of_conduct/#get-a-code-of-conduct + */ + "GET /codes_of_conduct/{key}": Operation<"/codes_of_conduct/{key}", "get", "scarlet-witch">; + /** + * @see https://docs.github.com/v3/emojis/#get-emojis + */ + "GET /emojis": Operation<"/emojis", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/permissions": Operation<"/enterprises/{enterprise}/actions/permissions", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/permissions/organizations": Operation<"/enterprises/{enterprise}/actions/permissions/organizations", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/permissions/selected-actions": Operation<"/enterprises/{enterprise}/actions/permissions/selected-actions", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups": Operation<"/enterprises/{enterprise}/actions/runner-groups", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runners": Operation<"/enterprises/{enterprise}/actions/runners", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-runner-applications-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runners/downloads": Operation<"/enterprises/{enterprise}/actions/runners/downloads", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runners/{runner_id}": Operation<"/enterprises/{enterprise}/actions/runners/{runner_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-the-audit-log-for-an-enterprise + */ + "GET /enterprises/{enterprise}/audit-log": Operation<"/enterprises/{enterprise}/audit-log", "get">; + /** + * @see https://docs.github.com/v3/billing/#get-github-actions-billing-for-an-enterprise + */ + "GET /enterprises/{enterprise}/settings/billing/actions": Operation<"/enterprises/{enterprise}/settings/billing/actions", "get">; + /** + * @see https://docs.github.com/v3/billing/#get-github-packages-billing-for-an-enterprise + */ + "GET /enterprises/{enterprise}/settings/billing/packages": Operation<"/enterprises/{enterprise}/settings/billing/packages", "get">; + /** + * @see https://docs.github.com/v3/billing/#get-shared-storage-billing-for-an-enterprise + */ + "GET /enterprises/{enterprise}/settings/billing/shared-storage": Operation<"/enterprises/{enterprise}/settings/billing/shared-storage", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events + */ + "GET /events": Operation<"/events", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#get-feeds + */ + "GET /feeds": Operation<"/feeds", "get">; + /** + * @see https://docs.github.com/v3/gists/#list-gists-for-the-authenticated-user + */ + "GET /gists": Operation<"/gists", "get">; + /** + * @see https://docs.github.com/v3/gists/#list-public-gists + */ + "GET /gists/public": Operation<"/gists/public", "get">; + /** + * @see https://docs.github.com/v3/gists/#list-starred-gists + */ + "GET /gists/starred": Operation<"/gists/starred", "get">; + /** + * @see https://docs.github.com/v3/gists/#get-a-gist + */ + "GET /gists/{gist_id}": Operation<"/gists/{gist_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#list-gist-comments + */ + "GET /gists/{gist_id}/comments": Operation<"/gists/{gist_id}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#get-a-gist-comment + */ + "GET /gists/{gist_id}/comments/{comment_id}": Operation<"/gists/{gist_id}/comments/{comment_id}", "get">; + /** + * @see https://docs.github.com/v3/gists/#list-gist-commits + */ + "GET /gists/{gist_id}/commits": Operation<"/gists/{gist_id}/commits", "get">; + /** + * @see https://docs.github.com/v3/gists/#list-gist-forks + */ + "GET /gists/{gist_id}/forks": Operation<"/gists/{gist_id}/forks", "get">; + /** + * @see https://docs.github.com/v3/gists/#check-if-a-gist-is-starred + */ + "GET /gists/{gist_id}/star": Operation<"/gists/{gist_id}/star", "get">; + /** + * @see https://docs.github.com/v3/gists/#get-a-gist-revision + */ + "GET /gists/{gist_id}/{sha}": Operation<"/gists/{gist_id}/{sha}", "get">; + /** + * @see https://docs.github.com/v3/gitignore/#get-all-gitignore-templates + */ + "GET /gitignore/templates": Operation<"/gitignore/templates", "get">; + /** + * @see https://docs.github.com/v3/gitignore/#get-a-gitignore-template + */ + "GET /gitignore/templates/{name}": Operation<"/gitignore/templates/{name}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-app-installation + */ + "GET /installation/repositories": Operation<"/installation/repositories", "get">; + /** + * @see https://docs.github.com/v3/issues/#list-issues-assigned-to-the-authenticated-user + */ + "GET /issues": Operation<"/issues", "get">; + /** + * @see https://docs.github.com/v3/licenses/#get-all-commonly-used-licenses + */ + "GET /licenses": Operation<"/licenses", "get">; + /** + * @see https://docs.github.com/v3/licenses/#get-a-license + */ + "GET /licenses/{license}": Operation<"/licenses/{license}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account + */ + "GET /marketplace_listing/accounts/{account_id}": Operation<"/marketplace_listing/accounts/{account_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-plans + */ + "GET /marketplace_listing/plans": Operation<"/marketplace_listing/plans", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan + */ + "GET /marketplace_listing/plans/{plan_id}/accounts": Operation<"/marketplace_listing/plans/{plan_id}/accounts", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account-stubbed + */ + "GET /marketplace_listing/stubbed/accounts/{account_id}": Operation<"/marketplace_listing/stubbed/accounts/{account_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-plans-stubbed + */ + "GET /marketplace_listing/stubbed/plans": Operation<"/marketplace_listing/stubbed/plans", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan-stubbed + */ + "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts": Operation<"/marketplace_listing/stubbed/plans/{plan_id}/accounts", "get">; + /** + * @see https://docs.github.com/v3/meta/#get-github-meta-information + */ + "GET /meta": Operation<"/meta", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories + */ + "GET /networks/{owner}/{repo}/events": Operation<"/networks/{owner}/{repo}/events", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user + */ + "GET /notifications": Operation<"/notifications", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#get-a-thread + */ + "GET /notifications/threads/{thread_id}": Operation<"/notifications/threads/{thread_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user + */ + "GET /notifications/threads/{thread_id}/subscription": Operation<"/notifications/threads/{thread_id}/subscription", "get">; + /** + * @see + */ + "GET /octocat": Operation<"/octocat", "get">; + /** + * @see https://docs.github.com/v3/orgs/#list-organizations + */ + "GET /organizations": Operation<"/organizations", "get">; + /** + * @see https://docs.github.com/v3/orgs/#get-an-organization + */ + "GET /orgs/{org}": Operation<"/orgs/{org}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization + */ + "GET /orgs/{org}/actions/permissions": Operation<"/orgs/{org}/actions/permissions", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization + */ + "GET /orgs/{org}/actions/permissions/repositories": Operation<"/orgs/{org}/actions/permissions/repositories", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-organization + */ + "GET /orgs/{org}/actions/permissions/selected-actions": Operation<"/orgs/{org}/actions/permissions/selected-actions", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runner-groups-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups": Operation<"/orgs/{org}/actions/runner-groups", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-group-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-in-a-group-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization + */ + "GET /orgs/{org}/actions/runners": Operation<"/orgs/{org}/actions/runners", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization + */ + "GET /orgs/{org}/actions/runners/downloads": Operation<"/orgs/{org}/actions/runners/downloads", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-an-organization + */ + "GET /orgs/{org}/actions/runners/{runner_id}": Operation<"/orgs/{org}/actions/runners/{runner_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-organization-secrets + */ + "GET /orgs/{org}/actions/secrets": Operation<"/orgs/{org}/actions/secrets", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-an-organization-public-key + */ + "GET /orgs/{org}/actions/secrets/public-key": Operation<"/orgs/{org}/actions/secrets/public-key", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-an-organization-secret + */ + "GET /orgs/{org}/actions/secrets/{secret_name}": Operation<"/orgs/{org}/actions/secrets/{secret_name}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret + */ + "GET /orgs/{org}/actions/secrets/{secret_name}/repositories": Operation<"/orgs/{org}/actions/secrets/{secret_name}/repositories", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#get-the-audit-log-for-an-organization + */ + "GET /orgs/{org}/audit-log": Operation<"/orgs/{org}/audit-log", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-users-blocked-by-an-organization + */ + "GET /orgs/{org}/blocks": Operation<"/orgs/{org}/blocks", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization + */ + "GET /orgs/{org}/blocks/{username}": Operation<"/orgs/{org}/blocks/{username}", "get">; + /** + * @see https://docs.github.com/v3/orgs/#list-saml-sso-authorizations-for-an-organization + */ + "GET /orgs/{org}/credential-authorizations": Operation<"/orgs/{org}/credential-authorizations", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-organization-events + */ + "GET /orgs/{org}/events": Operation<"/orgs/{org}/events", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-webhooks + */ + "GET /orgs/{org}/hooks": Operation<"/orgs/{org}/hooks", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#get-an-organization-webhook + */ + "GET /orgs/{org}/hooks/{hook_id}": Operation<"/orgs/{org}/hooks/{hook_id}", "get">; + /** + * @see https://docs.github.com/v3/orgs#get-a-webhook-configuration-for-an-organization + */ + "GET /orgs/{org}/hooks/{hook_id}/config": Operation<"/orgs/{org}/hooks/{hook_id}/config", "get">; + /** + * @see https://docs.github.com/v3/apps/#get-an-organization-installation-for-the-authenticated-app + */ + "GET /orgs/{org}/installation": Operation<"/orgs/{org}/installation", "get">; + /** + * @see https://docs.github.com/v3/orgs/#list-app-installations-for-an-organization + */ + "GET /orgs/{org}/installations": Operation<"/orgs/{org}/installations", "get">; + /** + * @see https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-an-organization + */ + "GET /orgs/{org}/interaction-limits": Operation<"/orgs/{org}/interaction-limits", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-pending-organization-invitations + */ + "GET /orgs/{org}/invitations": Operation<"/orgs/{org}/invitations", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-invitation-teams + */ + "GET /orgs/{org}/invitations/{invitation_id}/teams": Operation<"/orgs/{org}/invitations/{invitation_id}/teams", "get">; + /** + * @see https://docs.github.com/v3/issues/#list-organization-issues-assigned-to-the-authenticated-user + */ + "GET /orgs/{org}/issues": Operation<"/orgs/{org}/issues", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-members + */ + "GET /orgs/{org}/members": Operation<"/orgs/{org}/members", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#check-organization-membership-for-a-user + */ + "GET /orgs/{org}/members/{username}": Operation<"/orgs/{org}/members/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user + */ + "GET /orgs/{org}/memberships/{username}": Operation<"/orgs/{org}/memberships/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/migrations#list-organization-migrations + */ + "GET /orgs/{org}/migrations": Operation<"/orgs/{org}/migrations", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#get-an-organization-migration-status + */ + "GET /orgs/{org}/migrations/{migration_id}": Operation<"/orgs/{org}/migrations/{migration_id}", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#download-an-organization-migration-archive + */ + "GET /orgs/{org}/migrations/{migration_id}/archive": Operation<"/orgs/{org}/migrations/{migration_id}/archive", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#list-repositories-in-an-organization-migration + */ + "GET /orgs/{org}/migrations/{migration_id}/repositories": Operation<"/orgs/{org}/migrations/{migration_id}/repositories", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-outside-collaborators-for-an-organization + */ + "GET /orgs/{org}/outside_collaborators": Operation<"/orgs/{org}/outside_collaborators", "get">; + /** + * @see https://docs.github.com/v3/projects/#list-organization-projects + */ + "GET /orgs/{org}/projects": Operation<"/orgs/{org}/projects", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-public-organization-members + */ + "GET /orgs/{org}/public_members": Operation<"/orgs/{org}/public_members", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#check-public-organization-membership-for-a-user + */ + "GET /orgs/{org}/public_members/{username}": Operation<"/orgs/{org}/public_members/{username}", "get">; + /** + * @see https://docs.github.com/v3/repos/#list-organization-repositories + */ + "GET /orgs/{org}/repos": Operation<"/orgs/{org}/repos", "get">; + /** + * @see https://docs.github.com/v3/billing/#get-github-actions-billing-for-an-organization + */ + "GET /orgs/{org}/settings/billing/actions": Operation<"/orgs/{org}/settings/billing/actions", "get">; + /** + * @see https://docs.github.com/v3/billing/#get-github-packages-billing-for-an-organization + */ + "GET /orgs/{org}/settings/billing/packages": Operation<"/orgs/{org}/settings/billing/packages", "get">; + /** + * @see https://docs.github.com/v3/billing/#get-shared-storage-billing-for-an-organization + */ + "GET /orgs/{org}/settings/billing/shared-storage": Operation<"/orgs/{org}/settings/billing/shared-storage", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-an-organization + */ + "GET /orgs/{org}/team-sync/groups": Operation<"/orgs/{org}/team-sync/groups", "get">; + /** + * @see https://docs.github.com/v3/teams/#list-teams + */ + "GET /orgs/{org}/teams": Operation<"/orgs/{org}/teams", "get">; + /** + * @see https://docs.github.com/v3/teams/#get-a-team-by-name + */ + "GET /orgs/{org}/teams/{team_slug}": Operation<"/orgs/{org}/teams/{team_slug}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussions + */ + "GET /orgs/{org}/teams/{team_slug}/discussions": Operation<"/orgs/{org}/teams/{team_slug}/discussions", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-a-discussion + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussion-comments + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-a-discussion-comment + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "get">; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-a-team-discussion + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/teams#list-pending-team-invitations + */ + "GET /orgs/{org}/teams/{team_slug}/invitations": Operation<"/orgs/{org}/teams/{team_slug}/invitations", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-team-members + */ + "GET /orgs/{org}/teams/{team_slug}/members": Operation<"/orgs/{org}/teams/{team_slug}/members", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user + */ + "GET /orgs/{org}/teams/{team_slug}/memberships/{username}": Operation<"/orgs/{org}/teams/{team_slug}/memberships/{username}", "get">; + /** + * @see https://docs.github.com/v3/teams/#list-team-projects + */ + "GET /orgs/{org}/teams/{team_slug}/projects": Operation<"/orgs/{org}/teams/{team_slug}/projects", "get", "inertia">; + /** + * @see https://docs.github.com/v3/teams/#check-team-permissions-for-a-project + */ + "GET /orgs/{org}/teams/{team_slug}/projects/{project_id}": Operation<"/orgs/{org}/teams/{team_slug}/projects/{project_id}", "get", "inertia">; + /** + * @see https://docs.github.com/v3/teams/#list-team-repositories + */ + "GET /orgs/{org}/teams/{team_slug}/repos": Operation<"/orgs/{org}/teams/{team_slug}/repos", "get">; + /** + * @see https://docs.github.com/v3/teams/#check-team-permissions-for-a-repository + */ + "GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": Operation<"/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team + */ + "GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings": Operation<"/orgs/{org}/teams/{team_slug}/team-sync/group-mappings", "get">; + /** + * @see https://docs.github.com/v3/teams/#list-child-teams + */ + "GET /orgs/{org}/teams/{team_slug}/teams": Operation<"/orgs/{org}/teams/{team_slug}/teams", "get">; + /** + * @see https://docs.github.com/rest/reference/projects#get-a-project-card + */ + "GET /projects/columns/cards/{card_id}": Operation<"/projects/columns/cards/{card_id}", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#get-a-project-column + */ + "GET /projects/columns/{column_id}": Operation<"/projects/columns/{column_id}", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#list-project-cards + */ + "GET /projects/columns/{column_id}/cards": Operation<"/projects/columns/{column_id}/cards", "get", "inertia">; + /** + * @see https://docs.github.com/v3/projects/#get-a-project + */ + "GET /projects/{project_id}": Operation<"/projects/{project_id}", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#list-project-collaborators + */ + "GET /projects/{project_id}/collaborators": Operation<"/projects/{project_id}/collaborators", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#get-project-permission-for-a-user + */ + "GET /projects/{project_id}/collaborators/{username}/permission": Operation<"/projects/{project_id}/collaborators/{username}/permission", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#list-project-columns + */ + "GET /projects/{project_id}/columns": Operation<"/projects/{project_id}/columns", "get", "inertia">; + /** + * @see https://docs.github.com/v3/rate_limit/#get-rate-limit-status-for-the-authenticated-user + */ + "GET /rate_limit": Operation<"/rate_limit", "get">; + /** + * @see https://docs.github.com/v3/repos/#get-a-repository + */ + "GET /repos/{owner}/{repo}": Operation<"/repos/{owner}/{repo}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/artifacts": Operation<"/repos/{owner}/{repo}/actions/artifacts", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-an-artifact + */ + "GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}": Operation<"/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#download-an-artifact + */ + "GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": Operation<"/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-job-for-a-workflow-run + */ + "GET /repos/{owner}/{repo}/actions/jobs/{job_id}": Operation<"/repos/{owner}/{repo}/actions/jobs/{job_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#download-job-logs-for-a-workflow-run + */ + "GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs": Operation<"/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/permissions": Operation<"/repos/{owner}/{repo}/actions/permissions", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-allowed-actions-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/permissions/selected-actions": Operation<"/repos/{owner}/{repo}/actions/permissions/selected-actions", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runners": Operation<"/repos/{owner}/{repo}/actions/runners", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runners/downloads": Operation<"/repos/{owner}/{repo}/actions/runners/downloads", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runners/{runner_id}": Operation<"/repos/{owner}/{repo}/actions/runners/{runner_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-workflow-runs-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runs": Operation<"/repos/{owner}/{repo}/actions/runs", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-workflow-run + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-workflow-run-artifacts + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#download-workflow-run-logs + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/logs", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-workflow-run-usage + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/timing", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-repository-secrets + */ + "GET /repos/{owner}/{repo}/actions/secrets": Operation<"/repos/{owner}/{repo}/actions/secrets", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-repository-public-key + */ + "GET /repos/{owner}/{repo}/actions/secrets/public-key": Operation<"/repos/{owner}/{repo}/actions/secrets/public-key", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-repository-secret + */ + "GET /repos/{owner}/{repo}/actions/secrets/{secret_name}": Operation<"/repos/{owner}/{repo}/actions/secrets/{secret_name}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-repository-workflows + */ + "GET /repos/{owner}/{repo}/actions/workflows": Operation<"/repos/{owner}/{repo}/actions/workflows", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-workflow + */ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-workflow-runs + */ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-workflow-usage + */ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-assignees + */ + "GET /repos/{owner}/{repo}/assignees": Operation<"/repos/{owner}/{repo}/assignees", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#check-if-a-user-can-be-assigned + */ + "GET /repos/{owner}/{repo}/assignees/{assignee}": Operation<"/repos/{owner}/{repo}/assignees/{assignee}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-branches + */ + "GET /repos/{owner}/{repo}/branches": Operation<"/repos/{owner}/{repo}/branches", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-branch + */ + "GET /repos/{owner}/{repo}/branches/{branch}": Operation<"/repos/{owner}/{repo}/branches/{branch}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-branch-protection + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-admin-branch-protection + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-pull-request-review-protection + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-commit-signature-protection + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "get", "zzzax">; + /** + * @see https://docs.github.com/rest/reference/repos#get-status-checks-protection + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-all-status-check-contexts + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-access-restrictions + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-apps-with-access-to-the-protected-branch + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-teams-with-access-to-the-protected-branch + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-users-with-access-to-the-protected-branch + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "get">; + /** + * @see https://docs.github.com/rest/reference/checks#get-a-check-run + */ + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}": Operation<"/repos/{owner}/{repo}/check-runs/{check_run_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-run-annotations + */ + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": Operation<"/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", "get">; + /** + * @see https://docs.github.com/rest/reference/checks#get-a-check-suite + */ + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}": Operation<"/repos/{owner}/{repo}/check-suites/{check_suite_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite + */ + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": Operation<"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", "get">; + /** + * @see https://docs.github.com/v3/code-scanning/#list-code-scanning-alerts-for-a-repository + */ + "GET /repos/{owner}/{repo}/code-scanning/alerts": Operation<"/repos/{owner}/{repo}/code-scanning/alerts", "get">; + /** + * @see https://docs.github.com/v3/code-scanning/#get-a-code-scanning-alert + * @deprecated "alert_id" is now "alert_number" + */ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_id}": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "get">; + /** + * @see https://docs.github.com/v3/code-scanning/#get-a-code-scanning-alert + */ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "get">; + /** + * @see https://docs.github.com/v3/code-scanning/#list-recent-analyses + */ + "GET /repos/{owner}/{repo}/code-scanning/analyses": Operation<"/repos/{owner}/{repo}/code-scanning/analyses", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-collaborators + */ + "GET /repos/{owner}/{repo}/collaborators": Operation<"/repos/{owner}/{repo}/collaborators", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#check-if-a-user-is-a-repository-collaborator + */ + "GET /repos/{owner}/{repo}/collaborators/{username}": Operation<"/repos/{owner}/{repo}/collaborators/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-repository-permissions-for-a-user + */ + "GET /repos/{owner}/{repo}/collaborators/{username}/permission": Operation<"/repos/{owner}/{repo}/collaborators/{username}/permission", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-commit-comments-for-a-repository + */ + "GET /repos/{owner}/{repo}/comments": Operation<"/repos/{owner}/{repo}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-commit-comment + */ + "GET /repos/{owner}/{repo}/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/comments/{comment_id}", "get">; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-a-commit-comment + */ + "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions": Operation<"/repos/{owner}/{repo}/comments/{comment_id}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/repos#list-commits + */ + "GET /repos/{owner}/{repo}/commits": Operation<"/repos/{owner}/{repo}/commits", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-branches-for-head-commit + */ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": Operation<"/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "get", "groot">; + /** + * @see https://docs.github.com/rest/reference/repos#list-commit-comments + */ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments": Operation<"/repos/{owner}/{repo}/commits/{commit_sha}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-pull-requests-associated-with-a-commit + */ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls": Operation<"/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "get", "groot">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-commit + */ + "GET /repos/{owner}/{repo}/commits/{ref}": Operation<"/repos/{owner}/{repo}/commits/{ref}", "get">; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/check-runs": Operation<"/repos/{owner}/{repo}/commits/{ref}/check-runs", "get">; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/check-suites": Operation<"/repos/{owner}/{repo}/commits/{ref}/check-suites", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-the-combined-status-for-a-specific-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/status": Operation<"/repos/{owner}/{repo}/commits/{ref}/status", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-commit-statuses-for-a-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/statuses": Operation<"/repos/{owner}/{repo}/commits/{ref}/statuses", "get">; + /** + * @see https://docs.github.com/v3/codes_of_conduct/#get-the-code-of-conduct-for-a-repository + */ + "GET /repos/{owner}/{repo}/community/code_of_conduct": Operation<"/repos/{owner}/{repo}/community/code_of_conduct", "get", "scarlet-witch">; + /** + * @see https://docs.github.com/rest/reference/repos#get-community-profile-metrics + */ + "GET /repos/{owner}/{repo}/community/profile": Operation<"/repos/{owner}/{repo}/community/profile", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#compare-two-commits + */ + "GET /repos/{owner}/{repo}/compare/{base}...{head}": Operation<"/repos/{owner}/{repo}/compare/{base}...{head}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-repository-content + */ + "GET /repos/{owner}/{repo}/contents/{path}": Operation<"/repos/{owner}/{repo}/contents/{path}", "get">; + /** + * @see https://docs.github.com/v3/repos/#list-repository-contributors + */ + "GET /repos/{owner}/{repo}/contributors": Operation<"/repos/{owner}/{repo}/contributors", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-deployments + */ + "GET /repos/{owner}/{repo}/deployments": Operation<"/repos/{owner}/{repo}/deployments", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-deployment + */ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}": Operation<"/repos/{owner}/{repo}/deployments/{deployment_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-deployment-statuses + */ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses": Operation<"/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-deployment-status + */ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": Operation<"/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-repository-events + */ + "GET /repos/{owner}/{repo}/events": Operation<"/repos/{owner}/{repo}/events", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-forks + */ + "GET /repos/{owner}/{repo}/forks": Operation<"/repos/{owner}/{repo}/forks", "get">; + /** + * @see https://docs.github.com/rest/reference/git#get-a-blob + */ + "GET /repos/{owner}/{repo}/git/blobs/{file_sha}": Operation<"/repos/{owner}/{repo}/git/blobs/{file_sha}", "get">; + /** + * @see https://docs.github.com/rest/reference/git#get-a-commit + */ + "GET /repos/{owner}/{repo}/git/commits/{commit_sha}": Operation<"/repos/{owner}/{repo}/git/commits/{commit_sha}", "get">; + /** + * @see https://docs.github.com/rest/reference/git#list-matching-references + */ + "GET /repos/{owner}/{repo}/git/matching-refs/{ref}": Operation<"/repos/{owner}/{repo}/git/matching-refs/{ref}", "get">; + /** + * @see https://docs.github.com/rest/reference/git#get-a-reference + */ + "GET /repos/{owner}/{repo}/git/ref/{ref}": Operation<"/repos/{owner}/{repo}/git/ref/{ref}", "get">; + /** + * @see https://docs.github.com/rest/reference/git#get-a-tag + */ + "GET /repos/{owner}/{repo}/git/tags/{tag_sha}": Operation<"/repos/{owner}/{repo}/git/tags/{tag_sha}", "get">; + /** + * @see https://docs.github.com/rest/reference/git#get-a-tree + */ + "GET /repos/{owner}/{repo}/git/trees/{tree_sha}": Operation<"/repos/{owner}/{repo}/git/trees/{tree_sha}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-webhooks + */ + "GET /repos/{owner}/{repo}/hooks": Operation<"/repos/{owner}/{repo}/hooks", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-repository-webhook + */ + "GET /repos/{owner}/{repo}/hooks/{hook_id}": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}", "get">; + /** + * @see https://docs.github.com/v3/repos#get-a-webhook-configuration-for-a-repository + */ + "GET /repos/{owner}/{repo}/hooks/{hook_id}/config": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}/config", "get">; + /** + * @see https://docs.github.com/rest/reference/migrations#get-an-import-status + */ + "GET /repos/{owner}/{repo}/import": Operation<"/repos/{owner}/{repo}/import", "get">; + /** + * @see https://docs.github.com/rest/reference/migrations#get-commit-authors + */ + "GET /repos/{owner}/{repo}/import/authors": Operation<"/repos/{owner}/{repo}/import/authors", "get">; + /** + * @see https://docs.github.com/rest/reference/migrations#get-large-files + */ + "GET /repos/{owner}/{repo}/import/large_files": Operation<"/repos/{owner}/{repo}/import/large_files", "get">; + /** + * @see https://docs.github.com/v3/apps/#get-a-repository-installation-for-the-authenticated-app + */ + "GET /repos/{owner}/{repo}/installation": Operation<"/repos/{owner}/{repo}/installation", "get">; + /** + * @see https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-a-repository + */ + "GET /repos/{owner}/{repo}/interaction-limits": Operation<"/repos/{owner}/{repo}/interaction-limits", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-invitations + */ + "GET /repos/{owner}/{repo}/invitations": Operation<"/repos/{owner}/{repo}/invitations", "get">; + /** + * @see https://docs.github.com/v3/issues/#list-repository-issues + */ + "GET /repos/{owner}/{repo}/issues": Operation<"/repos/{owner}/{repo}/issues", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-comments-for-a-repository + */ + "GET /repos/{owner}/{repo}/issues/comments": Operation<"/repos/{owner}/{repo}/issues/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#get-an-issue-comment + */ + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/issues/comments/{comment_id}", "get">; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-an-issue-comment + */ + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": Operation<"/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-events-for-a-repository + */ + "GET /repos/{owner}/{repo}/issues/events": Operation<"/repos/{owner}/{repo}/issues/events", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#get-an-issue-event + */ + "GET /repos/{owner}/{repo}/issues/events/{event_id}": Operation<"/repos/{owner}/{repo}/issues/events/{event_id}", "get">; + /** + * @see https://docs.github.com/v3/issues/#get-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}": Operation<"/repos/{owner}/{repo}/issues/{issue_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-comments + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/comments": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-events + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/events": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/events", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-labels-for-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/labels": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/labels", "get">; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/issues#list-timeline-events-for-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/timeline", "get", "mockingbird">; + /** + * @see https://docs.github.com/rest/reference/repos#list-deploy-keys + */ + "GET /repos/{owner}/{repo}/keys": Operation<"/repos/{owner}/{repo}/keys", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-deploy-key + */ + "GET /repos/{owner}/{repo}/keys/{key_id}": Operation<"/repos/{owner}/{repo}/keys/{key_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-labels-for-a-repository + */ + "GET /repos/{owner}/{repo}/labels": Operation<"/repos/{owner}/{repo}/labels", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#get-a-label + */ + "GET /repos/{owner}/{repo}/labels/{name}": Operation<"/repos/{owner}/{repo}/labels/{name}", "get">; + /** + * @see https://docs.github.com/v3/repos/#list-repository-languages + */ + "GET /repos/{owner}/{repo}/languages": Operation<"/repos/{owner}/{repo}/languages", "get">; + /** + * @see https://docs.github.com/v3/licenses/#get-the-license-for-a-repository + */ + "GET /repos/{owner}/{repo}/license": Operation<"/repos/{owner}/{repo}/license", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-milestones + */ + "GET /repos/{owner}/{repo}/milestones": Operation<"/repos/{owner}/{repo}/milestones", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#get-a-milestone + */ + "GET /repos/{owner}/{repo}/milestones/{milestone_number}": Operation<"/repos/{owner}/{repo}/milestones/{milestone_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-labels-for-issues-in-a-milestone + */ + "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels": Operation<"/repos/{owner}/{repo}/milestones/{milestone_number}/labels", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user + */ + "GET /repos/{owner}/{repo}/notifications": Operation<"/repos/{owner}/{repo}/notifications", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-github-pages-site + */ + "GET /repos/{owner}/{repo}/pages": Operation<"/repos/{owner}/{repo}/pages", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-github-pages-builds + */ + "GET /repos/{owner}/{repo}/pages/builds": Operation<"/repos/{owner}/{repo}/pages/builds", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-latest-pages-build + */ + "GET /repos/{owner}/{repo}/pages/builds/latest": Operation<"/repos/{owner}/{repo}/pages/builds/latest", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-github-pages-build + */ + "GET /repos/{owner}/{repo}/pages/builds/{build_id}": Operation<"/repos/{owner}/{repo}/pages/builds/{build_id}", "get">; + /** + * @see https://docs.github.com/v3/projects/#list-repository-projects + */ + "GET /repos/{owner}/{repo}/projects": Operation<"/repos/{owner}/{repo}/projects", "get", "inertia">; + /** + * @see https://docs.github.com/v3/pulls/#list-pull-requests + */ + "GET /repos/{owner}/{repo}/pulls": Operation<"/repos/{owner}/{repo}/pulls", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-review-comments-in-a-repository + */ + "GET /repos/{owner}/{repo}/pulls/comments": Operation<"/repos/{owner}/{repo}/pulls/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#get-a-review-comment-for-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/pulls/comments/{comment_id}", "get">; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment + */ + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": Operation<"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/v3/pulls/#get-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-review-comments-on-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/comments", "get">; + /** + * @see https://docs.github.com/v3/pulls/#list-commits-on-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/commits": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/commits", "get">; + /** + * @see https://docs.github.com/v3/pulls/#list-pull-requests-files + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/files": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/files", "get">; + /** + * @see https://docs.github.com/v3/pulls/#check-if-a-pull-request-has-been-merged + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/merge": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/merge", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-reviews-for-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#get-a-review-for-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-comments-for-a-pull-request-review + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-repository-readme + */ + "GET /repos/{owner}/{repo}/readme": Operation<"/repos/{owner}/{repo}/readme", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-releases + */ + "GET /repos/{owner}/{repo}/releases": Operation<"/repos/{owner}/{repo}/releases", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-release-asset + */ + "GET /repos/{owner}/{repo}/releases/assets/{asset_id}": Operation<"/repos/{owner}/{repo}/releases/assets/{asset_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-the-latest-release + */ + "GET /repos/{owner}/{repo}/releases/latest": Operation<"/repos/{owner}/{repo}/releases/latest", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-release-by-tag-name + */ + "GET /repos/{owner}/{repo}/releases/tags/{tag}": Operation<"/repos/{owner}/{repo}/releases/tags/{tag}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-release + */ + "GET /repos/{owner}/{repo}/releases/{release_id}": Operation<"/repos/{owner}/{repo}/releases/{release_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-release-assets + */ + "GET /repos/{owner}/{repo}/releases/{release_id}/assets": Operation<"/repos/{owner}/{repo}/releases/{release_id}/assets", "get">; + /** + * @see https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository + */ + "GET /repos/{owner}/{repo}/secret-scanning/alerts": Operation<"/repos/{owner}/{repo}/secret-scanning/alerts", "get">; + /** + * @see https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert + */ + "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": Operation<"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-stargazers + */ + "GET /repos/{owner}/{repo}/stargazers": Operation<"/repos/{owner}/{repo}/stargazers", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-the-weekly-commit-activity + */ + "GET /repos/{owner}/{repo}/stats/code_frequency": Operation<"/repos/{owner}/{repo}/stats/code_frequency", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-the-last-year-of-commit-activity + */ + "GET /repos/{owner}/{repo}/stats/commit_activity": Operation<"/repos/{owner}/{repo}/stats/commit_activity", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-all-contributor-commit-activity + */ + "GET /repos/{owner}/{repo}/stats/contributors": Operation<"/repos/{owner}/{repo}/stats/contributors", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-the-weekly-commit-count + */ + "GET /repos/{owner}/{repo}/stats/participation": Operation<"/repos/{owner}/{repo}/stats/participation", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-the-hourly-commit-count-for-each-day + */ + "GET /repos/{owner}/{repo}/stats/punch_card": Operation<"/repos/{owner}/{repo}/stats/punch_card", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-watchers + */ + "GET /repos/{owner}/{repo}/subscribers": Operation<"/repos/{owner}/{repo}/subscribers", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#get-a-repository-subscription + */ + "GET /repos/{owner}/{repo}/subscription": Operation<"/repos/{owner}/{repo}/subscription", "get">; + /** + * @see https://docs.github.com/v3/repos/#list-repository-tags + */ + "GET /repos/{owner}/{repo}/tags": Operation<"/repos/{owner}/{repo}/tags", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#download-a-repository-archive + */ + "GET /repos/{owner}/{repo}/tarball/{ref}": Operation<"/repos/{owner}/{repo}/tarball/{ref}", "get">; + /** + * @see https://docs.github.com/v3/repos/#list-repository-teams + */ + "GET /repos/{owner}/{repo}/teams": Operation<"/repos/{owner}/{repo}/teams", "get">; + /** + * @see https://docs.github.com/v3/repos/#get-all-repository-topics + */ + "GET /repos/{owner}/{repo}/topics": Operation<"/repos/{owner}/{repo}/topics", "get", "mercy">; + /** + * @see https://docs.github.com/rest/reference/repos#get-repository-clones + */ + "GET /repos/{owner}/{repo}/traffic/clones": Operation<"/repos/{owner}/{repo}/traffic/clones", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-top-referral-paths + */ + "GET /repos/{owner}/{repo}/traffic/popular/paths": Operation<"/repos/{owner}/{repo}/traffic/popular/paths", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-top-referral-sources + */ + "GET /repos/{owner}/{repo}/traffic/popular/referrers": Operation<"/repos/{owner}/{repo}/traffic/popular/referrers", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-page-views + */ + "GET /repos/{owner}/{repo}/traffic/views": Operation<"/repos/{owner}/{repo}/traffic/views", "get">; + /** + * @see https://docs.github.com/v3/repos/#check-if-vulnerability-alerts-are-enabled-for-a-repository + */ + "GET /repos/{owner}/{repo}/vulnerability-alerts": Operation<"/repos/{owner}/{repo}/vulnerability-alerts", "get", "dorian">; + /** + * @see https://docs.github.com/rest/reference/repos#download-a-repository-archive + */ + "GET /repos/{owner}/{repo}/zipball/{ref}": Operation<"/repos/{owner}/{repo}/zipball/{ref}", "get">; + /** + * @see https://docs.github.com/v3/repos/#list-public-repositories + */ + "GET /repositories": Operation<"/repositories", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise + */ + "GET /scim/v2/enterprises/{enterprise}/Groups": Operation<"/scim/v2/enterprises/{enterprise}/Groups", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group + */ + "GET /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": Operation<"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-scim-provisioned-identities-for-an-enterprise + */ + "GET /scim/v2/enterprises/{enterprise}/Users": Operation<"/scim/v2/enterprises/{enterprise}/Users", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-user + */ + "GET /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": Operation<"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "get">; + /** + * @see https://docs.github.com/v3/scim/#list-scim-provisioned-identities + */ + "GET /scim/v2/organizations/{org}/Users": Operation<"/scim/v2/organizations/{org}/Users", "get">; + /** + * @see https://docs.github.com/v3/scim/#get-scim-provisioning-information-for-a-user + */ + "GET /scim/v2/organizations/{org}/Users/{scim_user_id}": Operation<"/scim/v2/organizations/{org}/Users/{scim_user_id}", "get">; + /** + * @see https://docs.github.com/v3/search/#search-code + */ + "GET /search/code": Operation<"/search/code", "get">; + /** + * @see https://docs.github.com/v3/search/#search-commits + */ + "GET /search/commits": Operation<"/search/commits", "get", "cloak">; + /** + * @see https://docs.github.com/v3/search/#search-issues-and-pull-requests + */ + "GET /search/issues": Operation<"/search/issues", "get">; + /** + * @see https://docs.github.com/v3/search/#search-labels + */ + "GET /search/labels": Operation<"/search/labels", "get">; + /** + * @see https://docs.github.com/v3/search/#search-repositories + */ + "GET /search/repositories": Operation<"/search/repositories", "get">; + /** + * @see https://docs.github.com/v3/search/#search-topics + */ + "GET /search/topics": Operation<"/search/topics", "get", "mercy">; + /** + * @see https://docs.github.com/v3/search/#search-users + */ + "GET /search/users": Operation<"/search/users", "get">; + /** + * @see https://docs.github.com/v3/teams/#get-a-team-legacy + */ + "GET /teams/{team_id}": Operation<"/teams/{team_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussions-legacy + */ + "GET /teams/{team_id}/discussions": Operation<"/teams/{team_id}/discussions", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-a-discussion-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}": Operation<"/teams/{team_id}/discussions/{discussion_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussion-comments-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/comments": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-a-discussion-comment-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "get">; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/reactions": Operation<"/teams/{team_id}/discussions/{discussion_number}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/teams#list-pending-team-invitations-legacy + */ + "GET /teams/{team_id}/invitations": Operation<"/teams/{team_id}/invitations", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-team-members-legacy + */ + "GET /teams/{team_id}/members": Operation<"/teams/{team_id}/members", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-team-member-legacy + */ + "GET /teams/{team_id}/members/{username}": Operation<"/teams/{team_id}/members/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user-legacy + */ + "GET /teams/{team_id}/memberships/{username}": Operation<"/teams/{team_id}/memberships/{username}", "get">; + /** + * @see https://docs.github.com/v3/teams/#list-team-projects-legacy + */ + "GET /teams/{team_id}/projects": Operation<"/teams/{team_id}/projects", "get", "inertia">; + /** + * @see https://docs.github.com/v3/teams/#check-team-permissions-for-a-project-legacy + */ + "GET /teams/{team_id}/projects/{project_id}": Operation<"/teams/{team_id}/projects/{project_id}", "get", "inertia">; + /** + * @see https://docs.github.com/v3/teams/#list-team-repositories-legacy + */ + "GET /teams/{team_id}/repos": Operation<"/teams/{team_id}/repos", "get">; + /** + * @see https://docs.github.com/v3/teams/#check-team-permissions-for-a-repository-legacy + */ + "GET /teams/{team_id}/repos/{owner}/{repo}": Operation<"/teams/{team_id}/repos/{owner}/{repo}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team-legacy + */ + "GET /teams/{team_id}/team-sync/group-mappings": Operation<"/teams/{team_id}/team-sync/group-mappings", "get">; + /** + * @see https://docs.github.com/v3/teams/#list-child-teams-legacy + */ + "GET /teams/{team_id}/teams": Operation<"/teams/{team_id}/teams", "get">; + /** + * @see https://docs.github.com/v3/users/#get-the-authenticated-user + */ + "GET /user": Operation<"/user", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user + */ + "GET /user/blocks": Operation<"/user/blocks", "get">; + /** + * @see https://docs.github.com/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user + */ + "GET /user/blocks/{username}": Operation<"/user/blocks/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user + */ + "GET /user/emails": Operation<"/user/emails", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-followers-of-the-authenticated-user + */ + "GET /user/followers": Operation<"/user/followers", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows + */ + "GET /user/following": Operation<"/user/following", "get">; + /** + * @see https://docs.github.com/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user + */ + "GET /user/following/{username}": Operation<"/user/following/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user + */ + "GET /user/gpg_keys": Operation<"/user/gpg_keys", "get">; + /** + * @see https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user + */ + "GET /user/gpg_keys/{gpg_key_id}": Operation<"/user/gpg_keys/{gpg_key_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token + */ + "GET /user/installations": Operation<"/user/installations", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-user-access-token + */ + "GET /user/installations/{installation_id}/repositories": Operation<"/user/installations/{installation_id}/repositories", "get">; + /** + * @see https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories + */ + "GET /user/interaction-limits": Operation<"/user/interaction-limits", "get">; + /** + * @see https://docs.github.com/v3/issues/#list-user-account-issues-assigned-to-the-authenticated-user + */ + "GET /user/issues": Operation<"/user/issues", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user + */ + "GET /user/keys": Operation<"/user/keys", "get">; + /** + * @see https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user + */ + "GET /user/keys/{key_id}": Operation<"/user/keys/{key_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user + */ + "GET /user/marketplace_purchases": Operation<"/user/marketplace_purchases", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user-stubbed + */ + "GET /user/marketplace_purchases/stubbed": Operation<"/user/marketplace_purchases/stubbed", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user + */ + "GET /user/memberships/orgs": Operation<"/user/memberships/orgs", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user + */ + "GET /user/memberships/orgs/{org}": Operation<"/user/memberships/orgs/{org}", "get">; + /** + * @see https://docs.github.com/rest/reference/migrations#list-user-migrations + */ + "GET /user/migrations": Operation<"/user/migrations", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#get-a-user-migration-status + */ + "GET /user/migrations/{migration_id}": Operation<"/user/migrations/{migration_id}", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive + */ + "GET /user/migrations/{migration_id}/archive": Operation<"/user/migrations/{migration_id}/archive", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration + */ + "GET /user/migrations/{migration_id}/repositories": Operation<"/user/migrations/{migration_id}/repositories", "get", "wyandotte">; + /** + * @see https://docs.github.com/v3/orgs/#list-organizations-for-the-authenticated-user + */ + "GET /user/orgs": Operation<"/user/orgs", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user + */ + "GET /user/public_emails": Operation<"/user/public_emails", "get">; + /** + * @see https://docs.github.com/v3/repos/#list-repositories-for-the-authenticated-user + */ + "GET /user/repos": Operation<"/user/repos", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-invitations-for-the-authenticated-user + */ + "GET /user/repository_invitations": Operation<"/user/repository_invitations", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user + */ + "GET /user/starred": Operation<"/user/starred", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user + */ + "GET /user/starred/{owner}/{repo}": Operation<"/user/starred/{owner}/{repo}", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-watched-by-the-authenticated-user + */ + "GET /user/subscriptions": Operation<"/user/subscriptions", "get">; + /** + * @see https://docs.github.com/v3/teams/#list-teams-for-the-authenticated-user + */ + "GET /user/teams": Operation<"/user/teams", "get">; + /** + * @see https://docs.github.com/v3/users/#list-users + */ + "GET /users": Operation<"/users", "get">; + /** + * @see https://docs.github.com/v3/users/#get-a-user + */ + "GET /users/{username}": Operation<"/users/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-events-for-the-authenticated-user + */ + "GET /users/{username}/events": Operation<"/users/{username}/events", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-organization-events-for-the-authenticated-user + */ + "GET /users/{username}/events/orgs/{org}": Operation<"/users/{username}/events/orgs/{org}", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events-for-a-user + */ + "GET /users/{username}/events/public": Operation<"/users/{username}/events/public", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-followers-of-a-user + */ + "GET /users/{username}/followers": Operation<"/users/{username}/followers", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-the-people-a-user-follows + */ + "GET /users/{username}/following": Operation<"/users/{username}/following", "get">; + /** + * @see https://docs.github.com/rest/reference/users#check-if-a-user-follows-another-user + */ + "GET /users/{username}/following/{target_user}": Operation<"/users/{username}/following/{target_user}", "get">; + /** + * @see https://docs.github.com/v3/gists/#list-gists-for-a-user + */ + "GET /users/{username}/gists": Operation<"/users/{username}/gists", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-gpg-keys-for-a-user + */ + "GET /users/{username}/gpg_keys": Operation<"/users/{username}/gpg_keys", "get">; + /** + * @see https://docs.github.com/v3/users/#get-contextual-information-for-a-user + */ + "GET /users/{username}/hovercard": Operation<"/users/{username}/hovercard", "get">; + /** + * @see https://docs.github.com/v3/apps/#get-a-user-installation-for-the-authenticated-app + */ + "GET /users/{username}/installation": Operation<"/users/{username}/installation", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-public-keys-for-a-user + */ + "GET /users/{username}/keys": Operation<"/users/{username}/keys", "get">; + /** + * @see https://docs.github.com/v3/orgs/#list-organizations-for-a-user + */ + "GET /users/{username}/orgs": Operation<"/users/{username}/orgs", "get">; + /** + * @see https://docs.github.com/v3/projects/#list-user-projects + */ + "GET /users/{username}/projects": Operation<"/users/{username}/projects", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/activity#list-events-received-by-the-authenticated-user + */ + "GET /users/{username}/received_events": Operation<"/users/{username}/received_events", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user + */ + "GET /users/{username}/received_events/public": Operation<"/users/{username}/received_events/public", "get">; + /** + * @see https://docs.github.com/v3/repos/#list-repositories-for-a-user + */ + "GET /users/{username}/repos": Operation<"/users/{username}/repos", "get">; + /** + * @see https://docs.github.com/v3/billing/#get-github-actions-billing-for-a-user + */ + "GET /users/{username}/settings/billing/actions": Operation<"/users/{username}/settings/billing/actions", "get">; + /** + * @see https://docs.github.com/v3/billing/#get-github-packages-billing-for-a-user + */ + "GET /users/{username}/settings/billing/packages": Operation<"/users/{username}/settings/billing/packages", "get">; + /** + * @see https://docs.github.com/v3/billing/#get-shared-storage-billing-for-a-user + */ + "GET /users/{username}/settings/billing/shared-storage": Operation<"/users/{username}/settings/billing/shared-storage", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user + */ + "GET /users/{username}/starred": Operation<"/users/{username}/starred", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-watched-by-a-user + */ + "GET /users/{username}/subscriptions": Operation<"/users/{username}/subscriptions", "get">; + /** + * @see + */ + "GET /zen": Operation<"/zen", "get">; + /** + * @see https://docs.github.com/v3/apps#update-a-webhook-configuration-for-an-app + */ + "PATCH /app/hook/config": Operation<"/app/hook/config", "patch">; + /** + * @see https://docs.github.com/rest/reference/apps#reset-a-token + */ + "PATCH /applications/{client_id}/token": Operation<"/applications/{client_id}/token", "patch">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#update-an-existing-authorization + */ + "PATCH /authorizations/{authorization_id}": Operation<"/authorizations/{authorization_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise + */ + "PATCH /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", "patch">; + /** + * @see https://docs.github.com/v3/gists/#update-a-gist + */ + "PATCH /gists/{gist_id}": Operation<"/gists/{gist_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/gists#update-a-gist-comment + */ + "PATCH /gists/{gist_id}/comments/{comment_id}": Operation<"/gists/{gist_id}/comments/{comment_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/activity#mark-a-thread-as-read + */ + "PATCH /notifications/threads/{thread_id}": Operation<"/notifications/threads/{thread_id}", "patch">; + /** + * @see https://docs.github.com/v3/orgs/#update-an-organization + */ + "PATCH /orgs/{org}": Operation<"/orgs/{org}", "patch">; + /** + * @see https://docs.github.com/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization + */ + "PATCH /orgs/{org}/actions/runner-groups/{runner_group_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/orgs#update-an-organization-webhook + */ + "PATCH /orgs/{org}/hooks/{hook_id}": Operation<"/orgs/{org}/hooks/{hook_id}", "patch">; + /** + * @see https://docs.github.com/v3/orgs#update-a-webhook-configuration-for-an-organization + */ + "PATCH /orgs/{org}/hooks/{hook_id}/config": Operation<"/orgs/{org}/hooks/{hook_id}/config", "patch">; + /** + * @see https://docs.github.com/v3/teams/#update-a-team + */ + "PATCH /orgs/{org}/teams/{team_slug}": Operation<"/orgs/{org}/teams/{team_slug}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#update-a-discussion + */ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#update-a-discussion-comment + */ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections + */ + "PATCH /orgs/{org}/teams/{team_slug}/team-sync/group-mappings": Operation<"/orgs/{org}/teams/{team_slug}/team-sync/group-mappings", "patch">; + /** + * @see https://docs.github.com/rest/reference/projects#update-a-project-card + */ + "PATCH /projects/columns/cards/{card_id}": Operation<"/projects/columns/cards/{card_id}", "patch", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#update-a-project-column + */ + "PATCH /projects/columns/{column_id}": Operation<"/projects/columns/{column_id}", "patch", "inertia">; + /** + * @see https://docs.github.com/v3/projects/#update-a-project + */ + "PATCH /projects/{project_id}": Operation<"/projects/{project_id}", "patch", "inertia">; + /** + * @see https://docs.github.com/v3/repos/#update-a-repository + */ + "PATCH /repos/{owner}/{repo}": Operation<"/repos/{owner}/{repo}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-pull-request-review-protection + */ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-status-check-potection + */ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "patch">; + /** + * @see https://docs.github.com/rest/reference/checks#update-a-check-run + */ + "PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}": Operation<"/repos/{owner}/{repo}/check-runs/{check_run_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites + */ + "PATCH /repos/{owner}/{repo}/check-suites/preferences": Operation<"/repos/{owner}/{repo}/check-suites/preferences", "patch">; + /** + * @see https://docs.github.com/v3/code-scanning/#upload-a-code-scanning-alert + */ + "PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-a-commit-comment + */ + "PATCH /repos/{owner}/{repo}/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/comments/{comment_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/git#update-a-reference + */ + "PATCH /repos/{owner}/{repo}/git/refs/{ref}": Operation<"/repos/{owner}/{repo}/git/refs/{ref}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-a-repository-webhook + */ + "PATCH /repos/{owner}/{repo}/hooks/{hook_id}": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}", "patch">; + /** + * @see https://docs.github.com/v3/repos#update-a-webhook-configuration-for-a-repository + */ + "PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}/config", "patch">; + /** + * @see https://docs.github.com/rest/reference/migrations#update-an-import + */ + "PATCH /repos/{owner}/{repo}/import": Operation<"/repos/{owner}/{repo}/import", "patch">; + /** + * @see https://docs.github.com/rest/reference/migrations#map-a-commit-author + */ + "PATCH /repos/{owner}/{repo}/import/authors/{author_id}": Operation<"/repos/{owner}/{repo}/import/authors/{author_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/migrations#update-git-lfs-preference + */ + "PATCH /repos/{owner}/{repo}/import/lfs": Operation<"/repos/{owner}/{repo}/import/lfs", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-a-repository-invitation + */ + "PATCH /repos/{owner}/{repo}/invitations/{invitation_id}": Operation<"/repos/{owner}/{repo}/invitations/{invitation_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/issues#update-an-issue-comment + */ + "PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/issues/comments/{comment_id}", "patch">; + /** + * @see https://docs.github.com/v3/issues/#update-an-issue + */ + "PATCH /repos/{owner}/{repo}/issues/{issue_number}": Operation<"/repos/{owner}/{repo}/issues/{issue_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/issues#update-a-label + */ + "PATCH /repos/{owner}/{repo}/labels/{name}": Operation<"/repos/{owner}/{repo}/labels/{name}", "patch">; + /** + * @see https://docs.github.com/rest/reference/issues#update-a-milestone + */ + "PATCH /repos/{owner}/{repo}/milestones/{milestone_number}": Operation<"/repos/{owner}/{repo}/milestones/{milestone_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/pulls#update-a-review-comment-for-a-pull-request + */ + "PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/pulls/comments/{comment_id}", "patch">; + /** + * @see https://docs.github.com/v3/pulls/#update-a-pull-request + */ + "PATCH /repos/{owner}/{repo}/pulls/{pull_number}": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-a-release-asset + */ + "PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}": Operation<"/repos/{owner}/{repo}/releases/assets/{asset_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-a-release + */ + "PATCH /repos/{owner}/{repo}/releases/{release_id}": Operation<"/repos/{owner}/{repo}/releases/{release_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert + */ + "PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": Operation<"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group + */ + "PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": Operation<"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-user + */ + "PATCH /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": Operation<"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "patch">; + /** + * @see https://docs.github.com/v3/scim/#update-an-attribute-for-a-scim-user + */ + "PATCH /scim/v2/organizations/{org}/Users/{scim_user_id}": Operation<"/scim/v2/organizations/{org}/Users/{scim_user_id}", "patch">; + /** + * @see https://docs.github.com/v3/teams/#update-a-team-legacy + */ + "PATCH /teams/{team_id}": Operation<"/teams/{team_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#update-a-discussion-legacy + */ + "PATCH /teams/{team_id}/discussions/{discussion_number}": Operation<"/teams/{team_id}/discussions/{discussion_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#update-a-discussion-comment-legacy + */ + "PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections-legacy + */ + "PATCH /teams/{team_id}/team-sync/group-mappings": Operation<"/teams/{team_id}/team-sync/group-mappings", "patch">; + /** + * @see https://docs.github.com/v3/users/#update-the-authenticated-user + */ + "PATCH /user": Operation<"/user", "patch">; + /** + * @see https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user + */ + "PATCH /user/email/visibility": Operation<"/user/email/visibility", "patch">; + /** + * @see https://docs.github.com/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user + */ + "PATCH /user/memberships/orgs/{org}": Operation<"/user/memberships/orgs/{org}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#accept-a-repository-invitation + */ + "PATCH /user/repository_invitations/{invitation_id}": Operation<"/user/repository_invitations/{invitation_id}", "patch">; + /** + * @see https://docs.github.com/v3/apps/#create-a-github-app-from-a-manifest + */ + "POST /app-manifests/{code}/conversions": Operation<"/app-manifests/{code}/conversions", "post">; + /** + * @see https://docs.github.com/v3/apps/#create-an-installation-access-token-for-an-app + */ + "POST /app/installations/{installation_id}/access_tokens": Operation<"/app/installations/{installation_id}/access_tokens", "post">; + /** + * @see https://docs.github.com/rest/reference/apps#check-a-token + */ + "POST /applications/{client_id}/token": Operation<"/applications/{client_id}/token", "post">; + /** + * @see https://docs.github.com/rest/reference/apps#create-a-scoped-access-token + */ + "POST /applications/{client_id}/token/scoped": Operation<"/applications/{client_id}/token/scoped", "post">; + /** + * @see https://docs.github.com/rest/reference/apps#reset-an-authorization + */ + "POST /applications/{client_id}/tokens/{access_token}": Operation<"/applications/{client_id}/tokens/{access_token}", "post">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization + */ + "POST /authorizations": Operation<"/authorizations", "post">; + /** + * @see https://docs.github.com/rest/reference/apps#create-a-content-attachment + */ + "POST /content_references/{content_reference_id}/attachments": Operation<"/content_references/{content_reference_id}/attachments", "post", "corsair">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise + */ + "POST /enterprises/{enterprise}/actions/runner-groups": Operation<"/enterprises/{enterprise}/actions/runner-groups", "post">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#create-a-registration-token-for-an-enterprise + */ + "POST /enterprises/{enterprise}/actions/runners/registration-token": Operation<"/enterprises/{enterprise}/actions/runners/registration-token", "post">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#create-a-remove-token-for-an-enterprise + */ + "POST /enterprises/{enterprise}/actions/runners/remove-token": Operation<"/enterprises/{enterprise}/actions/runners/remove-token", "post">; + /** + * @see https://docs.github.com/v3/gists/#create-a-gist + */ + "POST /gists": Operation<"/gists", "post">; + /** + * @see https://docs.github.com/rest/reference/gists#create-a-gist-comment + */ + "POST /gists/{gist_id}/comments": Operation<"/gists/{gist_id}/comments", "post">; + /** + * @see https://docs.github.com/v3/gists/#fork-a-gist + */ + "POST /gists/{gist_id}/forks": Operation<"/gists/{gist_id}/forks", "post">; + /** + * @see https://docs.github.com/v3/markdown/#render-a-markdown-document + */ + "POST /markdown": Operation<"/markdown", "post">; + /** + * @see https://docs.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode + */ + "POST /markdown/raw": Operation<"/markdown/raw", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#create-a-self-hosted-runner-group-for-an-organization + */ + "POST /orgs/{org}/actions/runner-groups": Operation<"/orgs/{org}/actions/runner-groups", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#create-a-registration-token-for-an-organization + */ + "POST /orgs/{org}/actions/runners/registration-token": Operation<"/orgs/{org}/actions/runners/registration-token", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#create-a-remove-token-for-an-organization + */ + "POST /orgs/{org}/actions/runners/remove-token": Operation<"/orgs/{org}/actions/runners/remove-token", "post">; + /** + * @see https://docs.github.com/rest/reference/orgs#create-an-organization-webhook + */ + "POST /orgs/{org}/hooks": Operation<"/orgs/{org}/hooks", "post">; + /** + * @see https://docs.github.com/rest/reference/orgs#ping-an-organization-webhook + */ + "POST /orgs/{org}/hooks/{hook_id}/pings": Operation<"/orgs/{org}/hooks/{hook_id}/pings", "post">; + /** + * @see https://docs.github.com/rest/reference/orgs#create-an-organization-invitation + */ + "POST /orgs/{org}/invitations": Operation<"/orgs/{org}/invitations", "post">; + /** + * @see https://docs.github.com/rest/reference/migrations#start-an-organization-migration + */ + "POST /orgs/{org}/migrations": Operation<"/orgs/{org}/migrations", "post">; + /** + * @see https://docs.github.com/v3/projects/#create-an-organization-project + */ + "POST /orgs/{org}/projects": Operation<"/orgs/{org}/projects", "post", "inertia">; + /** + * @see https://docs.github.com/v3/repos/#create-an-organization-repository + */ + "POST /orgs/{org}/repos": Operation<"/orgs/{org}/repos", "post">; + /** + * @see https://docs.github.com/v3/teams/#create-a-team + */ + "POST /orgs/{org}/teams": Operation<"/orgs/{org}/teams", "post">; + /** + * @see https://docs.github.com/rest/reference/teams#create-a-discussion + */ + "POST /orgs/{org}/teams/{team_slug}/discussions": Operation<"/orgs/{org}/teams/{team_slug}/discussions", "post">; + /** + * @see https://docs.github.com/rest/reference/teams#create-a-discussion-comment + */ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "post">; + /** + * @see https://docs.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment + */ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/v3/reactions/#create-reaction-for-a-team-discussion + */ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/projects#move-a-project-card + */ + "POST /projects/columns/cards/{card_id}/moves": Operation<"/projects/columns/cards/{card_id}/moves", "post", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#create-a-project-card + */ + "POST /projects/columns/{column_id}/cards": Operation<"/projects/columns/{column_id}/cards", "post", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#move-a-project-column + */ + "POST /projects/columns/{column_id}/moves": Operation<"/projects/columns/{column_id}/moves", "post", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#create-a-project-column + */ + "POST /projects/{project_id}/columns": Operation<"/projects/{project_id}/columns", "post", "inertia">; + /** + * @see https://docs.github.com/rest/reference/actions#create-a-registration-token-for-a-repository + */ + "POST /repos/{owner}/{repo}/actions/runners/registration-token": Operation<"/repos/{owner}/{repo}/actions/runners/registration-token", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#create-a-remove-token-for-a-repository + */ + "POST /repos/{owner}/{repo}/actions/runners/remove-token": Operation<"/repos/{owner}/{repo}/actions/runners/remove-token", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#cancel-a-workflow-run + */ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#re-run-a-workflow + */ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#create-a-workflow-dispatch-event + */ + "POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#set-admin-branch-protection + */ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-commit-signature-protection + */ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "post", "zzzax">; + /** + * @see https://docs.github.com/rest/reference/repos#add-status-check-contexts + */ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#add-app-access-restrictions + */ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#add-team-access-restrictions + */ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#add-user-access-restrictions + */ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "post">; + /** + * @see https://docs.github.com/rest/reference/checks#create-a-check-run + */ + "POST /repos/{owner}/{repo}/check-runs": Operation<"/repos/{owner}/{repo}/check-runs", "post">; + /** + * @see https://docs.github.com/rest/reference/checks#create-a-check-suite + */ + "POST /repos/{owner}/{repo}/check-suites": Operation<"/repos/{owner}/{repo}/check-suites", "post">; + /** + * @see https://docs.github.com/rest/reference/checks#rerequest-a-check-suite + */ + "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": Operation<"/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", "post">; + /** + * @see https://docs.github.com/v3/code-scanning/#upload-a-sarif-analysis + */ + "POST /repos/{owner}/{repo}/code-scanning/sarifs": Operation<"/repos/{owner}/{repo}/code-scanning/sarifs", "post">; + /** + * @see https://docs.github.com/v3/reactions/#create-reaction-for-a-commit-comment + */ + "POST /repos/{owner}/{repo}/comments/{comment_id}/reactions": Operation<"/repos/{owner}/{repo}/comments/{comment_id}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-commit-comment + */ + "POST /repos/{owner}/{repo}/commits/{commit_sha}/comments": Operation<"/repos/{owner}/{repo}/commits/{commit_sha}/comments", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-deployment + */ + "POST /repos/{owner}/{repo}/deployments": Operation<"/repos/{owner}/{repo}/deployments", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-deployment-status + */ + "POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses": Operation<"/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "post">; + /** + * @see https://docs.github.com/v3/repos/#create-a-repository-dispatch-event + */ + "POST /repos/{owner}/{repo}/dispatches": Operation<"/repos/{owner}/{repo}/dispatches", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-fork + */ + "POST /repos/{owner}/{repo}/forks": Operation<"/repos/{owner}/{repo}/forks", "post">; + /** + * @see https://docs.github.com/rest/reference/git#create-a-blob + */ + "POST /repos/{owner}/{repo}/git/blobs": Operation<"/repos/{owner}/{repo}/git/blobs", "post">; + /** + * @see https://docs.github.com/rest/reference/git#create-a-commit + */ + "POST /repos/{owner}/{repo}/git/commits": Operation<"/repos/{owner}/{repo}/git/commits", "post">; + /** + * @see https://docs.github.com/rest/reference/git#create-a-reference + */ + "POST /repos/{owner}/{repo}/git/refs": Operation<"/repos/{owner}/{repo}/git/refs", "post">; + /** + * @see https://docs.github.com/rest/reference/git#create-a-tag-object + */ + "POST /repos/{owner}/{repo}/git/tags": Operation<"/repos/{owner}/{repo}/git/tags", "post">; + /** + * @see https://docs.github.com/rest/reference/git#create-a-tree + */ + "POST /repos/{owner}/{repo}/git/trees": Operation<"/repos/{owner}/{repo}/git/trees", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-repository-webhook + */ + "POST /repos/{owner}/{repo}/hooks": Operation<"/repos/{owner}/{repo}/hooks", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#ping-a-repository-webhook + */ + "POST /repos/{owner}/{repo}/hooks/{hook_id}/pings": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}/pings", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#test-the-push-repository-webhook + */ + "POST /repos/{owner}/{repo}/hooks/{hook_id}/tests": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}/tests", "post">; + /** + * @see https://docs.github.com/v3/issues/#create-an-issue + */ + "POST /repos/{owner}/{repo}/issues": Operation<"/repos/{owner}/{repo}/issues", "post">; + /** + * @see https://docs.github.com/v3/reactions/#create-reaction-for-an-issue-comment + */ + "POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": Operation<"/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/issues#add-assignees-to-an-issue + */ + "POST /repos/{owner}/{repo}/issues/{issue_number}/assignees": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/assignees", "post">; + /** + * @see https://docs.github.com/rest/reference/issues#create-an-issue-comment + */ + "POST /repos/{owner}/{repo}/issues/{issue_number}/comments": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/comments", "post">; + /** + * @see https://docs.github.com/rest/reference/issues#add-labels-to-an-issue + */ + "POST /repos/{owner}/{repo}/issues/{issue_number}/labels": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/labels", "post">; + /** + * @see https://docs.github.com/v3/reactions/#create-reaction-for-an-issue + */ + "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-deploy-key + */ + "POST /repos/{owner}/{repo}/keys": Operation<"/repos/{owner}/{repo}/keys", "post">; + /** + * @see https://docs.github.com/rest/reference/issues#create-a-label + */ + "POST /repos/{owner}/{repo}/labels": Operation<"/repos/{owner}/{repo}/labels", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#merge-a-branch + */ + "POST /repos/{owner}/{repo}/merges": Operation<"/repos/{owner}/{repo}/merges", "post">; + /** + * @see https://docs.github.com/rest/reference/issues#create-a-milestone + */ + "POST /repos/{owner}/{repo}/milestones": Operation<"/repos/{owner}/{repo}/milestones", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-github-pages-site + */ + "POST /repos/{owner}/{repo}/pages": Operation<"/repos/{owner}/{repo}/pages", "post", "switcheroo">; + /** + * @see https://docs.github.com/rest/reference/repos#request-a-github-pages-build + */ + "POST /repos/{owner}/{repo}/pages/builds": Operation<"/repos/{owner}/{repo}/pages/builds", "post">; + /** + * @see https://docs.github.com/v3/projects/#create-a-repository-project + */ + "POST /repos/{owner}/{repo}/projects": Operation<"/repos/{owner}/{repo}/projects", "post", "inertia">; + /** + * @see https://docs.github.com/v3/pulls/#create-a-pull-request + */ + "POST /repos/{owner}/{repo}/pulls": Operation<"/repos/{owner}/{repo}/pulls", "post">; + /** + * @see https://docs.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment + */ + "POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": Operation<"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request + */ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/comments", "post">; + /** + * @see https://docs.github.com/rest/reference/pulls#create-a-reply-for-a-review-comment + */ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", "post">; + /** + * @see https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request + */ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "post">; + /** + * @see https://docs.github.com/rest/reference/pulls#create-a-review-for-a-pull-request + */ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "post">; + /** + * @see https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request + */ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-release + */ + "POST /repos/{owner}/{repo}/releases": Operation<"/repos/{owner}/{repo}/releases", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-commit-status + */ + "POST /repos/{owner}/{repo}/statuses/{sha}": Operation<"/repos/{owner}/{repo}/statuses/{sha}", "post">; + /** + * @see https://docs.github.com/v3/repos/#transfer-a-repository + */ + "POST /repos/{owner}/{repo}/transfer": Operation<"/repos/{owner}/{repo}/transfer", "post">; + /** + * @see https://docs.github.com/v3/repos/#create-a-repository-using-a-template + */ + "POST /repos/{template_owner}/{template_repo}/generate": Operation<"/repos/{template_owner}/{template_repo}/generate", "post", "baptiste">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users + */ + "POST /scim/v2/enterprises/{enterprise}/Groups": Operation<"/scim/v2/enterprises/{enterprise}/Groups", "post">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user + */ + "POST /scim/v2/enterprises/{enterprise}/Users": Operation<"/scim/v2/enterprises/{enterprise}/Users", "post">; + /** + * @see https://docs.github.com/v3/scim/#provision-and-invite-a-scim-user + */ + "POST /scim/v2/organizations/{org}/Users": Operation<"/scim/v2/organizations/{org}/Users", "post">; + /** + * @see https://docs.github.com/rest/reference/teams#create-a-discussion-legacy + */ + "POST /teams/{team_id}/discussions": Operation<"/teams/{team_id}/discussions", "post">; + /** + * @see https://docs.github.com/rest/reference/teams#create-a-discussion-comment-legacy + */ + "POST /teams/{team_id}/discussions/{discussion_number}/comments": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments", "post">; + /** + * @see https://docs.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy + */ + "POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy + */ + "POST /teams/{team_id}/discussions/{discussion_number}/reactions": Operation<"/teams/{team_id}/discussions/{discussion_number}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user + */ + "POST /user/emails": Operation<"/user/emails", "post">; + /** + * @see https://docs.github.com/rest/reference/users#create-a-gpg-key-for-the-authenticated-user + */ + "POST /user/gpg_keys": Operation<"/user/gpg_keys", "post">; + /** + * @see https://docs.github.com/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user + */ + "POST /user/keys": Operation<"/user/keys", "post">; + /** + * @see https://docs.github.com/rest/reference/migrations#start-a-user-migration + */ + "POST /user/migrations": Operation<"/user/migrations", "post">; + /** + * @see https://docs.github.com/v3/projects/#create-a-user-project + */ + "POST /user/projects": Operation<"/user/projects", "post", "inertia">; + /** + * @see https://docs.github.com/v3/repos/#create-a-repository-for-the-authenticated-user + */ + "POST /user/repos": Operation<"/user/repos", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#upload-a-release-asset + */ + "POST {origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}": Operation<"/repos/{owner}/{repo}/releases/{release_id}/assets", "post">; + /** + * @see https://docs.github.com/v3/apps/#suspend-an-app-installation + */ + "PUT /app/installations/{installation_id}/suspended": Operation<"/app/installations/{installation_id}/suspended", "put">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app + */ + "PUT /authorizations/clients/{client_id}": Operation<"/authorizations/clients/{client_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint + */ + "PUT /authorizations/clients/{client_id}/{fingerprint}": Operation<"/authorizations/clients/{client_id}/{fingerprint}", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/permissions": Operation<"/enterprises/{enterprise}/actions/permissions", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/permissions/organizations": Operation<"/enterprises/{enterprise}/actions/permissions/organizations", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}": Operation<"/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/permissions/selected-actions": Operation<"/enterprises/{enterprise}/actions/permissions/selected-actions", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#add-a-self-hosted-runner-to-a-group-for-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "put">; + /** + * @see https://docs.github.com/v3/gists/#star-a-gist + */ + "PUT /gists/{gist_id}/star": Operation<"/gists/{gist_id}/star", "put">; + /** + * @see https://docs.github.com/rest/reference/activity#mark-notifications-as-read + */ + "PUT /notifications": Operation<"/notifications", "put">; + /** + * @see https://docs.github.com/rest/reference/activity#set-a-thread-subscription + */ + "PUT /notifications/threads/{thread_id}/subscription": Operation<"/notifications/threads/{thread_id}/subscription", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization + */ + "PUT /orgs/{org}/actions/permissions": Operation<"/orgs/{org}/actions/permissions", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization + */ + "PUT /orgs/{org}/actions/permissions/repositories": Operation<"/orgs/{org}/actions/permissions/repositories", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization + */ + "PUT /orgs/{org}/actions/permissions/repositories/{repository_id}": Operation<"/orgs/{org}/actions/permissions/repositories/{repository_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-organization + */ + "PUT /orgs/{org}/actions/permissions/selected-actions": Operation<"/orgs/{org}/actions/permissions/selected-actions", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#add-repository-acess-to-a-self-hosted-runner-group-in-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/runners": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#add-a-self-hosted-runner-to-a-group-for-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret + */ + "PUT /orgs/{org}/actions/secrets/{secret_name}": Operation<"/orgs/{org}/actions/secrets/{secret_name}", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret + */ + "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories": Operation<"/orgs/{org}/actions/secrets/{secret_name}/repositories", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#add-selected-repository-to-an-organization-secret + */ + "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": Operation<"/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/orgs#block-a-user-from-an-organization + */ + "PUT /orgs/{org}/blocks/{username}": Operation<"/orgs/{org}/blocks/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-an-organization + */ + "PUT /orgs/{org}/interaction-limits": Operation<"/orgs/{org}/interaction-limits", "put">; + /** + * @see https://docs.github.com/rest/reference/orgs#set-organization-membership-for-a-user + */ + "PUT /orgs/{org}/memberships/{username}": Operation<"/orgs/{org}/memberships/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator + */ + "PUT /orgs/{org}/outside_collaborators/{username}": Operation<"/orgs/{org}/outside_collaborators/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user + */ + "PUT /orgs/{org}/public_members/{username}": Operation<"/orgs/{org}/public_members/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user + */ + "PUT /orgs/{org}/teams/{team_slug}/memberships/{username}": Operation<"/orgs/{org}/teams/{team_slug}/memberships/{username}", "put">; + /** + * @see https://docs.github.com/v3/teams/#add-or-update-team-project-permissions + */ + "PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}": Operation<"/orgs/{org}/teams/{team_slug}/projects/{project_id}", "put", "inertia">; + /** + * @see https://docs.github.com/v3/teams/#add-or-update-team-repository-permissions + */ + "PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": Operation<"/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "put">; + /** + * @see https://docs.github.com/rest/reference/projects#add-project-collaborator + */ + "PUT /projects/{project_id}/collaborators/{username}": Operation<"/projects/{project_id}/collaborators/{username}", "put", "inertia">; + /** + * @see https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository + */ + "PUT /repos/{owner}/{repo}/actions/permissions": Operation<"/repos/{owner}/{repo}/actions/permissions", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-allowed-actions-for-a-repository + */ + "PUT /repos/{owner}/{repo}/actions/permissions/selected-actions": Operation<"/repos/{owner}/{repo}/actions/permissions/selected-actions", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#create-or-update-a-repository-secret + */ + "PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}": Operation<"/repos/{owner}/{repo}/actions/secrets/{secret_name}", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#disable-a-workflow + */ + "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#enable-a-workflow + */ + "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", "put">; + /** + * @see https://docs.github.com/v3/repos/#enable-automated-security-fixes + */ + "PUT /repos/{owner}/{repo}/automated-security-fixes": Operation<"/repos/{owner}/{repo}/automated-security-fixes", "put", "london">; + /** + * @see https://docs.github.com/rest/reference/repos#update-branch-protection + */ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#set-status-check-contexts + */ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#set-app-access-restrictions + */ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#set-team-access-restrictions + */ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#set-user-access-restrictions + */ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#add-a-repository-collaborator + */ + "PUT /repos/{owner}/{repo}/collaborators/{username}": Operation<"/repos/{owner}/{repo}/collaborators/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#create-or-update-file-contents + */ + "PUT /repos/{owner}/{repo}/contents/{path}": Operation<"/repos/{owner}/{repo}/contents/{path}", "put">; + /** + * @see https://docs.github.com/rest/reference/migrations#start-an-import + */ + "PUT /repos/{owner}/{repo}/import": Operation<"/repos/{owner}/{repo}/import", "put">; + /** + * @see https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-a-repository + */ + "PUT /repos/{owner}/{repo}/interaction-limits": Operation<"/repos/{owner}/{repo}/interaction-limits", "put">; + /** + * @see https://docs.github.com/rest/reference/issues#set-labels-for-an-issue + */ + "PUT /repos/{owner}/{repo}/issues/{issue_number}/labels": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/labels", "put">; + /** + * @see https://docs.github.com/v3/issues/#lock-an-issue + */ + "PUT /repos/{owner}/{repo}/issues/{issue_number}/lock": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/lock", "put">; + /** + * @see https://docs.github.com/rest/reference/activity#mark-repository-notifications-as-read + */ + "PUT /repos/{owner}/{repo}/notifications": Operation<"/repos/{owner}/{repo}/notifications", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#update-information-about-a-github-pages-site + */ + "PUT /repos/{owner}/{repo}/pages": Operation<"/repos/{owner}/{repo}/pages", "put">; + /** + * @see https://docs.github.com/v3/pulls/#merge-a-pull-request + */ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/merge", "put">; + /** + * @see https://docs.github.com/rest/reference/pulls#update-a-review-for-a-pull-request + */ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/pulls#dismiss-a-review-for-a-pull-request + */ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", "put">; + /** + * @see https://docs.github.com/v3/pulls/#update-a-pull-request-branch + */ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", "put", "lydian">; + /** + * @see https://docs.github.com/rest/reference/activity#set-a-repository-subscription + */ + "PUT /repos/{owner}/{repo}/subscription": Operation<"/repos/{owner}/{repo}/subscription", "put">; + /** + * @see https://docs.github.com/v3/repos/#replace-all-repository-topics + */ + "PUT /repos/{owner}/{repo}/topics": Operation<"/repos/{owner}/{repo}/topics", "put", "mercy">; + /** + * @see https://docs.github.com/v3/repos/#enable-vulnerability-alerts + */ + "PUT /repos/{owner}/{repo}/vulnerability-alerts": Operation<"/repos/{owner}/{repo}/vulnerability-alerts", "put", "dorian">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group + */ + "PUT /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": Operation<"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-user + */ + "PUT /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": Operation<"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "put">; + /** + * @see https://docs.github.com/v3/scim/#set-scim-information-for-a-provisioned-user + */ + "PUT /scim/v2/organizations/{org}/Users/{scim_user_id}": Operation<"/scim/v2/organizations/{org}/Users/{scim_user_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/teams#add-team-member-legacy + */ + "PUT /teams/{team_id}/members/{username}": Operation<"/teams/{team_id}/members/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy + */ + "PUT /teams/{team_id}/memberships/{username}": Operation<"/teams/{team_id}/memberships/{username}", "put">; + /** + * @see https://docs.github.com/v3/teams/#add-or-update-team-project-permissions-legacy + */ + "PUT /teams/{team_id}/projects/{project_id}": Operation<"/teams/{team_id}/projects/{project_id}", "put", "inertia">; + /** + * @see https://docs.github.com/v3/teams/#add-or-update-team-repository-permissions-legacy + */ + "PUT /teams/{team_id}/repos/{owner}/{repo}": Operation<"/teams/{team_id}/repos/{owner}/{repo}", "put">; + /** + * @see https://docs.github.com/rest/reference/users#block-a-user + */ + "PUT /user/blocks/{username}": Operation<"/user/blocks/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/users#follow-a-user + */ + "PUT /user/following/{username}": Operation<"/user/following/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation + */ + "PUT /user/installations/{installation_id}/repositories/{repository_id}": Operation<"/user/installations/{installation_id}/repositories/{repository_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories + */ + "PUT /user/interaction-limits": Operation<"/user/interaction-limits", "put">; + /** + * @see https://docs.github.com/rest/reference/activity#star-a-repository-for-the-authenticated-user + */ + "PUT /user/starred/{owner}/{repo}": Operation<"/user/starred/{owner}/{repo}", "put">; +} +export {}; diff --git a/node_modules/@octokit/types/dist-types/index.d.ts b/node_modules/@octokit/types/dist-types/index.d.ts new file mode 100644 index 0000000..004ae9b --- /dev/null +++ b/node_modules/@octokit/types/dist-types/index.d.ts @@ -0,0 +1,21 @@ +export * from "./AuthInterface"; +export * from "./EndpointDefaults"; +export * from "./EndpointInterface"; +export * from "./EndpointOptions"; +export * from "./Fetch"; +export * from "./OctokitResponse"; +export * from "./RequestError"; +export * from "./RequestHeaders"; +export * from "./RequestInterface"; +export * from "./RequestMethod"; +export * from "./RequestOptions"; +export * from "./RequestParameters"; +export * from "./RequestRequestOptions"; +export * from "./ResponseHeaders"; +export * from "./Route"; +export * from "./Signal"; +export * from "./StrategyInterface"; +export * from "./Url"; +export * from "./VERSION"; +export * from "./GetResponseTypeFromEndpointMethod"; +export * from "./generated/Endpoints"; diff --git a/node_modules/@octokit/types/dist-web/index.js b/node_modules/@octokit/types/dist-web/index.js new file mode 100644 index 0000000..e26f212 --- /dev/null +++ b/node_modules/@octokit/types/dist-web/index.js @@ -0,0 +1,4 @@ +const VERSION = "6.3.2"; + +export { VERSION }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/types/dist-web/index.js.map b/node_modules/@octokit/types/dist-web/index.js.map new file mode 100644 index 0000000..cd0e254 --- /dev/null +++ b/node_modules/@octokit/types/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/VERSION.js"],"sourcesContent":["export const VERSION = \"0.0.0-development\";\n"],"names":[],"mappings":"AAAY,MAAC,OAAO,GAAG;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/types/package.json b/node_modules/@octokit/types/package.json index 67c9120..6336733 100644 --- a/node_modules/@octokit/types/package.json +++ b/node_modules/@octokit/types/package.json @@ -1,57 +1,73 @@ { - "_from": "@octokit/types@^2.0.0", - "_id": "@octokit/types@2.0.2", + "_args": [ + [ + "@octokit/types@6.3.2", + "." + ] + ], + "_from": "@octokit/types@6.3.2", + "_id": "@octokit/types@6.3.2", "_inBundle": false, - "_integrity": "sha512-StASIL2lgT3TRjxv17z9pAqbnI7HGu9DrJlg3sEBFfCLaMEqp+O3IQPUF6EZtQ4xkAu2ml6kMBBCtGxjvmtmuQ==", + "_integrity": "sha512-H6cbnDumWOQJneyNKCBWgnktRqTWcEm6gq2cIS3frtVgpCqB8zguromnjIWJW375btjnxwmbYBTEAEouruZ2Yw==", "_location": "/@octokit/types", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "@octokit/types@^2.0.0", + "raw": "@octokit/types@6.3.2", "name": "@octokit/types", "escapedName": "@octokit%2ftypes", "scope": "@octokit", - "rawSpec": "^2.0.0", + "rawSpec": "6.3.2", "saveSpec": null, - "fetchSpec": "^2.0.0" + "fetchSpec": "6.3.2" }, "_requiredBy": [ + "/@octokit/auth-token", + "/@octokit/core", "/@octokit/endpoint", + "/@octokit/graphql", + "/@octokit/plugin-paginate-rest", + "/@octokit/plugin-rest-endpoint-methods", "/@octokit/request", "/@octokit/request-error" ], - "_resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.0.2.tgz", - "_shasum": "0888497f5a664e28b0449731d5e88e19b2a74f90", - "_spec": "@octokit/types@^2.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/request", - "author": { - "name": "Gregor Martynus", - "url": "https://twitter.com/gr2m" - }, + "_resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.3.2.tgz", + "_spec": "6.3.2", + "_where": ".", "bugs": { "url": "https://github.com/octokit/types.ts/issues" }, - "bundleDependencies": false, "dependencies": { + "@octokit/openapi-types": "^2.3.1", "@types/node": ">= 8" }, - "deprecated": false, "description": "Shared TypeScript definitions for Octokit projects", "devDependencies": { "@octokit/graphql": "^4.2.2", - "handlebars": "^4.4.5", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "handlebars": "^4.7.6", + "json-schema-to-typescript": "^10.0.0", "lodash.set": "^4.3.2", "npm-run-all": "^4.1.5", - "pascal-case": "^2.0.1", - "prettier": "^1.18.2", - "semantic-release": "^15.13.24", + "openapi-typescript": "^2.3.1", + "pascal-case": "^3.1.1", + "pika-plugin-merge-properties": "^1.0.6", + "prettier": "^2.0.0", + "semantic-release": "^17.0.0", "semantic-release-plugin-update-version-in-files": "^1.0.0", "sort-keys": "^4.0.0", "string-to-jsdoc-comment": "^1.0.0", - "typedoc": "^0.15.0", - "typescript": "^3.6.4" + "typedoc": "^0.19.0", + "typescript": "^4.0.2" }, + "files": [ + "dist-*/", + "bin/" + ], "homepage": "https://github.com/octokit/types.ts#readme", "keywords": [ "github", @@ -61,40 +77,22 @@ "typescript" ], "license": "MIT", - "main": "src/index.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js", "name": "@octokit/types", + "octokit": { + "openapi-version": "2.3.1" + }, + "pika": true, "publishConfig": { "access": "public" }, - "release": { - "plugins": [ - "@semantic-release/commit-analyzer", - "@semantic-release/release-notes-generator", - "@semantic-release/github", - "@semantic-release/npm", - [ - "semantic-release-plugin-update-version-in-files", - { - "files": [ - "src/VERSION.ts" - ] - } - ] - ] - }, "repository": { "type": "git", "url": "git+https://github.com/octokit/types.ts.git" }, - "scripts": { - "docs": "typedoc --module commonjs --readme none --out docs src/", - "lint": "prettier --check '{src,test}/**/*' README.md package.json !src/generated/*", - "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json !src/generated/*", - "pretest": "npm run -s lint", - "test": "tsc --noEmit --declaration src/index.ts", - "update-endpoints": "npm-run-all update-endpoints:*", - "update-endpoints:fetch-json": "node scripts/update-endpoints/fetch-json", - "update-endpoints:typescript": "node scripts/update-endpoints/typescript" - }, - "version": "2.0.2" + "sideEffects": false, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "version": "6.3.2" } diff --git a/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js b/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js deleted file mode 100644 index 309a312..0000000 --- a/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js +++ /dev/null @@ -1,46 +0,0 @@ -const { writeFileSync } = require("fs"); -const path = require("path"); - -const { graphql } = require("@octokit/graphql"); -const prettier = require("prettier"); - -if (!process.env.VERSION) { - throw new Error(`VERSION environment variable must be set`); -} - -const QUERY = ` - query ($version: String) { - endpoints(version: $version) { - name - scope(format: CAMELCASE) - id(format: CAMELCASE) - method - url - parameters { - alias - allowNull - deprecated - description - enum - name - type - required - } - } - }`; - -main(); - -async function main() { - const { endpoints } = await graphql(QUERY, { - url: "https://octokit-routes-graphql-server.now.sh/", - version: process.env.VERSION - }); - - writeFileSync( - path.resolve(__dirname, "generated", "endpoints.json"), - prettier.format(JSON.stringify(endpoints), { - parser: "json" - }) - ); -} diff --git a/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md b/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md deleted file mode 100644 index 6beaf58..0000000 --- a/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# DO NOT EDIT FILES IN THIS DIRECTORY - -All files are generated automatically and will be overwritten next time [octokit/routes](https://github.com/octokit/routes/) has a new release. If you find a problem, please file an issue. diff --git a/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json b/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json deleted file mode 100644 index 6c3d62a..0000000 --- a/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json +++ /dev/null @@ -1,25258 +0,0 @@ -[ - { - "name": "Get the authenticated GitHub App", - "scope": "apps", - "id": "getAuthenticated", - "method": "GET", - "url": "/app", - "parameters": [] - }, - { - "name": "Create a GitHub App from a manifest", - "scope": "apps", - "id": "createFromManifest", - "method": "POST", - "url": "/app-manifests/{code}/conversions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "code parameter", - "enum": null, - "name": "code", - "type": "string", - "required": true - } - ] - }, - { - "name": "List installations", - "scope": "apps", - "id": "listInstallations", - "method": "GET", - "url": "/app/installations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get an installation", - "scope": "apps", - "id": "getInstallation", - "method": "GET", - "url": "/app/installations/{installation_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "installation_id parameter", - "enum": null, - "name": "installation_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete an installation", - "scope": "apps", - "id": "deleteInstallation", - "method": "DELETE", - "url": "/app/installations/{installation_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "installation_id parameter", - "enum": null, - "name": "installation_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Create a new installation token", - "scope": "apps", - "id": "createInstallationToken", - "method": "POST", - "url": "/app/installations/{installation_id}/access_tokens", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "installation_id parameter", - "enum": null, - "name": "installation_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "repository_ids", - "type": "integer[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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).\"", - "enum": null, - "name": "permissions", - "type": "object", - "required": false - } - ] - }, - { - "name": "List your grants", - "scope": "oauthAuthorizations", - "id": "listGrants", - "method": "GET", - "url": "/applications/grants", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single grant", - "scope": "oauthAuthorizations", - "id": "getGrant", - "method": "GET", - "url": "/applications/grants/{grant_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "grant_id parameter", - "enum": null, - "name": "grant_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete a grant", - "scope": "oauthAuthorizations", - "id": "deleteGrant", - "method": "DELETE", - "url": "/applications/grants/{grant_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "grant_id parameter", - "enum": null, - "name": "grant_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Revoke a grant for an application", - "scope": "oauthAuthorizations", - "id": "revokeGrantForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/grants/{access_token}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "access_token parameter", - "enum": null, - "name": "access_token", - "type": "string", - "required": true - } - ] - }, - { - "name": "Check an authorization", - "scope": "oauthAuthorizations", - "id": "checkAuthorization", - "method": "GET", - "url": "/applications/{client_id}/tokens/{access_token}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "access_token parameter", - "enum": null, - "name": "access_token", - "type": "string", - "required": true - } - ] - }, - { - "name": "Reset an authorization", - "scope": "oauthAuthorizations", - "id": "resetAuthorization", - "method": "POST", - "url": "/applications/{client_id}/tokens/{access_token}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "access_token parameter", - "enum": null, - "name": "access_token", - "type": "string", - "required": true - } - ] - }, - { - "name": "Revoke an authorization for an application", - "scope": "oauthAuthorizations", - "id": "revokeAuthorizationForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/tokens/{access_token}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "access_token parameter", - "enum": null, - "name": "access_token", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a single GitHub App", - "scope": "apps", - "id": "getBySlug", - "method": "GET", - "url": "/apps/{app_slug}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "app_slug parameter", - "enum": null, - "name": "app_slug", - "type": "string", - "required": true - } - ] - }, - { - "name": "List your authorizations", - "scope": "oauthAuthorizations", - "id": "listAuthorizations", - "method": "GET", - "url": "/authorizations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a new authorization", - "scope": "oauthAuthorizations", - "id": "createAuthorization", - "method": "POST", - "url": "/authorizations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of scopes that this authorization is in.", - "enum": null, - "name": "scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "note", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL to remind you what app the OAuth token is for.", - "enum": null, - "name": "note_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The 20 character OAuth app client key for which to create the token.", - "enum": null, - "name": "client_id", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The 40 character OAuth app client secret for which to create the token.", - "enum": null, - "name": "client_secret", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "enum": null, - "name": "fingerprint", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get-or-create an authorization for a specific app", - "scope": "oauthAuthorizations", - "id": "getOrCreateAuthorizationForApp", - "method": "PUT", - "url": "/authorizations/clients/{client_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "enum": null, - "name": "client_secret", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of scopes that this authorization is in.", - "enum": null, - "name": "scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A note to remind you what the OAuth token is for.", - "enum": null, - "name": "note", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL to remind you what app the OAuth token is for.", - "enum": null, - "name": "note_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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).", - "enum": null, - "name": "fingerprint", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get-or-create an authorization for a specific app and fingerprint", - "scope": "oauthAuthorizations", - "id": "getOrCreateAuthorizationForAppAndFingerprint", - "method": "PUT", - "url": "/authorizations/clients/{client_id}/{fingerprint}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "fingerprint parameter", - "enum": null, - "name": "fingerprint", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "enum": null, - "name": "client_secret", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of scopes that this authorization is in.", - "enum": null, - "name": "scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A note to remind you what the OAuth token is for.", - "enum": null, - "name": "note", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL to remind you what app the OAuth token is for.", - "enum": null, - "name": "note_url", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get-or-create an authorization for a specific app and fingerprint", - "scope": "oauthAuthorizations", - "id": "getOrCreateAuthorizationForAppFingerprint", - "method": "PUT", - "url": "/authorizations/clients/{client_id}/{fingerprint}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "client_id parameter", - "enum": null, - "name": "client_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "fingerprint parameter", - "enum": null, - "name": "fingerprint", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "enum": null, - "name": "client_secret", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of scopes that this authorization is in.", - "enum": null, - "name": "scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A note to remind you what the OAuth token is for.", - "enum": null, - "name": "note", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL to remind you what app the OAuth token is for.", - "enum": null, - "name": "note_url", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a single authorization", - "scope": "oauthAuthorizations", - "id": "getAuthorization", - "method": "GET", - "url": "/authorizations/{authorization_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "authorization_id parameter", - "enum": null, - "name": "authorization_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Update an existing authorization", - "scope": "oauthAuthorizations", - "id": "updateAuthorization", - "method": "PATCH", - "url": "/authorizations/{authorization_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "authorization_id parameter", - "enum": null, - "name": "authorization_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Replaces the authorization scopes with these.", - "enum": null, - "name": "scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of scopes to add to this authorization.", - "enum": null, - "name": "add_scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of scopes to remove from this authorization.", - "enum": null, - "name": "remove_scopes", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "note", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL to remind you what app the OAuth token is for.", - "enum": null, - "name": "note_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "enum": null, - "name": "fingerprint", - "type": "string", - "required": false - } - ] - }, - { - "name": "Delete an authorization", - "scope": "oauthAuthorizations", - "id": "deleteAuthorization", - "method": "DELETE", - "url": "/authorizations/{authorization_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "authorization_id parameter", - "enum": null, - "name": "authorization_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List all codes of conduct", - "scope": "codesOfConduct", - "id": "listConductCodes", - "method": "GET", - "url": "/codes_of_conduct", - "parameters": [] - }, - { - "name": "Get an individual code of conduct", - "scope": "codesOfConduct", - "id": "getConductCode", - "method": "GET", - "url": "/codes_of_conduct/{key}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "key parameter", - "enum": null, - "name": "key", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create a content attachment", - "scope": "apps", - "id": "createContentAttachment", - "method": "POST", - "url": "/content_references/{content_reference_id}/attachments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "content_reference_id parameter", - "enum": null, - "name": "content_reference_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the content attachment displayed in the body or comment of an issue or pull request.", - "enum": null, - "name": "title", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get", - "scope": "emojis", - "id": "get", - "method": "GET", - "url": "/emojis", - "parameters": [] - }, - { - "name": "List public events", - "scope": "activity", - "id": "listPublicEvents", - "method": "GET", - "url": "/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List feeds", - "scope": "activity", - "id": "listFeeds", - "method": "GET", - "url": "/feeds", - "parameters": [] - }, - { - "name": "List the authenticated user's gists or if called anonymously, this will return all public gists", - "scope": "gists", - "id": "list", - "method": "GET", - "url": "/gists", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a gist", - "scope": "gists", - "id": "create", - "method": "POST", - "url": "/gists", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "files", - "type": "object", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The content of the file.", - "enum": null, - "name": "files.content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A descriptive name for this gist.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "When `true`, the gist will be public and available for anyone to see.", - "enum": null, - "name": "public", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "List all public gists", - "scope": "gists", - "id": "listPublic", - "method": "GET", - "url": "/gists/public", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List starred gists", - "scope": "gists", - "id": "listStarred", - "method": "GET", - "url": "/gists/starred", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single gist", - "scope": "gists", - "id": "get", - "method": "GET", - "url": "/gists/{gist_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - } - ] - }, - { - "name": "Edit a gist", - "scope": "gists", - "id": "update", - "method": "PATCH", - "url": "/gists/{gist_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A descriptive name for this gist.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The filenames and content that make up this gist.", - "enum": null, - "name": "files", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The updated content of the file.", - "enum": null, - "name": "files.content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new name for this file. To delete a file, set the value of the filename to `null`.", - "enum": null, - "name": "files.filename", - "type": "string", - "required": false - } - ] - }, - { - "name": "Delete a gist", - "scope": "gists", - "id": "delete", - "method": "DELETE", - "url": "/gists/{gist_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - } - ] - }, - { - "name": "List comments on a gist", - "scope": "gists", - "id": "listComments", - "method": "GET", - "url": "/gists/{gist_id}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a comment", - "scope": "gists", - "id": "createComment", - "method": "POST", - "url": "/gists/{gist_id}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The comment text.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a single comment", - "scope": "gists", - "id": "getComment", - "method": "GET", - "url": "/gists/{gist_id}/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a comment", - "scope": "gists", - "id": "updateComment", - "method": "PATCH", - "url": "/gists/{gist_id}/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The comment text.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a comment", - "scope": "gists", - "id": "deleteComment", - "method": "DELETE", - "url": "/gists/{gist_id}/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List gist commits", - "scope": "gists", - "id": "listCommits", - "method": "GET", - "url": "/gists/{gist_id}/commits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Fork a gist", - "scope": "gists", - "id": "fork", - "method": "POST", - "url": "/gists/{gist_id}/forks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - } - ] - }, - { - "name": "List gist forks", - "scope": "gists", - "id": "listForks", - "method": "GET", - "url": "/gists/{gist_id}/forks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Star a gist", - "scope": "gists", - "id": "star", - "method": "PUT", - "url": "/gists/{gist_id}/star", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - } - ] - }, - { - "name": "Unstar a gist", - "scope": "gists", - "id": "unstar", - "method": "DELETE", - "url": "/gists/{gist_id}/star", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - } - ] - }, - { - "name": "Check if a gist is starred", - "scope": "gists", - "id": "checkIsStarred", - "method": "GET", - "url": "/gists/{gist_id}/star", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a specific revision of a gist", - "scope": "gists", - "id": "getRevision", - "method": "GET", - "url": "/gists/{gist_id}/{sha}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gist_id parameter", - "enum": null, - "name": "gist_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "sha parameter", - "enum": null, - "name": "sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "Listing available templates", - "scope": "gitignore", - "id": "listTemplates", - "method": "GET", - "url": "/gitignore/templates", - "parameters": [] - }, - { - "name": "Get a single template", - "scope": "gitignore", - "id": "getTemplate", - "method": "GET", - "url": "/gitignore/templates/{name}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "name parameter", - "enum": null, - "name": "name", - "type": "string", - "required": true - } - ] - }, - { - "name": "List repositories", - "scope": "apps", - "id": "listRepos", - "method": "GET", - "url": "/installation/repositories", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories", - "scope": "issues", - "id": "list", - "method": "GET", - "url": "/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "enum": null, - "name": "labels", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "enum": ["created", "updated", "comments"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The direction of the sort. Can be either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Search issues", - "scope": "search", - "id": "issuesLegacy", - "method": "GET", - "url": "/legacy/issues/search/{owner}/{repository}/{state}/{keyword}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repository parameter", - "enum": null, - "name": "repository", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the issues to return. Can be either `open` or `closed`.", - "enum": ["open", "closed"], - "name": "state", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The search term.", - "enum": null, - "name": "keyword", - "type": "string", - "required": true - } - ] - }, - { - "name": "Search repositories", - "scope": "search", - "id": "reposLegacy", - "method": "GET", - "url": "/legacy/repos/search/{keyword}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The search term.", - "enum": null, - "name": "keyword", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filter results by language.", - "enum": null, - "name": "language", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The page number to fetch.", - "enum": null, - "name": "start_page", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", - "enum": ["stars", "forks", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "order", - "type": "string", - "required": false - } - ] - }, - { - "name": "Email search", - "scope": "search", - "id": "emailLegacy", - "method": "GET", - "url": "/legacy/user/email/{email}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email address.", - "enum": null, - "name": "email", - "type": "string", - "required": true - } - ] - }, - { - "name": "Search users", - "scope": "search", - "id": "usersLegacy", - "method": "GET", - "url": "/legacy/user/search/{keyword}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The search term.", - "enum": null, - "name": "keyword", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The page number to fetch.", - "enum": null, - "name": "start_page", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", - "enum": ["stars", "forks", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "order", - "type": "string", - "required": false - } - ] - }, - { - "name": "List commonly used licenses", - "scope": "licenses", - "id": "listCommonlyUsed", - "method": "GET", - "url": "/licenses", - "parameters": [] - }, - { - "name": "List commonly used licenses", - "scope": "licenses", - "id": "list", - "method": "GET", - "url": "/licenses", - "parameters": [] - }, - { - "name": "Get an individual license", - "scope": "licenses", - "id": "get", - "method": "GET", - "url": "/licenses/{license}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "license parameter", - "enum": null, - "name": "license", - "type": "string", - "required": true - } - ] - }, - { - "name": "Render an arbitrary Markdown document", - "scope": "markdown", - "id": "render", - "method": "POST", - "url": "/markdown", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.", - "enum": null, - "name": "text", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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"], - "name": "mode", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.", - "enum": null, - "name": "context", - "type": "string", - "required": false - } - ] - }, - { - "name": "Render a Markdown document in raw mode", - "scope": "markdown", - "id": "renderRaw", - "method": "POST", - "url": "/markdown/raw", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "data parameter", - "enum": null, - "name": "data", - "type": "string", - "required": true - } - ] - }, - { - "name": "Check if a GitHub account is associated with any Marketplace listing", - "scope": "apps", - "id": "checkAccountIsAssociatedWithAny", - "method": "GET", - "url": "/marketplace_listing/accounts/{account_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "account_id parameter", - "enum": null, - "name": "account_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all plans for your Marketplace listing", - "scope": "apps", - "id": "listPlans", - "method": "GET", - "url": "/marketplace_listing/plans", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all GitHub accounts (user or organization) on a specific plan", - "scope": "apps", - "id": "listAccountsUserOrOrgOnPlan", - "method": "GET", - "url": "/marketplace_listing/plans/{plan_id}/accounts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "plan_id parameter", - "enum": null, - "name": "plan_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if a GitHub account is associated with any Marketplace listing (stubbed)", - "scope": "apps", - "id": "checkAccountIsAssociatedWithAnyStubbed", - "method": "GET", - "url": "/marketplace_listing/stubbed/accounts/{account_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "account_id parameter", - "enum": null, - "name": "account_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all plans for your Marketplace listing (stubbed)", - "scope": "apps", - "id": "listPlansStubbed", - "method": "GET", - "url": "/marketplace_listing/stubbed/plans", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all GitHub accounts (user or organization) on a specific plan (stubbed)", - "scope": "apps", - "id": "listAccountsUserOrOrgOnPlanStubbed", - "method": "GET", - "url": "/marketplace_listing/stubbed/plans/{plan_id}/accounts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "plan_id parameter", - "enum": null, - "name": "plan_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get", - "scope": "meta", - "id": "get", - "method": "GET", - "url": "/meta", - "parameters": [] - }, - { - "name": "List public events for a network of repositories", - "scope": "activity", - "id": "listPublicEventsForRepoNetwork", - "method": "GET", - "url": "/networks/{owner}/{repo}/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List your notifications", - "scope": "activity", - "id": "listNotifications", - "method": "GET", - "url": "/notifications", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If `true`, show notifications marked as read.", - "enum": null, - "name": "all", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "enum": null, - "name": "participating", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "before", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Mark as read", - "scope": "activity", - "id": "markAsRead", - "method": "PUT", - "url": "/notifications", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "enum": null, - "name": "last_read_at", - "type": "string", - "required": false - } - ] - }, - { - "name": "View a single thread", - "scope": "activity", - "id": "getThread", - "method": "GET", - "url": "/notifications/threads/{thread_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "thread_id parameter", - "enum": null, - "name": "thread_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Mark a thread as read", - "scope": "activity", - "id": "markThreadAsRead", - "method": "PATCH", - "url": "/notifications/threads/{thread_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "thread_id parameter", - "enum": null, - "name": "thread_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Get a thread subscription", - "scope": "activity", - "id": "getThreadSubscription", - "method": "GET", - "url": "/notifications/threads/{thread_id}/subscription", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "thread_id parameter", - "enum": null, - "name": "thread_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Set a thread subscription", - "scope": "activity", - "id": "setThreadSubscription", - "method": "PUT", - "url": "/notifications/threads/{thread_id}/subscription", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "thread_id parameter", - "enum": null, - "name": "thread_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.", - "enum": null, - "name": "ignored", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a thread subscription", - "scope": "activity", - "id": "deleteThreadSubscription", - "method": "DELETE", - "url": "/notifications/threads/{thread_id}/subscription", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "thread_id parameter", - "enum": null, - "name": "thread_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List all organizations", - "scope": "orgs", - "id": "list", - "method": "GET", - "url": "/organizations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The integer ID of the last Organization that you've seen.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get an organization", - "scope": "orgs", - "id": "get", - "method": "GET", - "url": "/orgs/{org}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Edit an organization", - "scope": "orgs", - "id": "update", - "method": "PATCH", - "url": "/orgs/{org}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Billing email address. This address is not publicized.", - "enum": null, - "name": "billing_email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The company name.", - "enum": null, - "name": "company", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The publicly visible email address.", - "enum": null, - "name": "email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The location.", - "enum": null, - "name": "location", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The shorthand name of the company.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the company.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Toggles whether organization projects are enabled for the organization.", - "enum": null, - "name": "has_organization_projects", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Toggles whether repository projects are enabled for repositories that belong to the organization.", - "enum": null, - "name": "has_repository_projects", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "admin", "none"], - "name": "default_repository_permission", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "members_can_create_repositories", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "none"], - "name": "members_allowed_repository_creation_type", - "type": "string", - "required": false - } - ] - }, - { - "name": "List blocked users", - "scope": "orgs", - "id": "listBlockedUsers", - "method": "GET", - "url": "/orgs/{org}/blocks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Check whether a user is blocked from an organization", - "scope": "orgs", - "id": "checkBlockedUser", - "method": "GET", - "url": "/orgs/{org}/blocks/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Block a user", - "scope": "orgs", - "id": "blockUser", - "method": "PUT", - "url": "/orgs/{org}/blocks/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Unblock a user", - "scope": "orgs", - "id": "unblockUser", - "method": "DELETE", - "url": "/orgs/{org}/blocks/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List credential authorizations for an organization", - "scope": "orgs", - "id": "listCredentialAuthorizations", - "method": "GET", - "url": "/orgs/{org}/credential-authorizations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove a credential authorization for an organization", - "scope": "orgs", - "id": "removeCredentialAuthorization", - "method": "DELETE", - "url": "/orgs/{org}/credential-authorizations/{credential_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "credential_id parameter", - "enum": null, - "name": "credential_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List public events for an organization", - "scope": "activity", - "id": "listPublicEventsForOrg", - "method": "GET", - "url": "/orgs/{org}/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List hooks", - "scope": "orgs", - "id": "listHooks", - "method": "GET", - "url": "/orgs/{org}/hooks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a hook", - "scope": "orgs", - "id": "createHook", - "method": "POST", - "url": "/orgs/{org}/hooks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Must be passed as \"web\".", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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).", - "enum": null, - "name": "config", - "type": "object", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL to which the payloads will be delivered.", - "enum": null, - "name": "config.url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "enum": null, - "name": "config.content_type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "config.secret", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.**", - "enum": null, - "name": "config.insecure_ssl", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", - "enum": null, - "name": "events", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "enum": null, - "name": "active", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get single hook", - "scope": "orgs", - "id": "getHook", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a hook", - "scope": "orgs", - "id": "updateHook", - "method": "PATCH", - "url": "/orgs/{org}/hooks/{hook_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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).", - "enum": null, - "name": "config", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL to which the payloads will be delivered.", - "enum": null, - "name": "config.url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "enum": null, - "name": "config.content_type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "config.secret", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.**", - "enum": null, - "name": "config.insecure_ssl", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", - "enum": null, - "name": "events", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "enum": null, - "name": "active", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a hook", - "scope": "orgs", - "id": "deleteHook", - "method": "DELETE", - "url": "/orgs/{org}/hooks/{hook_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Ping a hook", - "scope": "orgs", - "id": "pingHook", - "method": "POST", - "url": "/orgs/{org}/hooks/{hook_id}/pings", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Get an organization installation", - "scope": "apps", - "id": "getOrgInstallation", - "method": "GET", - "url": "/orgs/{org}/installation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get an organization installation", - "scope": "apps", - "id": "findOrgInstallation", - "method": "GET", - "url": "/orgs/{org}/installation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get interaction restrictions for an organization", - "scope": "interactions", - "id": "getRestrictionsForOrg", - "method": "GET", - "url": "/orgs/{org}/interaction-limits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add or update interaction restrictions for an organization", - "scope": "interactions", - "id": "addOrUpdateRestrictionsForOrg", - "method": "PUT", - "url": "/orgs/{org}/interaction-limits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "collaborators_only"], - "name": "limit", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove interaction restrictions for an organization", - "scope": "interactions", - "id": "removeRestrictionsForOrg", - "method": "DELETE", - "url": "/orgs/{org}/interaction-limits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "List pending organization invitations", - "scope": "orgs", - "id": "listPendingInvitations", - "method": "GET", - "url": "/orgs/{org}/invitations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create organization invitation", - "scope": "orgs", - "id": "createInvitation", - "method": "POST", - "url": "/orgs/{org}/invitations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting.", - "enum": null, - "name": "invitee_id", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.", - "enum": null, - "name": "email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "billing_manager"], - "name": "role", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specify IDs for the teams you want to invite new members to.", - "enum": null, - "name": "team_ids", - "type": "integer[]", - "required": false - } - ] - }, - { - "name": "List organization invitation teams", - "scope": "orgs", - "id": "listInvitationTeams", - "method": "GET", - "url": "/orgs/{org}/invitations/{invitation_id}/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "invitation_id parameter", - "enum": null, - "name": "invitation_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all issues for a given organization assigned to the authenticated user", - "scope": "issues", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "enum": null, - "name": "labels", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "enum": ["created", "updated", "comments"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The direction of the sort. Can be either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Members list", - "scope": "orgs", - "id": "listMembers", - "method": "GET", - "url": "/orgs/{org}/members", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": ["2fa_disabled", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": ["all", "admin", "member"], - "name": "role", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check membership", - "scope": "orgs", - "id": "checkMembership", - "method": "GET", - "url": "/orgs/{org}/members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove a member", - "scope": "orgs", - "id": "removeMember", - "method": "DELETE", - "url": "/orgs/{org}/members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get organization membership", - "scope": "orgs", - "id": "getMembership", - "method": "GET", - "url": "/orgs/{org}/memberships/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add or update organization membership", - "scope": "orgs", - "id": "addOrUpdateMembership", - "method": "PUT", - "url": "/orgs/{org}/memberships/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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"], - "name": "role", - "type": "string", - "required": false - } - ] - }, - { - "name": "Remove organization membership", - "scope": "orgs", - "id": "removeMembership", - "method": "DELETE", - "url": "/orgs/{org}/memberships/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Start an organization migration", - "scope": "migrations", - "id": "startForOrg", - "method": "POST", - "url": "/orgs/{org}/migrations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of arrays indicating which repositories should be migrated.", - "enum": null, - "name": "repositories", - "type": "string[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", - "enum": null, - "name": "lock_repositories", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", - "enum": null, - "name": "exclude_attachments", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a list of organization migrations", - "scope": "migrations", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/migrations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get the status of an organization migration", - "scope": "migrations", - "id": "getStatusForOrg", - "method": "GET", - "url": "/orgs/{org}/migrations/{migration_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Download an organization migration archive", - "scope": "migrations", - "id": "getArchiveForOrg", - "method": "GET", - "url": "/orgs/{org}/migrations/{migration_id}/archive", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete an organization migration archive", - "scope": "migrations", - "id": "deleteArchiveForOrg", - "method": "DELETE", - "url": "/orgs/{org}/migrations/{migration_id}/archive", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Unlock an organization repository", - "scope": "migrations", - "id": "unlockRepoForOrg", - "method": "DELETE", - "url": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo_name parameter", - "enum": null, - "name": "repo_name", - "type": "string", - "required": true - } - ] - }, - { - "name": "List outside collaborators", - "scope": "orgs", - "id": "listOutsideCollaborators", - "method": "GET", - "url": "/orgs/{org}/outside_collaborators", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": ["2fa_disabled", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Remove outside collaborator", - "scope": "orgs", - "id": "removeOutsideCollaborator", - "method": "DELETE", - "url": "/orgs/{org}/outside_collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Convert member to outside collaborator", - "scope": "orgs", - "id": "convertMemberToOutsideCollaborator", - "method": "PUT", - "url": "/orgs/{org}/outside_collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List organization projects", - "scope": "projects", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create an organization project", - "scope": "projects", - "id": "createForOrg", - "method": "POST", - "url": "/orgs/{org}/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the project.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the project.", - "enum": null, - "name": "body", - "type": "string", - "required": false - } - ] - }, - { - "name": "Public members list", - "scope": "orgs", - "id": "listPublicMembers", - "method": "GET", - "url": "/orgs/{org}/public_members", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check public membership", - "scope": "orgs", - "id": "checkPublicMembership", - "method": "GET", - "url": "/orgs/{org}/public_members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Publicize a user's membership", - "scope": "orgs", - "id": "publicizeMembership", - "method": "PUT", - "url": "/orgs/{org}/public_members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Conceal a user's membership", - "scope": "orgs", - "id": "concealMembership", - "method": "DELETE", - "url": "/orgs/{org}/public_members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List organization repositories", - "scope": "repos", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/repos", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`.", - "enum": ["all", "public", "private", "forks", "sources", "member"], - "name": "type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", - "enum": ["created", "updated", "pushed", "full_name"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Creates a new repository in the specified organization", - "scope": "repos", - "id": "createInOrg", - "method": "POST", - "url": "/orgs/{org}/repos", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the repository.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the repository.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL with more information about the repository.", - "enum": null, - "name": "homepage", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", - "enum": null, - "name": "private", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "enum": null, - "name": "has_issues", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "has_projects", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "enum": null, - "name": "has_wiki", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "enum": null, - "name": "is_template", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "team_id", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Pass `true` to create an initial commit with empty README.", - "enum": null, - "name": "auto_init", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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\".", - "enum": null, - "name": "gitignore_template", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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\".", - "enum": null, - "name": "license_template", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "enum": null, - "name": "allow_squash_merge", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "enum": null, - "name": "allow_merge_commit", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "enum": null, - "name": "allow_rebase_merge", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "List IdP groups in an organization", - "scope": "teams", - "id": "listIdPGroupsForOrg", - "method": "GET", - "url": "/orgs/{org}/team-sync/groups", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List teams", - "scope": "teams", - "id": "list", - "method": "GET", - "url": "/orgs/{org}/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create team", - "scope": "teams", - "id": "create", - "method": "POST", - "url": "/orgs/{org}/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the team.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the team.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The logins of organization members to add as maintainers of the team.", - "enum": null, - "name": "maintainers", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "enum": null, - "name": "repo_names", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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"], - "name": "privacy", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "admin"], - "name": "permission", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "parent_team_id", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get team by name", - "scope": "teams", - "id": "getByName", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_slug parameter", - "enum": null, - "name": "team_slug", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a project card", - "scope": "projects", - "id": "getCard", - "method": "GET", - "url": "/projects/columns/cards/{card_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "card_id parameter", - "enum": null, - "name": "card_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Update a project card", - "scope": "projects", - "id": "updateCard", - "method": "PATCH", - "url": "/projects/columns/cards/{card_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "card_id parameter", - "enum": null, - "name": "card_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "note", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card.", - "enum": null, - "name": "archived", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a project card", - "scope": "projects", - "id": "deleteCard", - "method": "DELETE", - "url": "/projects/columns/cards/{card_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "card_id parameter", - "enum": null, - "name": "card_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Move a project card", - "scope": "projects", - "id": "moveCard", - "method": "POST", - "url": "/projects/columns/cards/{card_id}/moves", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "card_id parameter", - "enum": null, - "name": "card_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "position", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The `id` value of a column in the same project.", - "enum": null, - "name": "column_id", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a project column", - "scope": "projects", - "id": "getColumn", - "method": "GET", - "url": "/projects/columns/{column_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "column_id parameter", - "enum": null, - "name": "column_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Update a project column", - "scope": "projects", - "id": "updateColumn", - "method": "PATCH", - "url": "/projects/columns/{column_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "column_id parameter", - "enum": null, - "name": "column_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new name of the column.", - "enum": null, - "name": "name", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a project column", - "scope": "projects", - "id": "deleteColumn", - "method": "DELETE", - "url": "/projects/columns/{column_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "column_id parameter", - "enum": null, - "name": "column_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List project cards", - "scope": "projects", - "id": "listCards", - "method": "GET", - "url": "/projects/columns/{column_id}/cards", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "column_id parameter", - "enum": null, - "name": "column_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", - "enum": ["all", "archived", "not_archived"], - "name": "archived_state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a project card", - "scope": "projects", - "id": "createCard", - "method": "POST", - "url": "/projects/columns/{column_id}/cards", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "column_id parameter", - "enum": null, - "name": "column_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "note", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "content_id", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "content_type", - "type": "string", - "required": false - } - ] - }, - { - "name": "Move a project column", - "scope": "projects", - "id": "moveColumn", - "method": "POST", - "url": "/projects/columns/{column_id}/moves", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "column_id parameter", - "enum": null, - "name": "column_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project.", - "enum": null, - "name": "position", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a project", - "scope": "projects", - "id": "get", - "method": "GET", - "url": "/projects/{project_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Update a project", - "scope": "projects", - "id": "update", - "method": "PATCH", - "url": "/projects/{project_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the project.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the project.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "State of the project. Either `open` or `closed`.", - "enum": ["open", "closed"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "organization_permission", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "private", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a project", - "scope": "projects", - "id": "delete", - "method": "DELETE", - "url": "/projects/{project_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List collaborators", - "scope": "projects", - "id": "listCollaborators", - "method": "GET", - "url": "/projects/{project_id}/collaborators", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": ["outside", "direct", "all"], - "name": "affiliation", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Add user as a collaborator", - "scope": "projects", - "id": "addCollaborator", - "method": "PUT", - "url": "/projects/{project_id}/collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "admin"], - "name": "permission", - "type": "string", - "required": false - } - ] - }, - { - "name": "Remove user as a collaborator", - "scope": "projects", - "id": "removeCollaborator", - "method": "DELETE", - "url": "/projects/{project_id}/collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Review a user's permission level", - "scope": "projects", - "id": "reviewUserPermissionLevel", - "method": "GET", - "url": "/projects/{project_id}/collaborators/{username}/permission", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List project columns", - "scope": "projects", - "id": "listColumns", - "method": "GET", - "url": "/projects/{project_id}/columns", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a project column", - "scope": "projects", - "id": "createColumn", - "method": "POST", - "url": "/projects/{project_id}/columns", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the column.", - "enum": null, - "name": "name", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get your current rate limit status", - "scope": "rateLimit", - "id": "get", - "method": "GET", - "url": "/rate_limit", - "parameters": [] - }, - { - "name": "Delete a reaction", - "scope": "reactions", - "id": "delete", - "method": "DELETE", - "url": "/reactions/{reaction_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "reaction_id parameter", - "enum": null, - "name": "reaction_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Get", - "scope": "repos", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Edit", - "scope": "repos", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the repository.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the repository.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL with more information about the repository.", - "enum": null, - "name": "homepage", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "private", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "enum": null, - "name": "has_issues", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "has_projects", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "enum": null, - "name": "has_wiki", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "enum": null, - "name": "is_template", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Updates the default branch for this repository.", - "enum": null, - "name": "default_branch", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "enum": null, - "name": "allow_squash_merge", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "enum": null, - "name": "allow_merge_commit", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "enum": null, - "name": "allow_rebase_merge", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "enum": null, - "name": "archived", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a repository", - "scope": "repos", - "id": "delete", - "method": "DELETE", - "url": "/repos/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List assignees", - "scope": "issues", - "id": "listAssignees", - "method": "GET", - "url": "/repos/{owner}/{repo}/assignees", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check assignee", - "scope": "issues", - "id": "checkAssignee", - "method": "GET", - "url": "/repos/{owner}/{repo}/assignees/{assignee}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "assignee parameter", - "enum": null, - "name": "assignee", - "type": "string", - "required": true - } - ] - }, - { - "name": "Enable automated security fixes", - "scope": "repos", - "id": "enableAutomatedSecurityFixes", - "method": "PUT", - "url": "/repos/{owner}/{repo}/automated-security-fixes", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Disable automated security fixes", - "scope": "repos", - "id": "disableAutomatedSecurityFixes", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/automated-security-fixes", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List branches", - "scope": "repos", - "id": "listBranches", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", - "enum": null, - "name": "protected", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get branch", - "scope": "repos", - "id": "getBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get branch protection", - "scope": "repos", - "id": "getBranchProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update branch protection", - "scope": "repos", - "id": "updateBranchProtection", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": true, - "deprecated": null, - "description": "Require status checks to pass before merging. Set to `null` to disable.", - "enum": null, - "name": "required_status_checks", - "type": "object", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Require branches to be up to date before merging.", - "enum": null, - "name": "required_status_checks.strict", - "type": "boolean", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of status checks to require in order to merge into this branch", - "enum": null, - "name": "required_status_checks.contexts", - "type": "string[]", - "required": true - }, - { - "alias": null, - "allowNull": true, - "deprecated": null, - "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "enum": null, - "name": "enforce_admins", - "type": "boolean", - "required": true - }, - { - "alias": null, - "allowNull": true, - "deprecated": null, - "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", - "enum": null, - "name": "required_pull_request_reviews", - "type": "object", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "required_pull_request_reviews.dismissal_restrictions", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of user `login`s with dismissal access", - "enum": null, - "name": "required_pull_request_reviews.dismissal_restrictions.users", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of team `slug`s with dismissal access", - "enum": null, - "name": "required_pull_request_reviews.dismissal_restrictions.teams", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "enum": null, - "name": "required_pull_request_reviews.dismiss_stale_reviews", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", - "enum": null, - "name": "required_pull_request_reviews.require_code_owner_reviews", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "enum": null, - "name": "required_pull_request_reviews.required_approving_review_count", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": true, - "deprecated": null, - "description": "Restrict who can push to this branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", - "enum": null, - "name": "restrictions", - "type": "object", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of user `login`s with push access", - "enum": null, - "name": "restrictions.users", - "type": "string[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of team `slug`s with push access", - "enum": null, - "name": "restrictions.teams", - "type": "string[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of app `slug`s with push access", - "enum": null, - "name": "restrictions.apps", - "type": "string[]", - "required": false - } - ] - }, - { - "name": "Remove branch protection", - "scope": "repos", - "id": "removeBranchProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get admin enforcement of protected branch", - "scope": "repos", - "id": "getProtectedBranchAdminEnforcement", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add admin enforcement of protected branch", - "scope": "repos", - "id": "addProtectedBranchAdminEnforcement", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove admin enforcement of protected branch", - "scope": "repos", - "id": "removeProtectedBranchAdminEnforcement", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get pull request review enforcement of protected branch", - "scope": "repos", - "id": "getProtectedBranchPullRequestReviewEnforcement", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update pull request review enforcement of protected branch", - "scope": "repos", - "id": "updateProtectedBranchPullRequestReviewEnforcement", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "dismissal_restrictions", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of user `login`s with dismissal access", - "enum": null, - "name": "dismissal_restrictions.users", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of team `slug`s with dismissal access", - "enum": null, - "name": "dismissal_restrictions.teams", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "enum": null, - "name": "dismiss_stale_reviews", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", - "enum": null, - "name": "require_code_owner_reviews", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "enum": null, - "name": "required_approving_review_count", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Remove pull request review enforcement of protected branch", - "scope": "repos", - "id": "removeProtectedBranchPullRequestReviewEnforcement", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get required signatures of protected branch", - "scope": "repos", - "id": "getProtectedBranchRequiredSignatures", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add required signatures of protected branch", - "scope": "repos", - "id": "addProtectedBranchRequiredSignatures", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove required signatures of protected branch", - "scope": "repos", - "id": "removeProtectedBranchRequiredSignatures", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get required status checks of protected branch", - "scope": "repos", - "id": "getProtectedBranchRequiredStatusChecks", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update required status checks of protected branch", - "scope": "repos", - "id": "updateProtectedBranchRequiredStatusChecks", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Require branches to be up to date before merging.", - "enum": null, - "name": "strict", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The list of status checks to require in order to merge into this branch", - "enum": null, - "name": "contexts", - "type": "string[]", - "required": false - } - ] - }, - { - "name": "Remove required status checks of protected branch", - "scope": "repos", - "id": "removeProtectedBranchRequiredStatusChecks", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "List required status checks contexts of protected branch", - "scope": "repos", - "id": "listProtectedBranchRequiredStatusChecksContexts", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Replace required status checks contexts of protected branch", - "scope": "repos", - "id": "replaceProtectedBranchRequiredStatusChecksContexts", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "contexts parameter", - "enum": null, - "name": "contexts", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Add required status checks contexts of protected branch", - "scope": "repos", - "id": "addProtectedBranchRequiredStatusChecksContexts", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "contexts parameter", - "enum": null, - "name": "contexts", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Remove required status checks contexts of protected branch", - "scope": "repos", - "id": "removeProtectedBranchRequiredStatusChecksContexts", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "contexts parameter", - "enum": null, - "name": "contexts", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Get restrictions of protected branch", - "scope": "repos", - "id": "getProtectedBranchRestrictions", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove restrictions of protected branch", - "scope": "repos", - "id": "removeProtectedBranchRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get apps with access to protected branch", - "scope": "repos", - "id": "getAppsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get apps with access to protected branch", - "scope": "repos", - "id": "listAppsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Replace app restrictions of protected branch", - "scope": "repos", - "id": "replaceProtectedBranchAppRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "apps parameter", - "enum": null, - "name": "apps", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Add app restrictions of protected branch", - "scope": "repos", - "id": "addProtectedBranchAppRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "apps parameter", - "enum": null, - "name": "apps", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Remove app restrictions of protected branch", - "scope": "repos", - "id": "removeProtectedBranchAppRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "apps parameter", - "enum": null, - "name": "apps", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Get teams with access to protected branch", - "scope": "repos", - "id": "getTeamsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get teams with access to protected branch", - "scope": "repos", - "id": "listProtectedBranchTeamRestrictions", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get teams with access to protected branch", - "scope": "repos", - "id": "listTeamsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Replace team restrictions of protected branch", - "scope": "repos", - "id": "replaceProtectedBranchTeamRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "teams parameter", - "enum": null, - "name": "teams", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Add team restrictions of protected branch", - "scope": "repos", - "id": "addProtectedBranchTeamRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "teams parameter", - "enum": null, - "name": "teams", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Remove team restrictions of protected branch", - "scope": "repos", - "id": "removeProtectedBranchTeamRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "teams parameter", - "enum": null, - "name": "teams", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Get users with access to protected branch", - "scope": "repos", - "id": "getUsersWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get users with access to protected branch", - "scope": "repos", - "id": "listProtectedBranchUserRestrictions", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get users with access to protected branch", - "scope": "repos", - "id": "listUsersWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - } - ] - }, - { - "name": "Replace user restrictions of protected branch", - "scope": "repos", - "id": "replaceProtectedBranchUserRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "users parameter", - "enum": null, - "name": "users", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Add user restrictions of protected branch", - "scope": "repos", - "id": "addProtectedBranchUserRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "users parameter", - "enum": null, - "name": "users", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Remove user restrictions of protected branch", - "scope": "repos", - "id": "removeProtectedBranchUserRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "branch parameter", - "enum": null, - "name": "branch", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "users parameter", - "enum": null, - "name": "users", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Create a check run", - "scope": "checks", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-runs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the check. For example, \"code-coverage\".", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA of the commit.", - "enum": null, - "name": "head_sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL of the integrator's site that has the full details of the check.", - "enum": null, - "name": "details_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A reference for the run on the integrator's system.", - "enum": null, - "name": "external_id", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", - "enum": ["queued", "in_progress", "completed"], - "name": "status", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "started_at", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", - "neutral", - "cancelled", - "timed_out", - "action_required" - ], - "name": "conclusion", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "completed_at", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "output", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the check run.", - "enum": null, - "name": "output.title", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The summary of the check run. This parameter supports Markdown.", - "enum": null, - "name": "output.summary", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The details of the check run. This parameter supports Markdown.", - "enum": null, - "name": "output.text", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "output.annotations", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "enum": null, - "name": "output.annotations[].path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The start line of the annotation.", - "enum": null, - "name": "output.annotations[].start_line", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The end line of the annotation.", - "enum": null, - "name": "output.annotations[].end_line", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "output.annotations[].start_column", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "output.annotations[].end_column", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", - "enum": ["notice", "warning", "failure"], - "name": "output.annotations[].annotation_level", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "enum": null, - "name": "output.annotations[].message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "enum": null, - "name": "output.annotations[].title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Details about this annotation. The maximum size is 64 KB.", - "enum": null, - "name": "output.annotations[].raw_details", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "output.images", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The alternative text for the image.", - "enum": null, - "name": "output.images[].alt", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The full URL of the image.", - "enum": null, - "name": "output.images[].image_url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short image description.", - "enum": null, - "name": "output.images[].caption", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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).\"", - "enum": null, - "name": "actions", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "enum": null, - "name": "actions[].label", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "enum": null, - "name": "actions[].description", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "enum": null, - "name": "actions[].identifier", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update a check run", - "scope": "checks", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "check_run_id parameter", - "enum": null, - "name": "check_run_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the check. For example, \"code-coverage\".", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL of the integrator's site that has the full details of the check.", - "enum": null, - "name": "details_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A reference for the run on the integrator's system.", - "enum": null, - "name": "external_id", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "enum": null, - "name": "started_at", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", - "enum": ["queued", "in_progress", "completed"], - "name": "status", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", - "neutral", - "cancelled", - "timed_out", - "action_required" - ], - "name": "conclusion", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "completed_at", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "output", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required**.", - "enum": null, - "name": "output.title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can contain Markdown.", - "enum": null, - "name": "output.summary", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can contain Markdown.", - "enum": null, - "name": "output.text", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "output.annotations", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "enum": null, - "name": "output.annotations[].path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The start line of the annotation.", - "enum": null, - "name": "output.annotations[].start_line", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The end line of the annotation.", - "enum": null, - "name": "output.annotations[].end_line", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "output.annotations[].start_column", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "output.annotations[].end_column", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", - "enum": ["notice", "warning", "failure"], - "name": "output.annotations[].annotation_level", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "enum": null, - "name": "output.annotations[].message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "enum": null, - "name": "output.annotations[].title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Details about this annotation. The maximum size is 64 KB.", - "enum": null, - "name": "output.annotations[].raw_details", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "output.images", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The alternative text for the image.", - "enum": null, - "name": "output.images[].alt", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The full URL of the image.", - "enum": null, - "name": "output.images[].image_url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short image description.", - "enum": null, - "name": "output.images[].caption", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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).\"", - "enum": null, - "name": "actions", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "enum": null, - "name": "actions[].label", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "enum": null, - "name": "actions[].description", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "enum": null, - "name": "actions[].identifier", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a single check run", - "scope": "checks", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "check_run_id parameter", - "enum": null, - "name": "check_run_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List annotations for a check run", - "scope": "checks", - "id": "listAnnotations", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "check_run_id parameter", - "enum": null, - "name": "check_run_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a check suite", - "scope": "checks", - "id": "createSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The sha of the head commit.", - "enum": null, - "name": "head_sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "Set preferences for check suites on a repository", - "scope": "checks", - "id": "setSuitesPreferences", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-suites/preferences", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "auto_trigger_checks", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The `id` of the GitHub App.", - "enum": null, - "name": "auto_trigger_checks[].app_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "enum": null, - "name": "auto_trigger_checks[].setting", - "type": "boolean", - "required": true - } - ] - }, - { - "name": "Get a single check suite", - "scope": "checks", - "id": "getSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "check_suite_id parameter", - "enum": null, - "name": "check_suite_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List check runs in a check suite", - "scope": "checks", - "id": "listForSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "check_suite_id parameter", - "enum": null, - "name": "check_suite_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns check runs with the specified `name`.", - "enum": null, - "name": "check_name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", - "enum": ["queued", "in_progress", "completed"], - "name": "status", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", - "enum": ["latest", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Rerequest check suite", - "scope": "checks", - "id": "rerequestSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "check_suite_id parameter", - "enum": null, - "name": "check_suite_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List collaborators", - "scope": "repos", - "id": "listCollaborators", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": ["outside", "direct", "all"], - "name": "affiliation", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if a user is a collaborator", - "scope": "repos", - "id": "checkCollaborator", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add user as a collaborator", - "scope": "repos", - "id": "addCollaborator", - "method": "PUT", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "admin"], - "name": "permission", - "type": "string", - "required": false - } - ] - }, - { - "name": "Remove user as a collaborator", - "scope": "repos", - "id": "removeCollaborator", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Review a user's permission level", - "scope": "repos", - "id": "getCollaboratorPermissionLevel", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List commit comments for a repository", - "scope": "repos", - "id": "listCommitComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single commit comment", - "scope": "repos", - "id": "getCommitComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Update a commit comment", - "scope": "repos", - "id": "updateCommitComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the comment", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a commit comment", - "scope": "repos", - "id": "deleteCommitComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List reactions for a commit comment", - "scope": "reactions", - "id": "listForCommitComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create reaction for a commit comment", - "scope": "reactions", - "id": "createForCommitComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": true - } - ] - }, - { - "name": "List commits on a repository", - "scope": "repos", - "id": "listCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", - "enum": null, - "name": "sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Only commits containing this file path will be returned.", - "enum": null, - "name": "path", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "GitHub login or email address by which to filter by commit author.", - "enum": null, - "name": "author", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "until", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List branches for HEAD commit", - "scope": "repos", - "id": "listBranchesForHeadCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "commit_sha parameter", - "enum": null, - "name": "commit_sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "List comments for a single commit", - "scope": "repos", - "id": "listCommentsForCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "commit_sha parameter", - "enum": null, - "name": "commit_sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "commit_sha", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "ref", - "type": null, - "required": null - } - ] - }, - { - "name": "Create a commit comment", - "scope": "repos", - "id": "createCommitComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "commit_sha parameter", - "enum": null, - "name": "commit_sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Relative path of the file to comment on.", - "enum": null, - "name": "path", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Line index in the diff to comment on.", - "enum": null, - "name": "position", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "enum": null, - "name": "line", - "type": "integer", - "required": false - }, - { - "alias": "commit_sha", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "sha", - "type": null, - "required": null - } - ] - }, - { - "name": "List pull requests associated with commit", - "scope": "repos", - "id": "listPullRequestsAssociatedWithCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "commit_sha parameter", - "enum": null, - "name": "commit_sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single commit", - "scope": "repos", - "id": "getCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": "ref", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "sha", - "type": null, - "required": null - }, - { - "alias": "ref", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "commit_sha", - "type": null, - "required": null - } - ] - }, - { - "name": "List check runs for a specific ref", - "scope": "checks", - "id": "listForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns check runs with the specified `name`.", - "enum": null, - "name": "check_name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", - "enum": ["queued", "in_progress", "completed"], - "name": "status", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", - "enum": ["latest", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List check suites for a specific ref", - "scope": "checks", - "id": "listSuitesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters check suites by GitHub App `id`.", - "enum": null, - "name": "app_id", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/).", - "enum": null, - "name": "check_name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get the combined status for a specific ref", - "scope": "repos", - "id": "getCombinedStatusForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/status", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - } - ] - }, - { - "name": "List statuses for a specific ref", - "scope": "repos", - "id": "listStatusesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get the contents of a repository's code of conduct", - "scope": "codesOfConduct", - "id": "getForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/community/code_of_conduct", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Retrieve community profile metrics", - "scope": "repos", - "id": "retrieveCommunityProfileMetrics", - "method": "GET", - "url": "/repos/{owner}/{repo}/community/profile", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Compare two commits", - "scope": "repos", - "id": "compareCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/compare/{base}...{head}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "base parameter", - "enum": null, - "name": "base", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "head parameter", - "enum": null, - "name": "head", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get contents", - "scope": "repos", - "id": "getContents", - "method": "GET", - "url": "/repos/{owner}/{repo}/contents/{path}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "path parameter", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "enum": null, - "name": "ref", - "type": "string", - "required": false - } - ] - }, - { - "name": "Create or update a file", - "scope": "repos", - "id": "createOrUpdateFile", - "method": "PUT", - "url": "/repos/{owner}/{repo}/contents/{path}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "path parameter", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The commit message.", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new file content, using Base64 encoding.", - "enum": null, - "name": "content", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "enum": null, - "name": "sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "enum": null, - "name": "branch", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The person that committed the file. Default: the authenticated user.", - "enum": null, - "name": "committer", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "committer.name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "committer.email", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", - "enum": null, - "name": "author", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "author.name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "author.email", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create or update a file", - "scope": "repos", - "id": "createFile", - "method": "PUT", - "url": "/repos/{owner}/{repo}/contents/{path}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "path parameter", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The commit message.", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new file content, using Base64 encoding.", - "enum": null, - "name": "content", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "enum": null, - "name": "sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "enum": null, - "name": "branch", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The person that committed the file. Default: the authenticated user.", - "enum": null, - "name": "committer", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "committer.name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "committer.email", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", - "enum": null, - "name": "author", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "author.name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "author.email", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create or update a file", - "scope": "repos", - "id": "updateFile", - "method": "PUT", - "url": "/repos/{owner}/{repo}/contents/{path}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "path parameter", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The commit message.", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new file content, using Base64 encoding.", - "enum": null, - "name": "content", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "enum": null, - "name": "sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "enum": null, - "name": "branch", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The person that committed the file. Default: the authenticated user.", - "enum": null, - "name": "committer", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "committer.name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "committer.email", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", - "enum": null, - "name": "author", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "author.name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "enum": null, - "name": "author.email", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a file", - "scope": "repos", - "id": "deleteFile", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/contents/{path}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "path parameter", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The commit message.", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The blob SHA of the file being replaced.", - "enum": null, - "name": "sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "enum": null, - "name": "branch", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "object containing information about the committer.", - "enum": null, - "name": "committer", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author (or committer) of the commit", - "enum": null, - "name": "committer.name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author (or committer) of the commit", - "enum": null, - "name": "committer.email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "object containing information about the author.", - "enum": null, - "name": "author", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author (or committer) of the commit", - "enum": null, - "name": "author.name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author (or committer) of the commit", - "enum": null, - "name": "author.email", - "type": "string", - "required": false - } - ] - }, - { - "name": "List contributors", - "scope": "repos", - "id": "listContributors", - "method": "GET", - "url": "/repos/{owner}/{repo}/contributors", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Set to `1` or `true` to include anonymous contributors in results.", - "enum": null, - "name": "anon", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List deployments", - "scope": "repos", - "id": "listDeployments", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA recorded at creation time.", - "enum": null, - "name": "sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the ref. This can be a branch, tag, or SHA.", - "enum": null, - "name": "ref", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", - "enum": null, - "name": "task", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", - "enum": null, - "name": "environment", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a deployment", - "scope": "repos", - "id": "createDeployment", - "method": "POST", - "url": "/repos/{owner}/{repo}/deployments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The ref to deploy. This can be a branch, tag, or SHA.", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", - "enum": null, - "name": "task", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", - "enum": null, - "name": "auto_merge", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "required_contexts", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "JSON payload with extra information about the deployment.", - "enum": null, - "name": "payload", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", - "enum": null, - "name": "environment", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Short description of the deployment.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "transient_environment", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "production_environment", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a single deployment", - "scope": "repos", - "id": "getDeployment", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "deployment_id parameter", - "enum": null, - "name": "deployment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List deployment statuses", - "scope": "repos", - "id": "listDeploymentStatuses", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "deployment_id parameter", - "enum": null, - "name": "deployment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a deployment status", - "scope": "repos", - "id": "createDeploymentStatus", - "method": "POST", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "deployment_id parameter", - "enum": null, - "name": "deployment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", - "inactive", - "in_progress", - "queued", - "pending", - "success" - ], - "name": "state", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "target_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "log_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the status. The maximum description length is 140 characters.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "qa"], - "name": "environment", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "environment_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "auto_inactive", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a single deployment status", - "scope": "repos", - "id": "getDeploymentStatus", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "deployment_id parameter", - "enum": null, - "name": "deployment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "status_id parameter", - "enum": null, - "name": "status_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Create a repository dispatch event", - "scope": "repos", - "id": "createDispatchEvent", - "method": "POST", - "url": "/repos/{owner}/{repo}/dispatches", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required:** A custom webhook event name.", - "enum": null, - "name": "event_type", - "type": "string", - "required": false - } - ] - }, - { - "name": "List downloads for a repository", - "scope": "repos", - "id": "listDownloads", - "method": "GET", - "url": "/repos/{owner}/{repo}/downloads", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single download", - "scope": "repos", - "id": "getDownload", - "method": "GET", - "url": "/repos/{owner}/{repo}/downloads/{download_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "download_id parameter", - "enum": null, - "name": "download_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete a download", - "scope": "repos", - "id": "deleteDownload", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/downloads/{download_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "download_id parameter", - "enum": null, - "name": "download_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List repository events", - "scope": "activity", - "id": "listRepoEvents", - "method": "GET", - "url": "/repos/{owner}/{repo}/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List forks", - "scope": "repos", - "id": "listForks", - "method": "GET", - "url": "/repos/{owner}/{repo}/forks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", - "enum": ["newest", "oldest", "stargazers"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a fork", - "scope": "repos", - "id": "createFork", - "method": "POST", - "url": "/repos/{owner}/{repo}/forks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Optional parameter to specify the organization name if forking into an organization.", - "enum": null, - "name": "organization", - "type": "string", - "required": false - } - ] - }, - { - "name": "Create a blob", - "scope": "git", - "id": "createBlob", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/blobs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new blob's content.", - "enum": null, - "name": "content", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "enum": null, - "name": "encoding", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a blob", - "scope": "git", - "id": "getBlob", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "file_sha parameter", - "enum": null, - "name": "file_sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create a commit", - "scope": "git", - "id": "createCommit", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/commits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The commit message", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA of the tree object this commit points to", - "enum": null, - "name": "tree", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "parents", - "type": "string[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "author", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author (or committer) of the commit", - "enum": null, - "name": "author.name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author (or committer) of the commit", - "enum": null, - "name": "author.email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "author.date", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "committer", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author (or committer) of the commit", - "enum": null, - "name": "committer.name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author (or committer) of the commit", - "enum": null, - "name": "committer.email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "committer.date", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "signature", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a commit", - "scope": "git", - "id": "getCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "commit_sha parameter", - "enum": null, - "name": "commit_sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "List matching references", - "scope": "git", - "id": "listMatchingRefs", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single reference", - "scope": "git", - "id": "getRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/ref/{ref}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create a reference", - "scope": "git", - "id": "createRef", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/refs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA1 value for this reference.", - "enum": null, - "name": "sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update a reference", - "scope": "git", - "id": "updateRef", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/git/refs/{ref}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA1 value to set this reference to", - "enum": null, - "name": "sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "force", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a reference", - "scope": "git", - "id": "deleteRef", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/git/refs/{ref}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create a tag object", - "scope": "git", - "id": "createTag", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/tags", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "enum": null, - "name": "tag", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The tag message.", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The SHA of the git object this is tagging.", - "enum": null, - "name": "object", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "blob"], - "name": "type", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An object with information about the individual creating the tag.", - "enum": null, - "name": "tagger", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the author of the tag", - "enum": null, - "name": "tagger.name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The email of the author of the tag", - "enum": null, - "name": "tagger.email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "tagger.date", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a tag", - "scope": "git", - "id": "getTag", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "tag_sha parameter", - "enum": null, - "name": "tag_sha", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create a tree", - "scope": "git", - "id": "createTree", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/trees", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", - "enum": null, - "name": "tree", - "type": "object[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The file referenced in the tree.", - "enum": null, - "name": "tree[].path", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "040000", "160000", "120000"], - "name": "tree[].mode", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `blob`, `tree`, or `commit`.", - "enum": ["blob", "tree", "commit"], - "name": "tree[].type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "tree[].sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "tree[].content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "base_tree", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a tree", - "scope": "git", - "id": "getTree", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "tree_sha parameter", - "enum": null, - "name": "tree_sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "recursive parameter", - "enum": ["1"], - "name": "recursive", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List hooks", - "scope": "repos", - "id": "listHooks", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a hook", - "scope": "repos", - "id": "createHook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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).", - "enum": null, - "name": "config", - "type": "object", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL to which the payloads will be delivered.", - "enum": null, - "name": "config.url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "enum": null, - "name": "config.content_type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "config.secret", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.**", - "enum": null, - "name": "config.insecure_ssl", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", - "enum": null, - "name": "events", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "enum": null, - "name": "active", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get single hook", - "scope": "repos", - "id": "getHook", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a hook", - "scope": "repos", - "id": "updateHook", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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).", - "enum": null, - "name": "config", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL to which the payloads will be delivered.", - "enum": null, - "name": "config.url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "enum": null, - "name": "config.content_type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "config.secret", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.**", - "enum": null, - "name": "config.insecure_ssl", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", - "enum": null, - "name": "events", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "enum": null, - "name": "add_events", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "enum": null, - "name": "remove_events", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "enum": null, - "name": "active", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a hook", - "scope": "repos", - "id": "deleteHook", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Ping a hook", - "scope": "repos", - "id": "pingHook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Test a push hook", - "scope": "repos", - "id": "testPushHook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "hook_id parameter", - "enum": null, - "name": "hook_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Start an import", - "scope": "migrations", - "id": "startImport", - "method": "PUT", - "url": "/repos/{owner}/{repo}/import", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The URL of the originating repository.", - "enum": null, - "name": "vcs_url", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "mercurial", "tfvc"], - "name": "vcs", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If authentication is required, the username to provide to `vcs_url`.", - "enum": null, - "name": "vcs_username", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If authentication is required, the password to provide to `vcs_url`.", - "enum": null, - "name": "vcs_password", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "For a tfvc import, the name of the project that is being imported.", - "enum": null, - "name": "tfvc_project", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get import progress", - "scope": "migrations", - "id": "getImportProgress", - "method": "GET", - "url": "/repos/{owner}/{repo}/import", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update existing import", - "scope": "migrations", - "id": "updateImport", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/import", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The username to provide to the originating repository.", - "enum": null, - "name": "vcs_username", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The password to provide to the originating repository.", - "enum": null, - "name": "vcs_password", - "type": "string", - "required": false - } - ] - }, - { - "name": "Cancel an import", - "scope": "migrations", - "id": "cancelImport", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/import", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get commit authors", - "scope": "migrations", - "id": "getCommitAuthors", - "method": "GET", - "url": "/repos/{owner}/{repo}/import/authors", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "since", - "type": "string", - "required": false - } - ] - }, - { - "name": "Map a commit author", - "scope": "migrations", - "id": "mapCommitAuthor", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/import/authors/{author_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "author_id parameter", - "enum": null, - "name": "author_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new Git author email.", - "enum": null, - "name": "email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new Git author name.", - "enum": null, - "name": "name", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get large files", - "scope": "migrations", - "id": "getLargeFiles", - "method": "GET", - "url": "/repos/{owner}/{repo}/import/large_files", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Set Git LFS preference", - "scope": "migrations", - "id": "setLfsPreference", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/import/lfs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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"], - "name": "use_lfs", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a repository installation", - "scope": "apps", - "id": "getRepoInstallation", - "method": "GET", - "url": "/repos/{owner}/{repo}/installation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a repository installation", - "scope": "apps", - "id": "findRepoInstallation", - "method": "GET", - "url": "/repos/{owner}/{repo}/installation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get interaction restrictions for a repository", - "scope": "interactions", - "id": "getRestrictionsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/interaction-limits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add or update interaction restrictions for a repository", - "scope": "interactions", - "id": "addOrUpdateRestrictionsForRepo", - "method": "PUT", - "url": "/repos/{owner}/{repo}/interaction-limits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "collaborators_only"], - "name": "limit", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove interaction restrictions for a repository", - "scope": "interactions", - "id": "removeRestrictionsForRepo", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/interaction-limits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List invitations for a repository", - "scope": "repos", - "id": "listInvitations", - "method": "GET", - "url": "/repos/{owner}/{repo}/invitations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Delete a repository invitation", - "scope": "repos", - "id": "deleteInvitation", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "invitation_id parameter", - "enum": null, - "name": "invitation_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Update a repository invitation", - "scope": "repos", - "id": "updateInvitation", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "invitation_id parameter", - "enum": null, - "name": "invitation_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.", - "enum": ["read", "write", "admin"], - "name": "permissions", - "type": "string", - "required": false - } - ] - }, - { - "name": "List issues for a repository", - "scope": "issues", - "id": "listForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "milestone", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", - "enum": null, - "name": "assignee", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The user that created the issue.", - "enum": null, - "name": "creator", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A user that's mentioned in the issue.", - "enum": null, - "name": "mentioned", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "enum": null, - "name": "labels", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "enum": ["created", "updated", "comments"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The direction of the sort. Can be either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create an issue", - "scope": "issues", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the issue.", - "enum": null, - "name": "title", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the issue.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.**_", - "enum": null, - "name": "assignee", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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._", - "enum": null, - "name": "milestone", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "enum": null, - "name": "labels", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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._", - "enum": null, - "name": "assignees", - "type": "string[]", - "required": false - } - ] - }, - { - "name": "List comments in a repository", - "scope": "issues", - "id": "listCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `created` or `updated`.", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a single comment", - "scope": "issues", - "id": "getComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Edit a comment", - "scope": "issues", - "id": "updateComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a comment", - "scope": "issues", - "id": "deleteComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List reactions for an issue comment", - "scope": "reactions", - "id": "listForIssueComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create reaction for an issue comment", - "scope": "reactions", - "id": "createForIssueComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": true - } - ] - }, - { - "name": "List events for a repository", - "scope": "issues", - "id": "listEventsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single event", - "scope": "issues", - "id": "getEvent", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/events/{event_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "event_id parameter", - "enum": null, - "name": "event_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Get a single issue", - "scope": "issues", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Edit an issue", - "scope": "issues", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/issues/{issue_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the issue.", - "enum": null, - "name": "title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the issue.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "enum": null, - "name": "assignee", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "State of the issue. Either `open` or `closed`.", - "enum": ["open", "closed"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": true, - "deprecated": null, - "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._", - "enum": null, - "name": "milestone", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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._", - "enum": null, - "name": "labels", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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._", - "enum": null, - "name": "assignees", - "type": "string[]", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Add assignees to an issue", - "scope": "issues", - "id": "addAssignees", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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._", - "enum": null, - "name": "assignees", - "type": "string[]", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Remove assignees from an issue", - "scope": "issues", - "id": "removeAssignees", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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._", - "enum": null, - "name": "assignees", - "type": "string[]", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List comments on an issue", - "scope": "issues", - "id": "listComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Create a comment", - "scope": "issues", - "id": "createComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List events for an issue", - "scope": "issues", - "id": "listEvents", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List labels on an issue", - "scope": "issues", - "id": "listLabelsOnIssue", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Add labels to an issue", - "scope": "issues", - "id": "addLabels", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "labels", - "type": "string[]", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Replace all labels for an issue", - "scope": "issues", - "id": "replaceLabels", - "method": "PUT", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "labels", - "type": "string[]", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Remove all labels from an issue", - "scope": "issues", - "id": "removeLabels", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Remove a label from an issue", - "scope": "issues", - "id": "removeLabel", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "name parameter", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Lock an issue", - "scope": "issues", - "id": "lock", - "method": "PUT", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "resolved", "spam"], - "name": "lock_reason", - "type": "string", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Unlock an issue", - "scope": "issues", - "id": "unlock", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List reactions for an issue", - "scope": "reactions", - "id": "listForIssue", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Create reaction for an issue", - "scope": "reactions", - "id": "createForIssue", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": true - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List events for an issue", - "scope": "issues", - "id": "listEventsForTimeline", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "issue_number parameter", - "enum": null, - "name": "issue_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "issue_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List deploy keys", - "scope": "repos", - "id": "listDeployKeys", - "method": "GET", - "url": "/repos/{owner}/{repo}/keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Add a new deploy key", - "scope": "repos", - "id": "addDeployKey", - "method": "POST", - "url": "/repos/{owner}/{repo}/keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A name for the key.", - "enum": null, - "name": "title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the key.", - "enum": null, - "name": "key", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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/).\"", - "enum": null, - "name": "read_only", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a deploy key", - "scope": "repos", - "id": "getDeployKey", - "method": "GET", - "url": "/repos/{owner}/{repo}/keys/{key_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "key_id parameter", - "enum": null, - "name": "key_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Remove a deploy key", - "scope": "repos", - "id": "removeDeployKey", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/keys/{key_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "key_id parameter", - "enum": null, - "name": "key_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List all labels for this repository", - "scope": "issues", - "id": "listLabelsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a label", - "scope": "issues", - "id": "createLabel", - "method": "POST", - "url": "/repos/{owner}/{repo}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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/).", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "enum": null, - "name": "color", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the label.", - "enum": null, - "name": "description", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a single label", - "scope": "issues", - "id": "getLabel", - "method": "GET", - "url": "/repos/{owner}/{repo}/labels/{name}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "name parameter", - "enum": null, - "name": "name", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update a label", - "scope": "issues", - "id": "updateLabel", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/labels/{name}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "name parameter", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", - "enum": null, - "name": "new_name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "enum": null, - "name": "color", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the label.", - "enum": null, - "name": "description", - "type": "string", - "required": false - } - ] - }, - { - "name": "Delete a label", - "scope": "issues", - "id": "deleteLabel", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/labels/{name}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "name parameter", - "enum": null, - "name": "name", - "type": "string", - "required": true - } - ] - }, - { - "name": "List languages", - "scope": "repos", - "id": "listLanguages", - "method": "GET", - "url": "/repos/{owner}/{repo}/languages", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get the contents of a repository's license", - "scope": "licenses", - "id": "getForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/license", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Perform a merge", - "scope": "repos", - "id": "merge", - "method": "POST", - "url": "/repos/{owner}/{repo}/merges", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the base branch that the head will be merged into.", - "enum": null, - "name": "base", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The head to merge. This can be a branch name or a commit SHA1.", - "enum": null, - "name": "head", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "enum": null, - "name": "commit_message", - "type": "string", - "required": false - } - ] - }, - { - "name": "List milestones for a repository", - "scope": "issues", - "id": "listMilestonesForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The state of the milestone. Either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "What to sort results by. Either `due_on` or `completeness`.", - "enum": ["due_on", "completeness"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The direction of the sort. Either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a milestone", - "scope": "issues", - "id": "createMilestone", - "method": "POST", - "url": "/repos/{owner}/{repo}/milestones", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the milestone.", - "enum": null, - "name": "title", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The state of the milestone. Either `open` or `closed`.", - "enum": ["open", "closed"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A description of the milestone.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "due_on", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a single milestone", - "scope": "issues", - "id": "getMilestone", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "milestone_number parameter", - "enum": null, - "name": "milestone_number", - "type": "integer", - "required": true - }, - { - "alias": "milestone_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Update a milestone", - "scope": "issues", - "id": "updateMilestone", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "milestone_number parameter", - "enum": null, - "name": "milestone_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the milestone.", - "enum": null, - "name": "title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The state of the milestone. Either `open` or `closed`.", - "enum": ["open", "closed"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A description of the milestone.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "due_on", - "type": "string", - "required": false - }, - { - "alias": "milestone_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Delete a milestone", - "scope": "issues", - "id": "deleteMilestone", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "milestone_number parameter", - "enum": null, - "name": "milestone_number", - "type": "integer", - "required": true - }, - { - "alias": "milestone_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Get labels for every issue in a milestone", - "scope": "issues", - "id": "listLabelsForMilestone", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "milestone_number parameter", - "enum": null, - "name": "milestone_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "milestone_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List your notifications in a repository", - "scope": "activity", - "id": "listNotificationsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/notifications", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If `true`, show notifications marked as read.", - "enum": null, - "name": "all", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "enum": null, - "name": "participating", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "before", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Mark notifications as read in a repository", - "scope": "activity", - "id": "markNotificationsAsReadForRepo", - "method": "PUT", - "url": "/repos/{owner}/{repo}/notifications", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "enum": null, - "name": "last_read_at", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get information about a Pages site", - "scope": "repos", - "id": "getPages", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Enable a Pages site", - "scope": "repos", - "id": "enablePagesSite", - "method": "POST", - "url": "/repos/{owner}/{repo}/pages", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "source parameter", - "enum": null, - "name": "source", - "type": "object", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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"], - "name": "source.branch", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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 `/`.", - "enum": null, - "name": "source.path", - "type": "string", - "required": false - } - ] - }, - { - "name": "Disable a Pages site", - "scope": "repos", - "id": "disablePagesSite", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pages", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Update information about a Pages site", - "scope": "repos", - "id": "updateInformationAboutPagesSite", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pages", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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/).\"", - "enum": null, - "name": "cname", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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\"", "\"master /docs\""], - "name": "source", - "type": "string", - "required": false - } - ] - }, - { - "name": "Request a page build", - "scope": "repos", - "id": "requestPageBuild", - "method": "POST", - "url": "/repos/{owner}/{repo}/pages/builds", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List Pages builds", - "scope": "repos", - "id": "listPagesBuilds", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get latest Pages build", - "scope": "repos", - "id": "getLatestPagesBuild", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds/latest", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a specific Pages build", - "scope": "repos", - "id": "getPagesBuild", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "build_id parameter", - "enum": null, - "name": "build_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List repository projects", - "scope": "projects", - "id": "listForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a repository project", - "scope": "projects", - "id": "createForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the project.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the project.", - "enum": null, - "name": "body", - "type": "string", - "required": false - } - ] - }, - { - "name": "List pull requests", - "scope": "pulls", - "id": "list", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `open`, `closed`, or `all` to filter by state.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "head", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Filter pulls by base branch name. Example: `gh-pages`.", - "enum": null, - "name": "base", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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).", - "enum": ["created", "updated", "popularity", "long-running"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a pull request", - "scope": "pulls", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the new pull request.", - "enum": null, - "name": "title", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "head", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "base", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the pull request.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "maintainer_can_modify", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "draft", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "List comments in a repository", - "scope": "pulls", - "id": "listCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be either `created` or `updated` comments.", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single comment", - "scope": "pulls", - "id": "getComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a comment", - "scope": "pulls", - "id": "updateComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The text of the reply to the review comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a comment", - "scope": "pulls", - "id": "deleteComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List reactions for a pull request review comment", - "scope": "reactions", - "id": "listForPullRequestReviewComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create reaction for a pull request review comment", - "scope": "reactions", - "id": "createForPullRequestReviewComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a single pull request", - "scope": "pulls", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Update a pull request", - "scope": "pulls", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The title of the pull request.", - "enum": null, - "name": "title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The contents of the pull request.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": ["open", "closed"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "base", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "maintainer_can_modify", - "type": "boolean", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List comments on a pull request", - "scope": "pulls", - "id": "listComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be either `created` or `updated` comments.", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Create a comment", - "scope": "pulls", - "id": "createComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The text of the review comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "commit_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The relative path to the file that necessitates a comment.", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "enum": null, - "name": "position", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "enum": ["LEFT", "RIGHT"], - "name": "side", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "enum": null, - "name": "line", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "enum": null, - "name": "start_line", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "enum": ["LEFT", "RIGHT", "side"], - "name": "start_side", - "type": "string", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - }, - { - "alias": null, - "allowNull": null, - "deprecated": true, - "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", - "enum": null, - "name": "in_reply_to", - "type": "integer", - "required": null - } - ] - }, - { - "name": "Create a comment", - "scope": "pulls", - "id": "createCommentReply", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The text of the review comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "commit_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The relative path to the file that necessitates a comment.", - "enum": null, - "name": "path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "enum": null, - "name": "position", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "enum": ["LEFT", "RIGHT"], - "name": "side", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "enum": null, - "name": "line", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "enum": null, - "name": "start_line", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "enum": ["LEFT", "RIGHT", "side"], - "name": "start_side", - "type": "string", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - }, - { - "alias": null, - "allowNull": null, - "deprecated": true, - "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", - "enum": null, - "name": "in_reply_to", - "type": "integer", - "required": null - } - ] - }, - { - "name": "Create a review comment reply", - "scope": "pulls", - "id": "createReviewCommentReply", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_id parameter", - "enum": null, - "name": "comment_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The text of the review comment.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "List commits on a pull request", - "scope": "pulls", - "id": "listCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List pull requests files", - "scope": "pulls", - "id": "listFiles", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Get if a pull request has been merged", - "scope": "pulls", - "id": "checkIfMerged", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Merge a pull request (Merge Button)", - "scope": "pulls", - "id": "merge", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Title for the automatic commit message.", - "enum": null, - "name": "commit_title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Extra detail to append to automatic commit message.", - "enum": null, - "name": "commit_message", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "SHA that pull request head must match to allow merge.", - "enum": null, - "name": "sha", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "enum": ["merge", "squash", "rebase"], - "name": "merge_method", - "type": "string", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List review requests", - "scope": "pulls", - "id": "listReviewRequests", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Create a review request", - "scope": "pulls", - "id": "createReviewRequest", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An array of user `login`s that will be requested.", - "enum": null, - "name": "reviewers", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An array of team `slug`s that will be requested.", - "enum": null, - "name": "team_reviewers", - "type": "string[]", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Delete a review request", - "scope": "pulls", - "id": "deleteReviewRequest", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An array of user `login`s that will be removed.", - "enum": null, - "name": "reviewers", - "type": "string[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An array of team `slug`s that will be removed.", - "enum": null, - "name": "team_reviewers", - "type": "string[]", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "List reviews on a pull request", - "scope": "pulls", - "id": "listReviews", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Create a pull request review", - "scope": "pulls", - "id": "createReview", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "commit_id", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "COMMENT"], - "name": "event", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", - "enum": null, - "name": "comments", - "type": "object[]", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The relative path to the file that necessitates a review comment.", - "enum": null, - "name": "comments[].path", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "comments[].position", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Text of the review comment.", - "enum": null, - "name": "comments[].body", - "type": "string", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Get a single review", - "scope": "pulls", - "id": "getReview", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "review_id parameter", - "enum": null, - "name": "review_id", - "type": "integer", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Delete a pending review", - "scope": "pulls", - "id": "deletePendingReview", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "review_id parameter", - "enum": null, - "name": "review_id", - "type": "integer", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Update a pull request review", - "scope": "pulls", - "id": "updateReview", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "review_id parameter", - "enum": null, - "name": "review_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The body text of the pull request review.", - "enum": null, - "name": "body", - "type": "string", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Get comments for a single review", - "scope": "pulls", - "id": "getCommentsForReview", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "review_id parameter", - "enum": null, - "name": "review_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Dismiss a pull request review", - "scope": "pulls", - "id": "dismissReview", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "review_id parameter", - "enum": null, - "name": "review_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The message for the pull request review dismissal", - "enum": null, - "name": "message", - "type": "string", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Submit a pull request review", - "scope": "pulls", - "id": "submitReview", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "review_id parameter", - "enum": null, - "name": "review_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The body text of the pull request review", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "COMMENT"], - "name": "event", - "type": "string", - "required": true - }, - { - "alias": "pull_number", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "number", - "type": null, - "required": null - } - ] - }, - { - "name": "Update a pull request branch", - "scope": "pulls", - "id": "updateBranch", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "pull_number parameter", - "enum": null, - "name": "pull_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "expected_head_sha", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get the README", - "scope": "repos", - "id": "getReadme", - "method": "GET", - "url": "/repos/{owner}/{repo}/readme", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "enum": null, - "name": "ref", - "type": "string", - "required": false - } - ] - }, - { - "name": "List releases for a repository", - "scope": "repos", - "id": "listReleases", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a release", - "scope": "repos", - "id": "createRelease", - "method": "POST", - "url": "/repos/{owner}/{repo}/releases", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the tag.", - "enum": null, - "name": "tag_name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`).", - "enum": null, - "name": "target_commitish", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the release.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Text describing the contents of the tag.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "enum": null, - "name": "draft", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "enum": null, - "name": "prerelease", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a single release asset", - "scope": "repos", - "id": "getReleaseAsset", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "asset_id parameter", - "enum": null, - "name": "asset_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a release asset", - "scope": "repos", - "id": "updateReleaseAsset", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "asset_id parameter", - "enum": null, - "name": "asset_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The file name of the asset.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An alternate short description of the asset. Used in place of the filename.", - "enum": null, - "name": "label", - "type": "string", - "required": false - } - ] - }, - { - "name": "Delete a release asset", - "scope": "repos", - "id": "deleteReleaseAsset", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "asset_id parameter", - "enum": null, - "name": "asset_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Get the latest release", - "scope": "repos", - "id": "getLatestRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/latest", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a release by tag name", - "scope": "repos", - "id": "getReleaseByTag", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/tags/{tag}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "tag parameter", - "enum": null, - "name": "tag", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a single release", - "scope": "repos", - "id": "getRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "release_id parameter", - "enum": null, - "name": "release_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a release", - "scope": "repos", - "id": "updateRelease", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "release_id parameter", - "enum": null, - "name": "release_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the tag.", - "enum": null, - "name": "tag_name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`).", - "enum": null, - "name": "target_commitish", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the release.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Text describing the contents of the tag.", - "enum": null, - "name": "body", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "`true` makes the release a draft, and `false` publishes the release.", - "enum": null, - "name": "draft", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "enum": null, - "name": "prerelease", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a release", - "scope": "repos", - "id": "deleteRelease", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "release_id parameter", - "enum": null, - "name": "release_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List assets for a release", - "scope": "repos", - "id": "listAssetsForRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "release_id parameter", - "enum": null, - "name": "release_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List Stargazers", - "scope": "activity", - "id": "listStargazersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/stargazers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get the number of additions and deletions per week", - "scope": "repos", - "id": "getCodeFrequencyStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/code_frequency", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get the last year of commit activity data", - "scope": "repos", - "id": "getCommitActivityStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/commit_activity", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get contributors list with additions, deletions, and commit counts", - "scope": "repos", - "id": "getContributorsStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/contributors", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get the weekly commit count for the repository owner and everyone else", - "scope": "repos", - "id": "getParticipationStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/participation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get the number of commits per hour in each day", - "scope": "repos", - "id": "getPunchCardStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/punch_card", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create a status", - "scope": "repos", - "id": "createStatus", - "method": "POST", - "url": "/repos/{owner}/{repo}/statuses/{sha}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "sha parameter", - "enum": null, - "name": "sha", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", - "enum": ["error", "failure", "pending", "success"], - "name": "state", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`", - "enum": null, - "name": "target_url", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the status.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A string label to differentiate this status from the status of other systems.", - "enum": null, - "name": "context", - "type": "string", - "required": false - } - ] - }, - { - "name": "List watchers", - "scope": "activity", - "id": "listWatchersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/subscribers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a Repository Subscription", - "scope": "activity", - "id": "getRepoSubscription", - "method": "GET", - "url": "/repos/{owner}/{repo}/subscription", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Set a Repository Subscription", - "scope": "activity", - "id": "setRepoSubscription", - "method": "PUT", - "url": "/repos/{owner}/{repo}/subscription", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines if notifications should be received from this repository.", - "enum": null, - "name": "subscribed", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Determines if all notifications should be blocked from this repository.", - "enum": null, - "name": "ignored", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Delete a Repository Subscription", - "scope": "activity", - "id": "deleteRepoSubscription", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/subscription", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List tags", - "scope": "repos", - "id": "listTags", - "method": "GET", - "url": "/repos/{owner}/{repo}/tags", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List teams", - "scope": "repos", - "id": "listTeams", - "method": "GET", - "url": "/repos/{owner}/{repo}/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List all topics for a repository", - "scope": "repos", - "id": "listTopics", - "method": "GET", - "url": "/repos/{owner}/{repo}/topics", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Replace all topics for a repository", - "scope": "repos", - "id": "replaceTopics", - "method": "PUT", - "url": "/repos/{owner}/{repo}/topics", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "names", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Clones", - "scope": "repos", - "id": "getClones", - "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/clones", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Must be one of: `day`, `week`.", - "enum": ["day", "week"], - "name": "per", - "type": "string", - "required": false - } - ] - }, - { - "name": "List paths", - "scope": "repos", - "id": "getTopPaths", - "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/popular/paths", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List referrers", - "scope": "repos", - "id": "getTopReferrers", - "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/popular/referrers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Views", - "scope": "repos", - "id": "getViews", - "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/views", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Must be one of: `day`, `week`.", - "enum": ["day", "week"], - "name": "per", - "type": "string", - "required": false - } - ] - }, - { - "name": "Transfer a repository", - "scope": "repos", - "id": "transfer", - "method": "POST", - "url": "/repos/{owner}/{repo}/transfer", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "**Required:** The username or organization name the repository will be transferred to.", - "enum": null, - "name": "new_owner", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "enum": null, - "name": "team_ids", - "type": "integer[]", - "required": false - } - ] - }, - { - "name": "Check if vulnerability alerts are enabled for a repository", - "scope": "repos", - "id": "checkVulnerabilityAlerts", - "method": "GET", - "url": "/repos/{owner}/{repo}/vulnerability-alerts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Enable vulnerability alerts", - "scope": "repos", - "id": "enableVulnerabilityAlerts", - "method": "PUT", - "url": "/repos/{owner}/{repo}/vulnerability-alerts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Disable vulnerability alerts", - "scope": "repos", - "id": "disableVulnerabilityAlerts", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/vulnerability-alerts", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get archive link", - "scope": "repos", - "id": "getArchiveLink", - "method": "GET", - "url": "/repos/{owner}/{repo}/{archive_format}/{ref}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "archive_format parameter", - "enum": null, - "name": "archive_format", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ref parameter", - "enum": null, - "name": "ref", - "type": "string", - "required": true - } - ] - }, - { - "name": "Create repository using a repository template", - "scope": "repos", - "id": "createUsingTemplate", - "method": "POST", - "url": "/repos/{template_owner}/{template_repo}/generate", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "template_owner parameter", - "enum": null, - "name": "template_owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "template_repo parameter", - "enum": null, - "name": "template_repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "owner", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the new repository.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the new repository.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to create a new private repository or `false` to create a new public one.", - "enum": null, - "name": "private", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "List all public repositories", - "scope": "repos", - "id": "listPublic", - "method": "GET", - "url": "/repositories", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The integer ID of the last Repository that you've seen.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a list of provisioned identities", - "scope": "scim", - "id": "listProvisionedIdentities", - "method": "GET", - "url": "/scim/v2/organizations/{org}/Users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Used for pagination: the index of the first result to return.", - "enum": null, - "name": "startIndex", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Used for pagination: the number of results to return.", - "enum": null, - "name": "count", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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\\\"`.", - "enum": null, - "name": "filter", - "type": "string", - "required": false - } - ] - }, - { - "name": "Provision and invite users", - "scope": "scim", - "id": "provisionAndInviteUsers", - "method": "POST", - "url": "/scim/v2/organizations/{org}/Users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Provision and invite users", - "scope": "scim", - "id": "provisionInviteUsers", - "method": "POST", - "url": "/scim/v2/organizations/{org}/Users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get provisioning details for a single user", - "scope": "scim", - "id": "getProvisioningDetailsForUser", - "method": "GET", - "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "scim_user_id parameter", - "enum": null, - "name": "scim_user_id", - "type": "integer", - "required": true - }, - { - "alias": "scim_user_id", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "external_identity_guid", - "type": null, - "required": null - } - ] - }, - { - "name": "Replace a provisioned user's information", - "scope": "scim", - "id": "replaceProvisionedUserInformation", - "method": "PUT", - "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "scim_user_id parameter", - "enum": null, - "name": "scim_user_id", - "type": "integer", - "required": true - }, - { - "alias": "scim_user_id", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "external_identity_guid", - "type": null, - "required": null - } - ] - }, - { - "name": "Replace a provisioned user's information", - "scope": "scim", - "id": "updateProvisionedOrgMembership", - "method": "PUT", - "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "scim_user_id parameter", - "enum": null, - "name": "scim_user_id", - "type": "integer", - "required": true - }, - { - "alias": "scim_user_id", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "external_identity_guid", - "type": null, - "required": null - } - ] - }, - { - "name": "Update a user attribute", - "scope": "scim", - "id": "updateUserAttribute", - "method": "PATCH", - "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "scim_user_id parameter", - "enum": null, - "name": "scim_user_id", - "type": "integer", - "required": true - }, - { - "alias": "scim_user_id", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "external_identity_guid", - "type": null, - "required": null - } - ] - }, - { - "name": "Remove a user from the organization", - "scope": "scim", - "id": "removeUserFromOrg", - "method": "DELETE", - "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "scim_user_id parameter", - "enum": null, - "name": "scim_user_id", - "type": "integer", - "required": true - }, - { - "alias": "scim_user_id", - "allowNull": null, - "deprecated": true, - "description": null, - "enum": null, - "name": "external_identity_guid", - "type": null, - "required": null - } - ] - }, - { - "name": "Search code", - "scope": "search", - "id": "code", - "method": "GET", - "url": "/search/code", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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)", - "enum": ["indexed"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Search commits", - "scope": "search", - "id": "commits", - "method": "GET", - "url": "/search/commits", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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)", - "enum": ["author-date", "committer-date"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Search issues and pull requests", - "scope": "search", - "id": "issuesAndPullRequests", - "method": "GET", - "url": "/search/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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)", - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Search issues and pull requests", - "scope": "search", - "id": "issues", - "method": "GET", - "url": "/search/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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)", - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Search labels", - "scope": "search", - "id": "labels", - "method": "GET", - "url": "/search/labels", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The id of the repository.", - "enum": null, - "name": "repository_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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).", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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)", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - } - ] - }, - { - "name": "Search repositories", - "scope": "search", - "id": "repos", - "method": "GET", - "url": "/search/repositories", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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)", - "enum": ["stars", "forks", "help-wanted-issues", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Search topics", - "scope": "search", - "id": "topics", - "method": "GET", - "url": "/search/topics", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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).", - "enum": null, - "name": "q", - "type": "string", - "required": true - } - ] - }, - { - "name": "Search users", - "scope": "search", - "id": "users", - "method": "GET", - "url": "/search/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "q", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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)", - "enum": ["followers", "repositories", "joined"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": ["desc", "asc"], - "name": "order", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get team", - "scope": "teams", - "id": "get", - "method": "GET", - "url": "/teams/{team_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit team", - "scope": "teams", - "id": "update", - "method": "PATCH", - "url": "/teams/{team_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the team.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the team.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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"], - "name": "privacy", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "admin"], - "name": "permission", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "parent_team_id", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Delete team", - "scope": "teams", - "id": "delete", - "method": "DELETE", - "url": "/teams/{team_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List discussions", - "scope": "teams", - "id": "listDiscussions", - "method": "GET", - "url": "/teams/{team_id}/discussions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a discussion", - "scope": "teams", - "id": "createDiscussion", - "method": "POST", - "url": "/teams/{team_id}/discussions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The discussion post's title.", - "enum": null, - "name": "title", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The discussion post's body text.", - "enum": null, - "name": "body", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "private", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a single discussion", - "scope": "teams", - "id": "getDiscussion", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a discussion", - "scope": "teams", - "id": "updateDiscussion", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The discussion post's title.", - "enum": null, - "name": "title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The discussion post's body text.", - "enum": null, - "name": "body", - "type": "string", - "required": false - } - ] - }, - { - "name": "Delete a discussion", - "scope": "teams", - "id": "deleteDiscussion", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List comments", - "scope": "teams", - "id": "listDiscussionComments", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a comment", - "scope": "teams", - "id": "createDiscussionComment", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The discussion comment's body text.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a single comment", - "scope": "teams", - "id": "getDiscussionComment", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_number parameter", - "enum": null, - "name": "comment_number", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Edit a comment", - "scope": "teams", - "id": "updateDiscussionComment", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_number parameter", - "enum": null, - "name": "comment_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The discussion comment's body text.", - "enum": null, - "name": "body", - "type": "string", - "required": true - } - ] - }, - { - "name": "Delete a comment", - "scope": "teams", - "id": "deleteDiscussionComment", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_number parameter", - "enum": null, - "name": "comment_number", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List reactions for a team discussion comment", - "scope": "reactions", - "id": "listForTeamDiscussionComment", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_number parameter", - "enum": null, - "name": "comment_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create reaction for a team discussion comment", - "scope": "reactions", - "id": "createForTeamDiscussionComment", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "comment_number parameter", - "enum": null, - "name": "comment_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": true - } - ] - }, - { - "name": "List reactions for a team discussion", - "scope": "reactions", - "id": "listForTeamDiscussion", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create reaction for a team discussion", - "scope": "reactions", - "id": "createForTeamDiscussion", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "discussion_number parameter", - "enum": null, - "name": "discussion_number", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "type": "string", - "required": true - } - ] - }, - { - "name": "List pending team invitations", - "scope": "teams", - "id": "listPendingInvitations", - "method": "GET", - "url": "/teams/{team_id}/invitations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List team members", - "scope": "teams", - "id": "listMembers", - "method": "GET", - "url": "/teams/{team_id}/members", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": ["member", "maintainer", "all"], - "name": "role", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get team member", - "scope": "teams", - "id": "getMember", - "method": "GET", - "url": "/teams/{team_id}/members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add team member", - "scope": "teams", - "id": "addMember", - "method": "PUT", - "url": "/teams/{team_id}/members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Remove team member", - "scope": "teams", - "id": "removeMember", - "method": "DELETE", - "url": "/teams/{team_id}/members/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get team membership", - "scope": "teams", - "id": "getMembership", - "method": "GET", - "url": "/teams/{team_id}/memberships/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add or update team membership", - "scope": "teams", - "id": "addOrUpdateMembership", - "method": "PUT", - "url": "/teams/{team_id}/memberships/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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"], - "name": "role", - "type": "string", - "required": false - } - ] - }, - { - "name": "Remove team membership", - "scope": "teams", - "id": "removeMembership", - "method": "DELETE", - "url": "/teams/{team_id}/memberships/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List team projects", - "scope": "teams", - "id": "listProjects", - "method": "GET", - "url": "/teams/{team_id}/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Review a team project", - "scope": "teams", - "id": "reviewProject", - "method": "GET", - "url": "/teams/{team_id}/projects/{project_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Add or update team project", - "scope": "teams", - "id": "addOrUpdateProject", - "method": "PUT", - "url": "/teams/{team_id}/projects/{project_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "admin"], - "name": "permission", - "type": "string", - "required": false - } - ] - }, - { - "name": "Remove team project", - "scope": "teams", - "id": "removeProject", - "method": "DELETE", - "url": "/teams/{team_id}/projects/{project_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "project_id parameter", - "enum": null, - "name": "project_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List team repos", - "scope": "teams", - "id": "listRepos", - "method": "GET", - "url": "/teams/{team_id}/repos", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if a team manages a repository", - "scope": "teams", - "id": "checkManagesRepo", - "method": "GET", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Add or update team repository", - "scope": "teams", - "id": "addOrUpdateRepo", - "method": "PUT", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", "admin"], - "name": "permission", - "type": "string", - "required": false - } - ] - }, - { - "name": "Remove team repository", - "scope": "teams", - "id": "removeRepo", - "method": "DELETE", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List IdP groups for a team", - "scope": "teams", - "id": "listIdPGroups", - "method": "GET", - "url": "/teams/{team_id}/team-sync/group-mappings", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Create or update IdP group connections", - "scope": "teams", - "id": "createOrUpdateIdPGroupConnections", - "method": "PATCH", - "url": "/teams/{team_id}/team-sync/group-mappings", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "groups", - "type": "object[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "ID of the IdP group.", - "enum": null, - "name": "groups[].group_id", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Name of the IdP group.", - "enum": null, - "name": "groups[].group_name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Description of the IdP group.", - "enum": null, - "name": "groups[].group_description", - "type": "string", - "required": true - } - ] - }, - { - "name": "List child teams", - "scope": "teams", - "id": "listChild", - "method": "GET", - "url": "/teams/{team_id}/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "team_id parameter", - "enum": null, - "name": "team_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get the authenticated user", - "scope": "users", - "id": "getAuthenticated", - "method": "GET", - "url": "/user", - "parameters": [] - }, - { - "name": "Update the authenticated user", - "scope": "users", - "id": "updateAuthenticated", - "method": "PATCH", - "url": "/user", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new name of the user.", - "enum": null, - "name": "name", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The publicly visible email address of the user.", - "enum": null, - "name": "email", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new blog URL of the user.", - "enum": null, - "name": "blog", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new company of the user.", - "enum": null, - "name": "company", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new location of the user.", - "enum": null, - "name": "location", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new hiring availability of the user.", - "enum": null, - "name": "hireable", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The new short biography of the user.", - "enum": null, - "name": "bio", - "type": "string", - "required": false - } - ] - }, - { - "name": "List blocked users", - "scope": "users", - "id": "listBlocked", - "method": "GET", - "url": "/user/blocks", - "parameters": [] - }, - { - "name": "Check whether you've blocked a user", - "scope": "users", - "id": "checkBlocked", - "method": "GET", - "url": "/user/blocks/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Block a user", - "scope": "users", - "id": "block", - "method": "PUT", - "url": "/user/blocks/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Unblock a user", - "scope": "users", - "id": "unblock", - "method": "DELETE", - "url": "/user/blocks/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Toggle primary email visibility", - "scope": "users", - "id": "togglePrimaryEmailVisibility", - "method": "PATCH", - "url": "/user/email/visibility", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Specify the _primary_ email address that needs a visibility change.", - "enum": null, - "name": "email", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "visibility", - "type": "string", - "required": true - } - ] - }, - { - "name": "List email addresses for a user", - "scope": "users", - "id": "listEmails", - "method": "GET", - "url": "/user/emails", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Add email address(es)", - "scope": "users", - "id": "addEmails", - "method": "POST", - "url": "/user/emails", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "emails", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "Delete email address(es)", - "scope": "users", - "id": "deleteEmails", - "method": "DELETE", - "url": "/user/emails", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "emails", - "type": "string[]", - "required": true - } - ] - }, - { - "name": "List the authenticated user's followers", - "scope": "users", - "id": "listFollowersForAuthenticatedUser", - "method": "GET", - "url": "/user/followers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List who the authenticated user is following", - "scope": "users", - "id": "listFollowingForAuthenticatedUser", - "method": "GET", - "url": "/user/following", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if you are following a user", - "scope": "users", - "id": "checkFollowing", - "method": "GET", - "url": "/user/following/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Follow a user", - "scope": "users", - "id": "follow", - "method": "PUT", - "url": "/user/following/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Unfollow a user", - "scope": "users", - "id": "unfollow", - "method": "DELETE", - "url": "/user/following/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List your GPG keys", - "scope": "users", - "id": "listGpgKeys", - "method": "GET", - "url": "/user/gpg_keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a GPG key", - "scope": "users", - "id": "createGpgKey", - "method": "POST", - "url": "/user/gpg_keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "armored_public_key", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a single GPG key", - "scope": "users", - "id": "getGpgKey", - "method": "GET", - "url": "/user/gpg_keys/{gpg_key_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gpg_key_id parameter", - "enum": null, - "name": "gpg_key_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete a GPG key", - "scope": "users", - "id": "deleteGpgKey", - "method": "DELETE", - "url": "/user/gpg_keys/{gpg_key_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "gpg_key_id parameter", - "enum": null, - "name": "gpg_key_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List installations for a user", - "scope": "apps", - "id": "listInstallationsForAuthenticatedUser", - "method": "GET", - "url": "/user/installations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List repositories accessible to the user for an installation", - "scope": "apps", - "id": "listInstallationReposForAuthenticatedUser", - "method": "GET", - "url": "/user/installations/{installation_id}/repositories", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "installation_id parameter", - "enum": null, - "name": "installation_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Add repository to installation", - "scope": "apps", - "id": "addRepoToInstallation", - "method": "PUT", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "installation_id parameter", - "enum": null, - "name": "installation_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repository_id parameter", - "enum": null, - "name": "repository_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Remove repository from installation", - "scope": "apps", - "id": "removeRepoFromInstallation", - "method": "DELETE", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "installation_id parameter", - "enum": null, - "name": "installation_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repository_id parameter", - "enum": null, - "name": "repository_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List all issues across owned and member repositories assigned to the authenticated user", - "scope": "issues", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/issues", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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", - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "name": "filter", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "enum": null, - "name": "labels", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "enum": ["created", "updated", "comments"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The direction of the sort. Can be either `asc` or `desc`.", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List your public keys", - "scope": "users", - "id": "listPublicKeys", - "method": "GET", - "url": "/user/keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a public key", - "scope": "users", - "id": "createPublicKey", - "method": "POST", - "url": "/user/keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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\".", - "enum": null, - "name": "title", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "key", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a single public key", - "scope": "users", - "id": "getPublicKey", - "method": "GET", - "url": "/user/keys/{key_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "key_id parameter", - "enum": null, - "name": "key_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete a public key", - "scope": "users", - "id": "deletePublicKey", - "method": "DELETE", - "url": "/user/keys/{key_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "key_id parameter", - "enum": null, - "name": "key_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Get a user's Marketplace purchases", - "scope": "apps", - "id": "listMarketplacePurchasesForAuthenticatedUser", - "method": "GET", - "url": "/user/marketplace_purchases", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a user's Marketplace purchases (stubbed)", - "scope": "apps", - "id": "listMarketplacePurchasesForAuthenticatedUserStubbed", - "method": "GET", - "url": "/user/marketplace_purchases/stubbed", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List your organization memberships", - "scope": "orgs", - "id": "listMemberships", - "method": "GET", - "url": "/user/memberships/orgs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": ["active", "pending"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get your organization membership", - "scope": "orgs", - "id": "getMembershipForAuthenticatedUser", - "method": "GET", - "url": "/user/memberships/orgs/{org}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - } - ] - }, - { - "name": "Edit your organization membership", - "scope": "orgs", - "id": "updateMembership", - "method": "PATCH", - "url": "/user/memberships/orgs/{org}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", - "enum": ["active"], - "name": "state", - "type": "string", - "required": true - } - ] - }, - { - "name": "Start a user migration", - "scope": "migrations", - "id": "startForAuthenticatedUser", - "method": "POST", - "url": "/user/migrations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "An array of repositories to include in the migration.", - "enum": null, - "name": "repositories", - "type": "string[]", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Locks the `repositories` to prevent changes during the migration when set to `true`.", - "enum": null, - "name": "lock_repositories", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "exclude_attachments", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "Get a list of user migrations", - "scope": "migrations", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/migrations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get the status of a user migration", - "scope": "migrations", - "id": "getStatusForAuthenticatedUser", - "method": "GET", - "url": "/user/migrations/{migration_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Download a user migration archive", - "scope": "migrations", - "id": "getArchiveForAuthenticatedUser", - "method": "GET", - "url": "/user/migrations/{migration_id}/archive", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Delete a user migration archive", - "scope": "migrations", - "id": "deleteArchiveForAuthenticatedUser", - "method": "DELETE", - "url": "/user/migrations/{migration_id}/archive", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Unlock a user repository", - "scope": "migrations", - "id": "unlockRepoForAuthenticatedUser", - "method": "DELETE", - "url": "/user/migrations/{migration_id}/repos/{repo_name}/lock", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "migration_id parameter", - "enum": null, - "name": "migration_id", - "type": "integer", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo_name parameter", - "enum": null, - "name": "repo_name", - "type": "string", - "required": true - } - ] - }, - { - "name": "List your organizations", - "scope": "orgs", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/orgs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Create a user project", - "scope": "projects", - "id": "createForAuthenticatedUser", - "method": "POST", - "url": "/user/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the project.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The description of the project.", - "enum": null, - "name": "body", - "type": "string", - "required": false - } - ] - }, - { - "name": "List public email addresses for a user", - "scope": "users", - "id": "listPublicEmails", - "method": "GET", - "url": "/user/public_emails", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List your repositories", - "scope": "repos", - "id": "list", - "method": "GET", - "url": "/user/repos", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `all`, `public`, or `private`.", - "enum": ["all", "public", "private"], - "name": "visibility", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "affiliation", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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**.", - "enum": ["all", "owner", "public", "private", "member"], - "name": "type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", - "enum": ["created", "updated", "pushed", "full_name"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Creates a new repository for the authenticated user", - "scope": "repos", - "id": "createForAuthenticatedUser", - "method": "POST", - "url": "/user/repos", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The name of the repository.", - "enum": null, - "name": "name", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A short description of the repository.", - "enum": null, - "name": "description", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "A URL with more information about the repository.", - "enum": null, - "name": "homepage", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", - "enum": null, - "name": "private", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "enum": null, - "name": "has_issues", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "has_projects", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "enum": null, - "name": "has_wiki", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "enum": null, - "name": "is_template", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "team_id", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Pass `true` to create an initial commit with empty README.", - "enum": null, - "name": "auto_init", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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\".", - "enum": null, - "name": "gitignore_template", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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\".", - "enum": null, - "name": "license_template", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "enum": null, - "name": "allow_squash_merge", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "enum": null, - "name": "allow_merge_commit", - "type": "boolean", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "enum": null, - "name": "allow_rebase_merge", - "type": "boolean", - "required": false - } - ] - }, - { - "name": "List a user's repository invitations", - "scope": "repos", - "id": "listInvitationsForAuthenticatedUser", - "method": "GET", - "url": "/user/repository_invitations", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Accept a repository invitation", - "scope": "repos", - "id": "acceptInvitation", - "method": "PATCH", - "url": "/user/repository_invitations/{invitation_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "invitation_id parameter", - "enum": null, - "name": "invitation_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "Decline a repository invitation", - "scope": "repos", - "id": "declineInvitation", - "method": "DELETE", - "url": "/user/repository_invitations/{invitation_id}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "invitation_id parameter", - "enum": null, - "name": "invitation_id", - "type": "integer", - "required": true - } - ] - }, - { - "name": "List repositories being starred by the authenticated user", - "scope": "activity", - "id": "listReposStarredByAuthenticatedUser", - "method": "GET", - "url": "/user/starred", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "One of `asc` (ascending) or `desc` (descending).", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if you are starring a repository", - "scope": "activity", - "id": "checkStarringRepo", - "method": "GET", - "url": "/user/starred/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Star a repository", - "scope": "activity", - "id": "starRepo", - "method": "PUT", - "url": "/user/starred/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Unstar a repository", - "scope": "activity", - "id": "unstarRepo", - "method": "DELETE", - "url": "/user/starred/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List repositories being watched by the authenticated user", - "scope": "activity", - "id": "listWatchedReposForAuthenticatedUser", - "method": "GET", - "url": "/user/subscriptions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if you are watching a repository (LEGACY)", - "scope": "activity", - "id": "checkWatchingRepoLegacy", - "method": "GET", - "url": "/user/subscriptions/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Watch a repository (LEGACY)", - "scope": "activity", - "id": "watchRepoLegacy", - "method": "PUT", - "url": "/user/subscriptions/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "Stop watching a repository (LEGACY)", - "scope": "activity", - "id": "stopWatchingRepoLegacy", - "method": "DELETE", - "url": "/user/subscriptions/{owner}/{repo}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "owner parameter", - "enum": null, - "name": "owner", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "repo parameter", - "enum": null, - "name": "repo", - "type": "string", - "required": true - } - ] - }, - { - "name": "List user teams", - "scope": "teams", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/teams", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get all users", - "scope": "users", - "id": "list", - "method": "GET", - "url": "/users", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "The integer ID of the last User that you've seen.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get a single user", - "scope": "users", - "id": "getByUsername", - "method": "GET", - "url": "/users/{username}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List events performed by a user", - "scope": "activity", - "id": "listEventsForUser", - "method": "GET", - "url": "/users/{username}/events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List events for an organization", - "scope": "activity", - "id": "listEventsForOrg", - "method": "GET", - "url": "/users/{username}/events/orgs/{org}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "org parameter", - "enum": null, - "name": "org", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List public events performed by a user", - "scope": "activity", - "id": "listPublicEventsForUser", - "method": "GET", - "url": "/users/{username}/events/public", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List a user's followers", - "scope": "users", - "id": "listFollowersForUser", - "method": "GET", - "url": "/users/{username}/followers", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List who a user is following", - "scope": "users", - "id": "listFollowingForUser", - "method": "GET", - "url": "/users/{username}/following", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Check if one user follows another", - "scope": "users", - "id": "checkFollowingForUser", - "method": "GET", - "url": "/users/{username}/following/{target_user}", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "target_user parameter", - "enum": null, - "name": "target_user", - "type": "string", - "required": true - } - ] - }, - { - "name": "List public gists for the specified user", - "scope": "gists", - "id": "listPublicForUser", - "method": "GET", - "url": "/users/{username}/gists", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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.", - "enum": null, - "name": "since", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List GPG keys for a user", - "scope": "users", - "id": "listGpgKeysForUser", - "method": "GET", - "url": "/users/{username}/gpg_keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "Get contextual information about a user", - "scope": "users", - "id": "getContextForUser", - "method": "GET", - "url": "/users/{username}/hovercard", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "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`.", - "enum": ["organization", "repository", "issue", "pull_request"], - "name": "subject_type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", - "enum": null, - "name": "subject_id", - "type": "string", - "required": false - } - ] - }, - { - "name": "Get a user installation", - "scope": "apps", - "id": "getUserInstallation", - "method": "GET", - "url": "/users/{username}/installation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "Get a user installation", - "scope": "apps", - "id": "findUserInstallation", - "method": "GET", - "url": "/users/{username}/installation", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - } - ] - }, - { - "name": "List public keys for a user", - "scope": "users", - "id": "listPublicKeysForUser", - "method": "GET", - "url": "/users/{username}/keys", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List user organizations", - "scope": "orgs", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/orgs", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List user projects", - "scope": "projects", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/projects", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", - "enum": ["open", "closed", "all"], - "name": "state", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List events that a user has received", - "scope": "activity", - "id": "listReceivedEventsForUser", - "method": "GET", - "url": "/users/{username}/received_events", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List public events that a user has received", - "scope": "activity", - "id": "listReceivedPublicEventsForUser", - "method": "GET", - "url": "/users/{username}/received_events/public", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List user repositories", - "scope": "repos", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/repos", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `all`, `owner`, `member`.", - "enum": ["all", "owner", "member"], - "name": "type", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", - "enum": ["created", "updated", "pushed", "full_name"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List repositories being starred by a user", - "scope": "activity", - "id": "listReposStarredByUser", - "method": "GET", - "url": "/users/{username}/starred", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", - "enum": ["created", "updated"], - "name": "sort", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "One of `asc` (ascending) or `desc` (descending).", - "enum": ["asc", "desc"], - "name": "direction", - "type": "string", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - }, - { - "name": "List repositories being watched by a user", - "scope": "activity", - "id": "listReposWatchedByUser", - "method": "GET", - "url": "/users/{username}/subscriptions", - "parameters": [ - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "username parameter", - "enum": null, - "name": "username", - "type": "string", - "required": true - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Results per page (max 100)", - "enum": null, - "name": "per_page", - "type": "integer", - "required": false - }, - { - "alias": null, - "allowNull": false, - "deprecated": null, - "description": "Page number of the results to fetch.", - "enum": null, - "name": "page", - "type": "integer", - "required": false - } - ] - } -] diff --git a/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template b/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template deleted file mode 100644 index 2eceb2f..0000000 --- a/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template +++ /dev/null @@ -1,33 +0,0 @@ -// DO NOT EDIT THIS FILE -import { RequestHeaders } from "../RequestHeaders"; -import { RequestRequestOptions } from "../RequestRequestOptions"; -import { Url } from "../Url"; - -export interface Endpoints { - {{#each endpointsByRoute}} - "{{@key}}": [{{union this "optionsTypeName"}}, {{union this "requestOptionsTypeName"}}] - {{/each}} -} - -{{#each options}} -type {{in.name}} = { -{{#each in.parameters}} - {{&jsdoc}} - {{{name this}}}: {{{type this}}} -{{/each}} -} -type {{out.name}} = { - method: "{{out.method}}", - url: Url, - headers: RequestHeaders, - request: RequestRequestOptions -} -{{/each}} - -{{#childParams}} -export type {{paramTypeName}} = { -{{#params}} - {{{name this}}}: {{{type this}}} -{{/params}} -}; -{{/childParams}} \ No newline at end of file diff --git a/node_modules/@octokit/types/scripts/update-endpoints/typescript.js b/node_modules/@octokit/types/scripts/update-endpoints/typescript.js deleted file mode 100644 index 2095c6c..0000000 --- a/node_modules/@octokit/types/scripts/update-endpoints/typescript.js +++ /dev/null @@ -1,179 +0,0 @@ -const { readFileSync, writeFileSync } = require("fs"); -const { resolve } = require("path"); - -const Handlebars = require("handlebars"); -const set = require("lodash.set"); -const pascalCase = require("pascal-case"); -const prettier = require("prettier"); -const { stringToJsdocComment } = require("string-to-jsdoc-comment"); -const sortKeys = require("sort-keys"); - -const ENDPOINTS = require("./generated/Endpoints.json"); -const ENDPOINTS_PATH = resolve( - process.cwd(), - "src", - "generated", - "Endpoints.ts" -); -const ENDPOINTS_TEMPLATE_PATH = resolve( - process.cwd(), - "scripts", - "update-endpoints", - "templates", - "endpoints.ts.template" -); - -Handlebars.registerHelper("union", function(endpoints, key) { - return endpoints.map(endpoint => endpoint[key]).join(" | "); -}); -Handlebars.registerHelper("name", function(parameter) { - let name = parameter.key; - - if (/[.\[]/.test(name)) { - name = `"${name}"`; - } - - if (parameter.required) { - return name; - } - - return `${name}?`; -}); - -Handlebars.registerHelper("type", function(parameter) { - const type = typeMap[parameter.type] || parameter.type; - - if (parameter.allowNull) { - return `${type} | null`; - } - - return type; -}); -const template = Handlebars.compile( - readFileSync(ENDPOINTS_TEMPLATE_PATH, "utf8") -); - -const endpointsByRoute = {}; - -const typeMap = { - integer: "number", - "integer[]": "number[]" -}; - -for (const endpoint of ENDPOINTS) { - const route = `${endpoint.method} ${endpoint.url.replace( - /\{([^}]+)}/g, - ":$1" - )}`; - - if (!endpointsByRoute[route]) { - endpointsByRoute[route] = []; - } - - endpointsByRoute[route].push({ - optionsTypeName: - pascalCase(`${endpoint.scope} ${endpoint.id}`) + "Endpoint", - requestOptionsTypeName: - pascalCase(`${endpoint.scope} ${endpoint.id}`) + "RequestOptions" - }); -} - -const options = []; -const childParams = {}; - -for (const endpoint of ENDPOINTS) { - const { method, parameters } = endpoint; - - const optionsTypeName = - pascalCase(`${endpoint.scope} ${endpoint.id}`) + "Endpoint"; - const requestOptionsTypeName = - pascalCase(`${endpoint.scope} ${endpoint.id}`) + "RequestOptions"; - - options.push({ - in: { - name: optionsTypeName, - parameters: parameters - .map(parameterize) - // handle "object" & "object[]" types - .map(parameter => { - if (parameter.deprecated) { - return; - } - - const namespacedParamsName = pascalCase( - `${endpoint.scope}.${endpoint.id}.Params` - ); - - if (parameter.type === "object" || parameter.type === "object[]") { - const childParamsName = pascalCase( - `${namespacedParamsName}.${parameter.key}` - ); - - parameter.type = parameter.type.replace("object", childParamsName); - - if (!childParams[childParamsName]) { - childParams[childParamsName] = {}; - } - } - - if (!/\./.test(parameter.key)) { - return parameter; - } - - const childKey = parameter.key.split(".").pop(); - const parentKey = parameter.key.replace(/\.[^.]+$/, ""); - - parameter.key = childKey; - - const childParamsName = pascalCase( - `${namespacedParamsName}.${parentKey}` - ); - set(childParams, `${childParamsName}.${childKey}`, parameter); - }) - .filter(Boolean) - }, - out: { - name: requestOptionsTypeName, - method - } - }); -} - -const result = template({ - endpointsByRoute: sortKeys(endpointsByRoute, { deep: true }), - options, - childParams: Object.keys(childParams).map(key => { - if (key === "GistsCreateParamsFiles") { - debugger; - } - return { - paramTypeName: key, - params: Object.values(childParams[key]) - }; - }) -}); - -writeFileSync( - ENDPOINTS_PATH, - prettier.format(result, { parser: "typescript" }) -); -console.log(`${ENDPOINTS_PATH} updated.`); - -function parameterize(parameter) { - const key = parameter.name; - const type = typeMap[parameter.type] || parameter.type; - const enums = parameter.enum - ? parameter.enum.map(JSON.stringify).join("|") - : null; - - return { - name: pascalCase(key), - key: key, - required: parameter.required, - type: enums || type, - alias: parameter.alias, - deprecated: parameter.deprecated, - allowNull: parameter.allowNull, - jsdoc: stringToJsdocComment(parameter.description) - }; -} diff --git a/node_modules/@octokit/types/src/AuthInterface.ts b/node_modules/@octokit/types/src/AuthInterface.ts deleted file mode 100644 index 8f58743..0000000 --- a/node_modules/@octokit/types/src/AuthInterface.ts +++ /dev/null @@ -1,43 +0,0 @@ -import { EndpointOptions } from "./EndpointOptions"; -import { OctokitResponse } from "./OctokitResponse"; -import { RequestInterface } from "./RequestInterface"; -import { RequestParameters } from "./RequestParameters"; -import { Route } from "./Route"; - -/** - * Interface to implement complex authentication strategies for Octokit. - * An object Implementing the AuthInterface can directly be passed as the - * `auth` option in the Octokit constructor. - * - * For the official implementations of the most common authentication - * strategies, see https://github.com/octokit/auth.js - */ -export interface AuthInterface< - AuthOptions extends any[], - Authentication extends any -> { - (...args: AuthOptions): Promise; - - hook: { - /** - * Sends a request using the passed `request` instance - * - * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. - */ - (request: RequestInterface, options: EndpointOptions): Promise< - OctokitResponse - >; - - /** - * Sends a request using the passed `request` instance - * - * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` - * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. - */ - ( - request: RequestInterface, - route: Route, - parameters?: RequestParameters - ): Promise>; - }; -} diff --git a/node_modules/@octokit/types/src/EndpointInterface.ts b/node_modules/@octokit/types/src/EndpointInterface.ts deleted file mode 100644 index fee78d6..0000000 --- a/node_modules/@octokit/types/src/EndpointInterface.ts +++ /dev/null @@ -1,74 +0,0 @@ -import { EndpointDefaults } from "./EndpointDefaults"; -import { EndpointOptions } from "./EndpointOptions"; -import { RequestOptions } from "./RequestOptions"; -import { RequestParameters } from "./RequestParameters"; -import { Route } from "./Route"; - -import { Endpoints } from "./generated/Endpoints"; - -export interface EndpointInterface { - /** - * Transforms a GitHub REST API endpoint into generic request options - * - * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. - */ - (options: EndpointOptions): RequestOptions; - - /** - * Transforms a GitHub REST API endpoint into generic request options - * - * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` - * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. - */ - ( - route: keyof Endpoints | R, - options?: R extends keyof Endpoints - ? Endpoints[R][0] & RequestParameters - : RequestParameters - ): R extends keyof Endpoints ? Endpoints[R][1] : RequestOptions; - - /** - * Object with current default route and parameters - */ - DEFAULTS: EndpointDefaults; - - /** - * Returns a new `endpoint` with updated route and parameters - */ - defaults: (newDefaults: RequestParameters) => EndpointInterface; - - merge: { - /** - * Merges current endpoint defaults with passed route and parameters, - * without transforming them into request options. - * - * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` - * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. - * - */ - (route: Route, parameters?: RequestParameters): EndpointDefaults; - - /** - * Merges current endpoint defaults with passed route and parameters, - * without transforming them into request options. - * - * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. - */ - (options: RequestParameters): EndpointDefaults; - - /** - * Returns current default options. - * - * @deprecated use endpoint.DEFAULTS instead - */ - (): EndpointDefaults; - }; - - /** - * Stateless method to turn endpoint options into request options. - * Calling `endpoint(options)` is the same as calling `endpoint.parse(endpoint.merge(options))`. - * - * @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. - */ - parse: (options: EndpointDefaults) => RequestOptions; -} diff --git a/node_modules/@octokit/types/src/OctokitResponse.ts b/node_modules/@octokit/types/src/OctokitResponse.ts deleted file mode 100644 index 4cec20d..0000000 --- a/node_modules/@octokit/types/src/OctokitResponse.ts +++ /dev/null @@ -1,18 +0,0 @@ -import { ResponseHeaders } from "./ResponseHeaders"; -import { Url } from "./Url"; - -export type OctokitResponse = { - headers: ResponseHeaders; - /** - * http response code - */ - status: number; - /** - * URL of response after all redirects - */ - url: Url; - /** - * This is the data you would see in https://developer.Octokit.com/v3/ - */ - data: T; -}; diff --git a/node_modules/@octokit/types/src/RequestHeaders.ts b/node_modules/@octokit/types/src/RequestHeaders.ts deleted file mode 100644 index 0df6636..0000000 --- a/node_modules/@octokit/types/src/RequestHeaders.ts +++ /dev/null @@ -1,15 +0,0 @@ -export type RequestHeaders = { - /** - * Avoid setting `headers.accept`, use `mediaType.{format|previews}` option instead. - */ - accept?: string; - /** - * Use `authorization` to send authenticated request, remember `token ` / `bearer ` prefixes. Example: `token 1234567890abcdef1234567890abcdef12345678` - */ - authorization?: string; - /** - * `user-agent` is set do a default and can be overwritten as needed. - */ - "user-agent"?: string; - [header: string]: string | number | undefined; -}; diff --git a/node_modules/@octokit/types/src/RequestInterface.ts b/node_modules/@octokit/types/src/RequestInterface.ts deleted file mode 100644 index bc4c74f..0000000 --- a/node_modules/@octokit/types/src/RequestInterface.ts +++ /dev/null @@ -1,34 +0,0 @@ -import { EndpointInterface } from "./EndpointInterface"; -import { EndpointOptions } from "./EndpointOptions"; -import { OctokitResponse } from "./OctokitResponse"; -import { RequestParameters } from "./RequestParameters"; -import { Route } from "./Route"; - -export interface RequestInterface { - /** - * Sends a request based on endpoint options - * - * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. - */ - (options: EndpointOptions): Promise>; - - /** - * Sends a request based on endpoint options - * - * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` - * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. - */ - (route: Route, parameters?: RequestParameters): Promise< - OctokitResponse - >; - - /** - * Returns a new `endpoint` with updated route and parameters - */ - defaults: (newDefaults: RequestParameters) => RequestInterface; - - /** - * Octokit endpoint API, see {@link https://github.com/octokit/endpoint.js|@octokit/endpoint} - */ - endpoint: EndpointInterface; -} diff --git a/node_modules/@octokit/types/src/RequestMethod.ts b/node_modules/@octokit/types/src/RequestMethod.ts deleted file mode 100644 index 2910435..0000000 --- a/node_modules/@octokit/types/src/RequestMethod.ts +++ /dev/null @@ -1,10 +0,0 @@ -/** - * HTTP Verb supported by GitHub's REST API - */ -export type RequestMethod = - | "DELETE" - | "GET" - | "HEAD" - | "PATCH" - | "POST" - | "PUT"; diff --git a/node_modules/@octokit/types/src/RequestParameters.ts b/node_modules/@octokit/types/src/RequestParameters.ts deleted file mode 100644 index 9766be0..0000000 --- a/node_modules/@octokit/types/src/RequestParameters.ts +++ /dev/null @@ -1,46 +0,0 @@ -import { RequestRequestOptions } from "./RequestRequestOptions"; -import { RequestHeaders } from "./RequestHeaders"; -import { Url } from "./Url"; - -/** - * Parameters that can be passed into `request(route, parameters)` or `endpoint(route, parameters)` methods - */ -export type RequestParameters = { - /** - * Base URL to be used when a relative URL is passed, such as `/orgs/:org`. - * If `baseUrl` is `https://enterprise.acme-inc.com/api/v3`, then the request - * will be sent to `https://enterprise.acme-inc.com/api/v3/orgs/:org`. - */ - baseUrl?: Url; - /** - * HTTP headers. Use lowercase keys. - */ - headers?: RequestHeaders; - /** - * Media type options, see {@link https://developer.github.com/v3/media/|GitHub Developer Guide} - */ - mediaType?: { - /** - * `json` by default. Can be `raw`, `text`, `html`, `full`, `diff`, `patch`, `sha`, `base64`. Depending on endpoint - */ - format?: string; - /** - * Custom media type names of {@link https://developer.github.com/v3/media/|API Previews} without the `-preview` suffix. - * Example for single preview: `['squirrel-girl']`. - * Example for multiple previews: `['squirrel-girl', 'mister-fantastic']`. - */ - previews?: string[]; - }; - /** - * Pass custom meta information for the request. The `request` object will be returned as is. - */ - request?: RequestRequestOptions; - /** - * Any additional parameter will be passed as follows - * 1. URL parameter if `':parameter'` or `{parameter}` is part of `url` - * 2. Query parameter if `method` is `'GET'` or `'HEAD'` - * 3. Request body if `parameter` is `'data'` - * 4. JSON in the request body in the form of `body[parameter]` unless `parameter` key is `'data'` - */ - [parameter: string]: any; -}; diff --git a/node_modules/@octokit/types/src/RequestRequestOptions.ts b/node_modules/@octokit/types/src/RequestRequestOptions.ts deleted file mode 100644 index 028d6f7..0000000 --- a/node_modules/@octokit/types/src/RequestRequestOptions.ts +++ /dev/null @@ -1,27 +0,0 @@ -import { Agent } from "http"; -import { Fetch } from "./Fetch"; -import { Signal } from "./Signal"; - -/** - * Octokit-specific request options which are ignored for the actual request, but can be used by Octokit or plugins to manipulate how the request is sent or how a response is handled - */ -export type RequestRequestOptions = { - /** - * Node only. Useful for custom proxy, certificate, or dns lookup. - */ - agent?: Agent; - /** - * Custom replacement for built-in fetch method. Useful for testing or request hooks. - */ - fetch?: Fetch; - /** - * Use an `AbortController` instance to cancel a request. In node you can only cancel streamed requests. - */ - signal?: Signal; - /** - * Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). `options.request.signal` is recommended instead. - */ - timeout?: number; - - [option: string]: any; -}; diff --git a/node_modules/@octokit/types/src/ResponseHeaders.ts b/node_modules/@octokit/types/src/ResponseHeaders.ts deleted file mode 100644 index 17267b6..0000000 --- a/node_modules/@octokit/types/src/ResponseHeaders.ts +++ /dev/null @@ -1,21 +0,0 @@ -export type ResponseHeaders = { - "cache-control"?: string; - "content-length"?: number; - "content-type"?: string; - date?: string; - etag?: string; - "last-modified"?: string; - link?: string; - location?: string; - server?: string; - status?: string; - vary?: string; - "x-github-mediatype"?: string; - "x-github-request-id"?: string; - "x-oauth-scopes"?: string; - "x-ratelimit-limit"?: string; - "x-ratelimit-remaining"?: string; - "x-ratelimit-reset"?: string; - - [header: string]: string | number | undefined; -}; diff --git a/node_modules/@octokit/types/src/Route.ts b/node_modules/@octokit/types/src/Route.ts deleted file mode 100644 index c5229a8..0000000 --- a/node_modules/@octokit/types/src/Route.ts +++ /dev/null @@ -1,4 +0,0 @@ -/** - * String consisting of an optional HTTP method and relative path or absolute URL. Examples: `'/orgs/:org'`, `'PUT /orgs/:org'`, `GET https://example.com/foo/bar` - */ -export type Route = string; diff --git a/node_modules/@octokit/types/src/StrategyInterface.ts b/node_modules/@octokit/types/src/StrategyInterface.ts deleted file mode 100644 index 60a55ad..0000000 --- a/node_modules/@octokit/types/src/StrategyInterface.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { AuthInterface } from "./AuthInterface"; - -export interface StrategyInterface< - StrategyOptions extends any[], - AuthOptions extends any[], - Authentication extends object -> { - (...args: StrategyOptions): AuthInterface; -} diff --git a/node_modules/@octokit/types/src/Url.ts b/node_modules/@octokit/types/src/Url.ts deleted file mode 100644 index 9d228cb..0000000 --- a/node_modules/@octokit/types/src/Url.ts +++ /dev/null @@ -1,4 +0,0 @@ -/** - * Relative or absolute URL. Examples: `'/orgs/:org'`, `https://example.com/foo/bar` - */ -export type Url = string; diff --git a/node_modules/@octokit/types/src/VERSION.ts b/node_modules/@octokit/types/src/VERSION.ts deleted file mode 100644 index 6c49faf..0000000 --- a/node_modules/@octokit/types/src/VERSION.ts +++ /dev/null @@ -1 +0,0 @@ -export const VERSION = "2.0.2"; diff --git a/node_modules/@octokit/types/src/generated/Endpoints.ts b/node_modules/@octokit/types/src/generated/Endpoints.ts deleted file mode 100644 index 3aec914..0000000 --- a/node_modules/@octokit/types/src/generated/Endpoints.ts +++ /dev/null @@ -1,14190 +0,0 @@ -// DO NOT EDIT THIS FILE -import { RequestHeaders } from "../RequestHeaders"; -import { RequestRequestOptions } from "../RequestRequestOptions"; -import { Url } from "../Url"; - -export interface Endpoints { - "DELETE /app/installations/:installation_id": [ - AppsDeleteInstallationEndpoint, - AppsDeleteInstallationRequestOptions - ]; - "DELETE /applications/:client_id/grants/:access_token": [ - OauthAuthorizationsRevokeGrantForApplicationEndpoint, - OauthAuthorizationsRevokeGrantForApplicationRequestOptions - ]; - "DELETE /applications/:client_id/tokens/:access_token": [ - OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint, - OauthAuthorizationsRevokeAuthorizationForApplicationRequestOptions - ]; - "DELETE /applications/grants/:grant_id": [ - OauthAuthorizationsDeleteGrantEndpoint, - OauthAuthorizationsDeleteGrantRequestOptions - ]; - "DELETE /authorizations/:authorization_id": [ - OauthAuthorizationsDeleteAuthorizationEndpoint, - OauthAuthorizationsDeleteAuthorizationRequestOptions - ]; - "DELETE /gists/:gist_id": [GistsDeleteEndpoint, GistsDeleteRequestOptions]; - "DELETE /gists/:gist_id/comments/:comment_id": [ - GistsDeleteCommentEndpoint, - GistsDeleteCommentRequestOptions - ]; - "DELETE /gists/:gist_id/star": [ - GistsUnstarEndpoint, - GistsUnstarRequestOptions - ]; - "DELETE /notifications/threads/:thread_id/subscription": [ - ActivityDeleteThreadSubscriptionEndpoint, - ActivityDeleteThreadSubscriptionRequestOptions - ]; - "DELETE /orgs/:org/blocks/:username": [ - OrgsUnblockUserEndpoint, - OrgsUnblockUserRequestOptions - ]; - "DELETE /orgs/:org/credential-authorizations/:credential_id": [ - OrgsRemoveCredentialAuthorizationEndpoint, - OrgsRemoveCredentialAuthorizationRequestOptions - ]; - "DELETE /orgs/:org/hooks/:hook_id": [ - OrgsDeleteHookEndpoint, - OrgsDeleteHookRequestOptions - ]; - "DELETE /orgs/:org/interaction-limits": [ - InteractionsRemoveRestrictionsForOrgEndpoint, - InteractionsRemoveRestrictionsForOrgRequestOptions - ]; - "DELETE /orgs/:org/members/:username": [ - OrgsRemoveMemberEndpoint, - OrgsRemoveMemberRequestOptions - ]; - "DELETE /orgs/:org/memberships/:username": [ - OrgsRemoveMembershipEndpoint, - OrgsRemoveMembershipRequestOptions - ]; - "DELETE /orgs/:org/migrations/:migration_id/archive": [ - MigrationsDeleteArchiveForOrgEndpoint, - MigrationsDeleteArchiveForOrgRequestOptions - ]; - "DELETE /orgs/:org/migrations/:migration_id/repos/:repo_name/lock": [ - MigrationsUnlockRepoForOrgEndpoint, - MigrationsUnlockRepoForOrgRequestOptions - ]; - "DELETE /orgs/:org/outside_collaborators/:username": [ - OrgsRemoveOutsideCollaboratorEndpoint, - OrgsRemoveOutsideCollaboratorRequestOptions - ]; - "DELETE /orgs/:org/public_members/:username": [ - OrgsConcealMembershipEndpoint, - OrgsConcealMembershipRequestOptions - ]; - "DELETE /projects/:project_id": [ - ProjectsDeleteEndpoint, - ProjectsDeleteRequestOptions - ]; - "DELETE /projects/:project_id/collaborators/:username": [ - ProjectsRemoveCollaboratorEndpoint, - ProjectsRemoveCollaboratorRequestOptions - ]; - "DELETE /projects/columns/:column_id": [ - ProjectsDeleteColumnEndpoint, - ProjectsDeleteColumnRequestOptions - ]; - "DELETE /projects/columns/cards/:card_id": [ - ProjectsDeleteCardEndpoint, - ProjectsDeleteCardRequestOptions - ]; - "DELETE /reactions/:reaction_id": [ - ReactionsDeleteEndpoint, - ReactionsDeleteRequestOptions - ]; - "DELETE /repos/:owner/:repo": [ - ReposDeleteEndpoint, - ReposDeleteRequestOptions - ]; - "DELETE /repos/:owner/:repo/automated-security-fixes": [ - ReposDisableAutomatedSecurityFixesEndpoint, - ReposDisableAutomatedSecurityFixesRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection": [ - ReposRemoveBranchProtectionEndpoint, - ReposRemoveBranchProtectionRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ - ReposRemoveProtectedBranchAdminEnforcementEndpoint, - ReposRemoveProtectedBranchAdminEnforcementRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ - ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint, - ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ - ReposRemoveProtectedBranchRequiredSignaturesEndpoint, - ReposRemoveProtectedBranchRequiredSignaturesRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ - ReposRemoveProtectedBranchRequiredStatusChecksEndpoint, - ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ - ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint, - ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions": [ - ReposRemoveProtectedBranchRestrictionsEndpoint, - ReposRemoveProtectedBranchRestrictionsRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ - ReposRemoveProtectedBranchAppRestrictionsEndpoint, - ReposRemoveProtectedBranchAppRestrictionsRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ - ReposRemoveProtectedBranchTeamRestrictionsEndpoint, - ReposRemoveProtectedBranchTeamRestrictionsRequestOptions - ]; - "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ - ReposRemoveProtectedBranchUserRestrictionsEndpoint, - ReposRemoveProtectedBranchUserRestrictionsRequestOptions - ]; - "DELETE /repos/:owner/:repo/collaborators/:username": [ - ReposRemoveCollaboratorEndpoint, - ReposRemoveCollaboratorRequestOptions - ]; - "DELETE /repos/:owner/:repo/comments/:comment_id": [ - ReposDeleteCommitCommentEndpoint, - ReposDeleteCommitCommentRequestOptions - ]; - "DELETE /repos/:owner/:repo/contents/:path": [ - ReposDeleteFileEndpoint, - ReposDeleteFileRequestOptions - ]; - "DELETE /repos/:owner/:repo/downloads/:download_id": [ - ReposDeleteDownloadEndpoint, - ReposDeleteDownloadRequestOptions - ]; - "DELETE /repos/:owner/:repo/git/refs/:ref": [ - GitDeleteRefEndpoint, - GitDeleteRefRequestOptions - ]; - "DELETE /repos/:owner/:repo/hooks/:hook_id": [ - ReposDeleteHookEndpoint, - ReposDeleteHookRequestOptions - ]; - "DELETE /repos/:owner/:repo/import": [ - MigrationsCancelImportEndpoint, - MigrationsCancelImportRequestOptions - ]; - "DELETE /repos/:owner/:repo/interaction-limits": [ - InteractionsRemoveRestrictionsForRepoEndpoint, - InteractionsRemoveRestrictionsForRepoRequestOptions - ]; - "DELETE /repos/:owner/:repo/invitations/:invitation_id": [ - ReposDeleteInvitationEndpoint, - ReposDeleteInvitationRequestOptions - ]; - "DELETE /repos/:owner/:repo/issues/:issue_number/assignees": [ - IssuesRemoveAssigneesEndpoint, - IssuesRemoveAssigneesRequestOptions - ]; - "DELETE /repos/:owner/:repo/issues/:issue_number/labels": [ - IssuesRemoveLabelsEndpoint, - IssuesRemoveLabelsRequestOptions - ]; - "DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name": [ - IssuesRemoveLabelEndpoint, - IssuesRemoveLabelRequestOptions - ]; - "DELETE /repos/:owner/:repo/issues/:issue_number/lock": [ - IssuesUnlockEndpoint, - IssuesUnlockRequestOptions - ]; - "DELETE /repos/:owner/:repo/issues/comments/:comment_id": [ - IssuesDeleteCommentEndpoint, - IssuesDeleteCommentRequestOptions - ]; - "DELETE /repos/:owner/:repo/keys/:key_id": [ - ReposRemoveDeployKeyEndpoint, - ReposRemoveDeployKeyRequestOptions - ]; - "DELETE /repos/:owner/:repo/labels/:name": [ - IssuesDeleteLabelEndpoint, - IssuesDeleteLabelRequestOptions - ]; - "DELETE /repos/:owner/:repo/milestones/:milestone_number": [ - IssuesDeleteMilestoneEndpoint, - IssuesDeleteMilestoneRequestOptions - ]; - "DELETE /repos/:owner/:repo/pages": [ - ReposDisablePagesSiteEndpoint, - ReposDisablePagesSiteRequestOptions - ]; - "DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ - PullsDeleteReviewRequestEndpoint, - PullsDeleteReviewRequestRequestOptions - ]; - "DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ - PullsDeletePendingReviewEndpoint, - PullsDeletePendingReviewRequestOptions - ]; - "DELETE /repos/:owner/:repo/pulls/comments/:comment_id": [ - PullsDeleteCommentEndpoint, - PullsDeleteCommentRequestOptions - ]; - "DELETE /repos/:owner/:repo/releases/:release_id": [ - ReposDeleteReleaseEndpoint, - ReposDeleteReleaseRequestOptions - ]; - "DELETE /repos/:owner/:repo/releases/assets/:asset_id": [ - ReposDeleteReleaseAssetEndpoint, - ReposDeleteReleaseAssetRequestOptions - ]; - "DELETE /repos/:owner/:repo/subscription": [ - ActivityDeleteRepoSubscriptionEndpoint, - ActivityDeleteRepoSubscriptionRequestOptions - ]; - "DELETE /repos/:owner/:repo/vulnerability-alerts": [ - ReposDisableVulnerabilityAlertsEndpoint, - ReposDisableVulnerabilityAlertsRequestOptions - ]; - "DELETE /scim/v2/organizations/:org/Users/:scim_user_id": [ - ScimRemoveUserFromOrgEndpoint, - ScimRemoveUserFromOrgRequestOptions - ]; - "DELETE /teams/:team_id": [TeamsDeleteEndpoint, TeamsDeleteRequestOptions]; - "DELETE /teams/:team_id/discussions/:discussion_number": [ - TeamsDeleteDiscussionEndpoint, - TeamsDeleteDiscussionRequestOptions - ]; - "DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ - TeamsDeleteDiscussionCommentEndpoint, - TeamsDeleteDiscussionCommentRequestOptions - ]; - "DELETE /teams/:team_id/members/:username": [ - TeamsRemoveMemberEndpoint, - TeamsRemoveMemberRequestOptions - ]; - "DELETE /teams/:team_id/memberships/:username": [ - TeamsRemoveMembershipEndpoint, - TeamsRemoveMembershipRequestOptions - ]; - "DELETE /teams/:team_id/projects/:project_id": [ - TeamsRemoveProjectEndpoint, - TeamsRemoveProjectRequestOptions - ]; - "DELETE /teams/:team_id/repos/:owner/:repo": [ - TeamsRemoveRepoEndpoint, - TeamsRemoveRepoRequestOptions - ]; - "DELETE /user/blocks/:username": [ - UsersUnblockEndpoint, - UsersUnblockRequestOptions - ]; - "DELETE /user/emails": [ - UsersDeleteEmailsEndpoint, - UsersDeleteEmailsRequestOptions - ]; - "DELETE /user/following/:username": [ - UsersUnfollowEndpoint, - UsersUnfollowRequestOptions - ]; - "DELETE /user/gpg_keys/:gpg_key_id": [ - UsersDeleteGpgKeyEndpoint, - UsersDeleteGpgKeyRequestOptions - ]; - "DELETE /user/installations/:installation_id/repositories/:repository_id": [ - AppsRemoveRepoFromInstallationEndpoint, - AppsRemoveRepoFromInstallationRequestOptions - ]; - "DELETE /user/keys/:key_id": [ - UsersDeletePublicKeyEndpoint, - UsersDeletePublicKeyRequestOptions - ]; - "DELETE /user/migrations/:migration_id/archive": [ - MigrationsDeleteArchiveForAuthenticatedUserEndpoint, - MigrationsDeleteArchiveForAuthenticatedUserRequestOptions - ]; - "DELETE /user/migrations/:migration_id/repos/:repo_name/lock": [ - MigrationsUnlockRepoForAuthenticatedUserEndpoint, - MigrationsUnlockRepoForAuthenticatedUserRequestOptions - ]; - "DELETE /user/repository_invitations/:invitation_id": [ - ReposDeclineInvitationEndpoint, - ReposDeclineInvitationRequestOptions - ]; - "DELETE /user/starred/:owner/:repo": [ - ActivityUnstarRepoEndpoint, - ActivityUnstarRepoRequestOptions - ]; - "DELETE /user/subscriptions/:owner/:repo": [ - ActivityStopWatchingRepoLegacyEndpoint, - ActivityStopWatchingRepoLegacyRequestOptions - ]; - "GET /app": [ - AppsGetAuthenticatedEndpoint, - AppsGetAuthenticatedRequestOptions - ]; - "GET /app/installations": [ - AppsListInstallationsEndpoint, - AppsListInstallationsRequestOptions - ]; - "GET /app/installations/:installation_id": [ - AppsGetInstallationEndpoint, - AppsGetInstallationRequestOptions - ]; - "GET /applications/:client_id/tokens/:access_token": [ - OauthAuthorizationsCheckAuthorizationEndpoint, - OauthAuthorizationsCheckAuthorizationRequestOptions - ]; - "GET /applications/grants": [ - OauthAuthorizationsListGrantsEndpoint, - OauthAuthorizationsListGrantsRequestOptions - ]; - "GET /applications/grants/:grant_id": [ - OauthAuthorizationsGetGrantEndpoint, - OauthAuthorizationsGetGrantRequestOptions - ]; - "GET /apps/:app_slug": [AppsGetBySlugEndpoint, AppsGetBySlugRequestOptions]; - "GET /authorizations": [ - OauthAuthorizationsListAuthorizationsEndpoint, - OauthAuthorizationsListAuthorizationsRequestOptions - ]; - "GET /authorizations/:authorization_id": [ - OauthAuthorizationsGetAuthorizationEndpoint, - OauthAuthorizationsGetAuthorizationRequestOptions - ]; - "GET /codes_of_conduct": [ - CodesOfConductListConductCodesEndpoint, - CodesOfConductListConductCodesRequestOptions - ]; - "GET /codes_of_conduct/:key": [ - CodesOfConductGetConductCodeEndpoint, - CodesOfConductGetConductCodeRequestOptions - ]; - "GET /emojis": [EmojisGetEndpoint, EmojisGetRequestOptions]; - "GET /events": [ - ActivityListPublicEventsEndpoint, - ActivityListPublicEventsRequestOptions - ]; - "GET /feeds": [ActivityListFeedsEndpoint, ActivityListFeedsRequestOptions]; - "GET /gists": [GistsListEndpoint, GistsListRequestOptions]; - "GET /gists/:gist_id": [GistsGetEndpoint, GistsGetRequestOptions]; - "GET /gists/:gist_id/:sha": [ - GistsGetRevisionEndpoint, - GistsGetRevisionRequestOptions - ]; - "GET /gists/:gist_id/comments": [ - GistsListCommentsEndpoint, - GistsListCommentsRequestOptions - ]; - "GET /gists/:gist_id/comments/:comment_id": [ - GistsGetCommentEndpoint, - GistsGetCommentRequestOptions - ]; - "GET /gists/:gist_id/commits": [ - GistsListCommitsEndpoint, - GistsListCommitsRequestOptions - ]; - "GET /gists/:gist_id/forks": [ - GistsListForksEndpoint, - GistsListForksRequestOptions - ]; - "GET /gists/:gist_id/star": [ - GistsCheckIsStarredEndpoint, - GistsCheckIsStarredRequestOptions - ]; - "GET /gists/public": [GistsListPublicEndpoint, GistsListPublicRequestOptions]; - "GET /gists/starred": [ - GistsListStarredEndpoint, - GistsListStarredRequestOptions - ]; - "GET /gitignore/templates": [ - GitignoreListTemplatesEndpoint, - GitignoreListTemplatesRequestOptions - ]; - "GET /gitignore/templates/:name": [ - GitignoreGetTemplateEndpoint, - GitignoreGetTemplateRequestOptions - ]; - "GET /installation/repositories": [ - AppsListReposEndpoint, - AppsListReposRequestOptions - ]; - "GET /issues": [IssuesListEndpoint, IssuesListRequestOptions]; - "GET /legacy/issues/search/:owner/:repository/:state/:keyword": [ - SearchIssuesLegacyEndpoint, - SearchIssuesLegacyRequestOptions - ]; - "GET /legacy/repos/search/:keyword": [ - SearchReposLegacyEndpoint, - SearchReposLegacyRequestOptions - ]; - "GET /legacy/user/email/:email": [ - SearchEmailLegacyEndpoint, - SearchEmailLegacyRequestOptions - ]; - "GET /legacy/user/search/:keyword": [ - SearchUsersLegacyEndpoint, - SearchUsersLegacyRequestOptions - ]; - "GET /licenses": [ - LicensesListCommonlyUsedEndpoint | LicensesListEndpoint, - LicensesListCommonlyUsedRequestOptions | LicensesListRequestOptions - ]; - "GET /licenses/:license": [LicensesGetEndpoint, LicensesGetRequestOptions]; - "GET /marketplace_listing/accounts/:account_id": [ - AppsCheckAccountIsAssociatedWithAnyEndpoint, - AppsCheckAccountIsAssociatedWithAnyRequestOptions - ]; - "GET /marketplace_listing/plans": [ - AppsListPlansEndpoint, - AppsListPlansRequestOptions - ]; - "GET /marketplace_listing/plans/:plan_id/accounts": [ - AppsListAccountsUserOrOrgOnPlanEndpoint, - AppsListAccountsUserOrOrgOnPlanRequestOptions - ]; - "GET /marketplace_listing/stubbed/accounts/:account_id": [ - AppsCheckAccountIsAssociatedWithAnyStubbedEndpoint, - AppsCheckAccountIsAssociatedWithAnyStubbedRequestOptions - ]; - "GET /marketplace_listing/stubbed/plans": [ - AppsListPlansStubbedEndpoint, - AppsListPlansStubbedRequestOptions - ]; - "GET /marketplace_listing/stubbed/plans/:plan_id/accounts": [ - AppsListAccountsUserOrOrgOnPlanStubbedEndpoint, - AppsListAccountsUserOrOrgOnPlanStubbedRequestOptions - ]; - "GET /meta": [MetaGetEndpoint, MetaGetRequestOptions]; - "GET /networks/:owner/:repo/events": [ - ActivityListPublicEventsForRepoNetworkEndpoint, - ActivityListPublicEventsForRepoNetworkRequestOptions - ]; - "GET /notifications": [ - ActivityListNotificationsEndpoint, - ActivityListNotificationsRequestOptions - ]; - "GET /notifications/threads/:thread_id": [ - ActivityGetThreadEndpoint, - ActivityGetThreadRequestOptions - ]; - "GET /notifications/threads/:thread_id/subscription": [ - ActivityGetThreadSubscriptionEndpoint, - ActivityGetThreadSubscriptionRequestOptions - ]; - "GET /organizations": [OrgsListEndpoint, OrgsListRequestOptions]; - "GET /orgs/:org": [OrgsGetEndpoint, OrgsGetRequestOptions]; - "GET /orgs/:org/blocks": [ - OrgsListBlockedUsersEndpoint, - OrgsListBlockedUsersRequestOptions - ]; - "GET /orgs/:org/blocks/:username": [ - OrgsCheckBlockedUserEndpoint, - OrgsCheckBlockedUserRequestOptions - ]; - "GET /orgs/:org/credential-authorizations": [ - OrgsListCredentialAuthorizationsEndpoint, - OrgsListCredentialAuthorizationsRequestOptions - ]; - "GET /orgs/:org/events": [ - ActivityListPublicEventsForOrgEndpoint, - ActivityListPublicEventsForOrgRequestOptions - ]; - "GET /orgs/:org/hooks": [OrgsListHooksEndpoint, OrgsListHooksRequestOptions]; - "GET /orgs/:org/hooks/:hook_id": [ - OrgsGetHookEndpoint, - OrgsGetHookRequestOptions - ]; - "GET /orgs/:org/installation": [ - AppsGetOrgInstallationEndpoint | AppsFindOrgInstallationEndpoint, - AppsGetOrgInstallationRequestOptions | AppsFindOrgInstallationRequestOptions - ]; - "GET /orgs/:org/interaction-limits": [ - InteractionsGetRestrictionsForOrgEndpoint, - InteractionsGetRestrictionsForOrgRequestOptions - ]; - "GET /orgs/:org/invitations": [ - OrgsListPendingInvitationsEndpoint, - OrgsListPendingInvitationsRequestOptions - ]; - "GET /orgs/:org/invitations/:invitation_id/teams": [ - OrgsListInvitationTeamsEndpoint, - OrgsListInvitationTeamsRequestOptions - ]; - "GET /orgs/:org/issues": [ - IssuesListForOrgEndpoint, - IssuesListForOrgRequestOptions - ]; - "GET /orgs/:org/members": [ - OrgsListMembersEndpoint, - OrgsListMembersRequestOptions - ]; - "GET /orgs/:org/members/:username": [ - OrgsCheckMembershipEndpoint, - OrgsCheckMembershipRequestOptions - ]; - "GET /orgs/:org/memberships/:username": [ - OrgsGetMembershipEndpoint, - OrgsGetMembershipRequestOptions - ]; - "GET /orgs/:org/migrations": [ - MigrationsListForOrgEndpoint, - MigrationsListForOrgRequestOptions - ]; - "GET /orgs/:org/migrations/:migration_id": [ - MigrationsGetStatusForOrgEndpoint, - MigrationsGetStatusForOrgRequestOptions - ]; - "GET /orgs/:org/migrations/:migration_id/archive": [ - MigrationsGetArchiveForOrgEndpoint, - MigrationsGetArchiveForOrgRequestOptions - ]; - "GET /orgs/:org/outside_collaborators": [ - OrgsListOutsideCollaboratorsEndpoint, - OrgsListOutsideCollaboratorsRequestOptions - ]; - "GET /orgs/:org/projects": [ - ProjectsListForOrgEndpoint, - ProjectsListForOrgRequestOptions - ]; - "GET /orgs/:org/public_members": [ - OrgsListPublicMembersEndpoint, - OrgsListPublicMembersRequestOptions - ]; - "GET /orgs/:org/public_members/:username": [ - OrgsCheckPublicMembershipEndpoint, - OrgsCheckPublicMembershipRequestOptions - ]; - "GET /orgs/:org/repos": [ - ReposListForOrgEndpoint, - ReposListForOrgRequestOptions - ]; - "GET /orgs/:org/team-sync/groups": [ - TeamsListIdPGroupsForOrgEndpoint, - TeamsListIdPGroupsForOrgRequestOptions - ]; - "GET /orgs/:org/teams": [TeamsListEndpoint, TeamsListRequestOptions]; - "GET /orgs/:org/teams/:team_slug": [ - TeamsGetByNameEndpoint, - TeamsGetByNameRequestOptions - ]; - "GET /projects/:project_id": [ProjectsGetEndpoint, ProjectsGetRequestOptions]; - "GET /projects/:project_id/collaborators": [ - ProjectsListCollaboratorsEndpoint, - ProjectsListCollaboratorsRequestOptions - ]; - "GET /projects/:project_id/collaborators/:username/permission": [ - ProjectsReviewUserPermissionLevelEndpoint, - ProjectsReviewUserPermissionLevelRequestOptions - ]; - "GET /projects/:project_id/columns": [ - ProjectsListColumnsEndpoint, - ProjectsListColumnsRequestOptions - ]; - "GET /projects/columns/:column_id": [ - ProjectsGetColumnEndpoint, - ProjectsGetColumnRequestOptions - ]; - "GET /projects/columns/:column_id/cards": [ - ProjectsListCardsEndpoint, - ProjectsListCardsRequestOptions - ]; - "GET /projects/columns/cards/:card_id": [ - ProjectsGetCardEndpoint, - ProjectsGetCardRequestOptions - ]; - "GET /rate_limit": [RateLimitGetEndpoint, RateLimitGetRequestOptions]; - "GET /repos/:owner/:repo": [ReposGetEndpoint, ReposGetRequestOptions]; - "GET /repos/:owner/:repo/:archive_format/:ref": [ - ReposGetArchiveLinkEndpoint, - ReposGetArchiveLinkRequestOptions - ]; - "GET /repos/:owner/:repo/assignees": [ - IssuesListAssigneesEndpoint, - IssuesListAssigneesRequestOptions - ]; - "GET /repos/:owner/:repo/assignees/:assignee": [ - IssuesCheckAssigneeEndpoint, - IssuesCheckAssigneeRequestOptions - ]; - "GET /repos/:owner/:repo/branches": [ - ReposListBranchesEndpoint, - ReposListBranchesRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch": [ - ReposGetBranchEndpoint, - ReposGetBranchRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection": [ - ReposGetBranchProtectionEndpoint, - ReposGetBranchProtectionRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ - ReposGetProtectedBranchAdminEnforcementEndpoint, - ReposGetProtectedBranchAdminEnforcementRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ - ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint, - ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ - ReposGetProtectedBranchRequiredSignaturesEndpoint, - ReposGetProtectedBranchRequiredSignaturesRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ - ReposGetProtectedBranchRequiredStatusChecksEndpoint, - ReposGetProtectedBranchRequiredStatusChecksRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ - ReposListProtectedBranchRequiredStatusChecksContextsEndpoint, - ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/restrictions": [ - ReposGetProtectedBranchRestrictionsEndpoint, - ReposGetProtectedBranchRestrictionsRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ - - | ReposGetAppsWithAccessToProtectedBranchEndpoint - | ReposListAppsWithAccessToProtectedBranchEndpoint, - - | ReposGetAppsWithAccessToProtectedBranchRequestOptions - | ReposListAppsWithAccessToProtectedBranchRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ - - | ReposGetTeamsWithAccessToProtectedBranchEndpoint - | ReposListProtectedBranchTeamRestrictionsEndpoint - | ReposListTeamsWithAccessToProtectedBranchEndpoint, - - | ReposGetTeamsWithAccessToProtectedBranchRequestOptions - | ReposListProtectedBranchTeamRestrictionsRequestOptions - | ReposListTeamsWithAccessToProtectedBranchRequestOptions - ]; - "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ - - | ReposGetUsersWithAccessToProtectedBranchEndpoint - | ReposListProtectedBranchUserRestrictionsEndpoint - | ReposListUsersWithAccessToProtectedBranchEndpoint, - - | ReposGetUsersWithAccessToProtectedBranchRequestOptions - | ReposListProtectedBranchUserRestrictionsRequestOptions - | ReposListUsersWithAccessToProtectedBranchRequestOptions - ]; - "GET /repos/:owner/:repo/check-runs/:check_run_id": [ - ChecksGetEndpoint, - ChecksGetRequestOptions - ]; - "GET /repos/:owner/:repo/check-runs/:check_run_id/annotations": [ - ChecksListAnnotationsEndpoint, - ChecksListAnnotationsRequestOptions - ]; - "GET /repos/:owner/:repo/check-suites/:check_suite_id": [ - ChecksGetSuiteEndpoint, - ChecksGetSuiteRequestOptions - ]; - "GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs": [ - ChecksListForSuiteEndpoint, - ChecksListForSuiteRequestOptions - ]; - "GET /repos/:owner/:repo/collaborators": [ - ReposListCollaboratorsEndpoint, - ReposListCollaboratorsRequestOptions - ]; - "GET /repos/:owner/:repo/collaborators/:username": [ - ReposCheckCollaboratorEndpoint, - ReposCheckCollaboratorRequestOptions - ]; - "GET /repos/:owner/:repo/collaborators/:username/permission": [ - ReposGetCollaboratorPermissionLevelEndpoint, - ReposGetCollaboratorPermissionLevelRequestOptions - ]; - "GET /repos/:owner/:repo/comments": [ - ReposListCommitCommentsEndpoint, - ReposListCommitCommentsRequestOptions - ]; - "GET /repos/:owner/:repo/comments/:comment_id": [ - ReposGetCommitCommentEndpoint, - ReposGetCommitCommentRequestOptions - ]; - "GET /repos/:owner/:repo/comments/:comment_id/reactions": [ - ReactionsListForCommitCommentEndpoint, - ReactionsListForCommitCommentRequestOptions - ]; - "GET /repos/:owner/:repo/commits": [ - ReposListCommitsEndpoint, - ReposListCommitsRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:commit_sha/branches-where-head": [ - ReposListBranchesForHeadCommitEndpoint, - ReposListBranchesForHeadCommitRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:commit_sha/comments": [ - ReposListCommentsForCommitEndpoint, - ReposListCommentsForCommitRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:commit_sha/pulls": [ - ReposListPullRequestsAssociatedWithCommitEndpoint, - ReposListPullRequestsAssociatedWithCommitRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:ref": [ - ReposGetCommitEndpoint, - ReposGetCommitRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:ref/check-runs": [ - ChecksListForRefEndpoint, - ChecksListForRefRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:ref/check-suites": [ - ChecksListSuitesForRefEndpoint, - ChecksListSuitesForRefRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:ref/status": [ - ReposGetCombinedStatusForRefEndpoint, - ReposGetCombinedStatusForRefRequestOptions - ]; - "GET /repos/:owner/:repo/commits/:ref/statuses": [ - ReposListStatusesForRefEndpoint, - ReposListStatusesForRefRequestOptions - ]; - "GET /repos/:owner/:repo/community/code_of_conduct": [ - CodesOfConductGetForRepoEndpoint, - CodesOfConductGetForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/community/profile": [ - ReposRetrieveCommunityProfileMetricsEndpoint, - ReposRetrieveCommunityProfileMetricsRequestOptions - ]; - "GET /repos/:owner/:repo/compare/:base...:head": [ - ReposCompareCommitsEndpoint, - ReposCompareCommitsRequestOptions - ]; - "GET /repos/:owner/:repo/contents/:path": [ - ReposGetContentsEndpoint, - ReposGetContentsRequestOptions - ]; - "GET /repos/:owner/:repo/contributors": [ - ReposListContributorsEndpoint, - ReposListContributorsRequestOptions - ]; - "GET /repos/:owner/:repo/deployments": [ - ReposListDeploymentsEndpoint, - ReposListDeploymentsRequestOptions - ]; - "GET /repos/:owner/:repo/deployments/:deployment_id": [ - ReposGetDeploymentEndpoint, - ReposGetDeploymentRequestOptions - ]; - "GET /repos/:owner/:repo/deployments/:deployment_id/statuses": [ - ReposListDeploymentStatusesEndpoint, - ReposListDeploymentStatusesRequestOptions - ]; - "GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id": [ - ReposGetDeploymentStatusEndpoint, - ReposGetDeploymentStatusRequestOptions - ]; - "GET /repos/:owner/:repo/downloads": [ - ReposListDownloadsEndpoint, - ReposListDownloadsRequestOptions - ]; - "GET /repos/:owner/:repo/downloads/:download_id": [ - ReposGetDownloadEndpoint, - ReposGetDownloadRequestOptions - ]; - "GET /repos/:owner/:repo/events": [ - ActivityListRepoEventsEndpoint, - ActivityListRepoEventsRequestOptions - ]; - "GET /repos/:owner/:repo/forks": [ - ReposListForksEndpoint, - ReposListForksRequestOptions - ]; - "GET /repos/:owner/:repo/git/blobs/:file_sha": [ - GitGetBlobEndpoint, - GitGetBlobRequestOptions - ]; - "GET /repos/:owner/:repo/git/commits/:commit_sha": [ - GitGetCommitEndpoint, - GitGetCommitRequestOptions - ]; - "GET /repos/:owner/:repo/git/matching-refs/:ref": [ - GitListMatchingRefsEndpoint, - GitListMatchingRefsRequestOptions - ]; - "GET /repos/:owner/:repo/git/ref/:ref": [ - GitGetRefEndpoint, - GitGetRefRequestOptions - ]; - "GET /repos/:owner/:repo/git/tags/:tag_sha": [ - GitGetTagEndpoint, - GitGetTagRequestOptions - ]; - "GET /repos/:owner/:repo/git/trees/:tree_sha": [ - GitGetTreeEndpoint, - GitGetTreeRequestOptions - ]; - "GET /repos/:owner/:repo/hooks": [ - ReposListHooksEndpoint, - ReposListHooksRequestOptions - ]; - "GET /repos/:owner/:repo/hooks/:hook_id": [ - ReposGetHookEndpoint, - ReposGetHookRequestOptions - ]; - "GET /repos/:owner/:repo/import": [ - MigrationsGetImportProgressEndpoint, - MigrationsGetImportProgressRequestOptions - ]; - "GET /repos/:owner/:repo/import/authors": [ - MigrationsGetCommitAuthorsEndpoint, - MigrationsGetCommitAuthorsRequestOptions - ]; - "GET /repos/:owner/:repo/import/large_files": [ - MigrationsGetLargeFilesEndpoint, - MigrationsGetLargeFilesRequestOptions - ]; - "GET /repos/:owner/:repo/installation": [ - AppsGetRepoInstallationEndpoint | AppsFindRepoInstallationEndpoint, - - | AppsGetRepoInstallationRequestOptions - | AppsFindRepoInstallationRequestOptions - ]; - "GET /repos/:owner/:repo/interaction-limits": [ - InteractionsGetRestrictionsForRepoEndpoint, - InteractionsGetRestrictionsForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/invitations": [ - ReposListInvitationsEndpoint, - ReposListInvitationsRequestOptions - ]; - "GET /repos/:owner/:repo/issues": [ - IssuesListForRepoEndpoint, - IssuesListForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/issues/:issue_number": [ - IssuesGetEndpoint, - IssuesGetRequestOptions - ]; - "GET /repos/:owner/:repo/issues/:issue_number/comments": [ - IssuesListCommentsEndpoint, - IssuesListCommentsRequestOptions - ]; - "GET /repos/:owner/:repo/issues/:issue_number/events": [ - IssuesListEventsEndpoint, - IssuesListEventsRequestOptions - ]; - "GET /repos/:owner/:repo/issues/:issue_number/labels": [ - IssuesListLabelsOnIssueEndpoint, - IssuesListLabelsOnIssueRequestOptions - ]; - "GET /repos/:owner/:repo/issues/:issue_number/reactions": [ - ReactionsListForIssueEndpoint, - ReactionsListForIssueRequestOptions - ]; - "GET /repos/:owner/:repo/issues/:issue_number/timeline": [ - IssuesListEventsForTimelineEndpoint, - IssuesListEventsForTimelineRequestOptions - ]; - "GET /repos/:owner/:repo/issues/comments": [ - IssuesListCommentsForRepoEndpoint, - IssuesListCommentsForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/issues/comments/:comment_id": [ - IssuesGetCommentEndpoint, - IssuesGetCommentRequestOptions - ]; - "GET /repos/:owner/:repo/issues/comments/:comment_id/reactions": [ - ReactionsListForIssueCommentEndpoint, - ReactionsListForIssueCommentRequestOptions - ]; - "GET /repos/:owner/:repo/issues/events": [ - IssuesListEventsForRepoEndpoint, - IssuesListEventsForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/issues/events/:event_id": [ - IssuesGetEventEndpoint, - IssuesGetEventRequestOptions - ]; - "GET /repos/:owner/:repo/keys": [ - ReposListDeployKeysEndpoint, - ReposListDeployKeysRequestOptions - ]; - "GET /repos/:owner/:repo/keys/:key_id": [ - ReposGetDeployKeyEndpoint, - ReposGetDeployKeyRequestOptions - ]; - "GET /repos/:owner/:repo/labels": [ - IssuesListLabelsForRepoEndpoint, - IssuesListLabelsForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/labels/:name": [ - IssuesGetLabelEndpoint, - IssuesGetLabelRequestOptions - ]; - "GET /repos/:owner/:repo/languages": [ - ReposListLanguagesEndpoint, - ReposListLanguagesRequestOptions - ]; - "GET /repos/:owner/:repo/license": [ - LicensesGetForRepoEndpoint, - LicensesGetForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/milestones": [ - IssuesListMilestonesForRepoEndpoint, - IssuesListMilestonesForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/milestones/:milestone_number": [ - IssuesGetMilestoneEndpoint, - IssuesGetMilestoneRequestOptions - ]; - "GET /repos/:owner/:repo/milestones/:milestone_number/labels": [ - IssuesListLabelsForMilestoneEndpoint, - IssuesListLabelsForMilestoneRequestOptions - ]; - "GET /repos/:owner/:repo/notifications": [ - ActivityListNotificationsForRepoEndpoint, - ActivityListNotificationsForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/pages": [ - ReposGetPagesEndpoint, - ReposGetPagesRequestOptions - ]; - "GET /repos/:owner/:repo/pages/builds": [ - ReposListPagesBuildsEndpoint, - ReposListPagesBuildsRequestOptions - ]; - "GET /repos/:owner/:repo/pages/builds/:build_id": [ - ReposGetPagesBuildEndpoint, - ReposGetPagesBuildRequestOptions - ]; - "GET /repos/:owner/:repo/pages/builds/latest": [ - ReposGetLatestPagesBuildEndpoint, - ReposGetLatestPagesBuildRequestOptions - ]; - "GET /repos/:owner/:repo/projects": [ - ProjectsListForRepoEndpoint, - ProjectsListForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/pulls": [PullsListEndpoint, PullsListRequestOptions]; - "GET /repos/:owner/:repo/pulls/:pull_number": [ - PullsGetEndpoint, - PullsGetRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/comments": [ - PullsListCommentsEndpoint, - PullsListCommentsRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/commits": [ - PullsListCommitsEndpoint, - PullsListCommitsRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/files": [ - PullsListFilesEndpoint, - PullsListFilesRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/merge": [ - PullsCheckIfMergedEndpoint, - PullsCheckIfMergedRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ - PullsListReviewRequestsEndpoint, - PullsListReviewRequestsRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/reviews": [ - PullsListReviewsEndpoint, - PullsListReviewsRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ - PullsGetReviewEndpoint, - PullsGetReviewRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments": [ - PullsGetCommentsForReviewEndpoint, - PullsGetCommentsForReviewRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/comments": [ - PullsListCommentsForRepoEndpoint, - PullsListCommentsForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/comments/:comment_id": [ - PullsGetCommentEndpoint, - PullsGetCommentRequestOptions - ]; - "GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions": [ - ReactionsListForPullRequestReviewCommentEndpoint, - ReactionsListForPullRequestReviewCommentRequestOptions - ]; - "GET /repos/:owner/:repo/readme": [ - ReposGetReadmeEndpoint, - ReposGetReadmeRequestOptions - ]; - "GET /repos/:owner/:repo/releases": [ - ReposListReleasesEndpoint, - ReposListReleasesRequestOptions - ]; - "GET /repos/:owner/:repo/releases/:release_id": [ - ReposGetReleaseEndpoint, - ReposGetReleaseRequestOptions - ]; - "GET /repos/:owner/:repo/releases/:release_id/assets": [ - ReposListAssetsForReleaseEndpoint, - ReposListAssetsForReleaseRequestOptions - ]; - "GET /repos/:owner/:repo/releases/assets/:asset_id": [ - ReposGetReleaseAssetEndpoint, - ReposGetReleaseAssetRequestOptions - ]; - "GET /repos/:owner/:repo/releases/latest": [ - ReposGetLatestReleaseEndpoint, - ReposGetLatestReleaseRequestOptions - ]; - "GET /repos/:owner/:repo/releases/tags/:tag": [ - ReposGetReleaseByTagEndpoint, - ReposGetReleaseByTagRequestOptions - ]; - "GET /repos/:owner/:repo/stargazers": [ - ActivityListStargazersForRepoEndpoint, - ActivityListStargazersForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/stats/code_frequency": [ - ReposGetCodeFrequencyStatsEndpoint, - ReposGetCodeFrequencyStatsRequestOptions - ]; - "GET /repos/:owner/:repo/stats/commit_activity": [ - ReposGetCommitActivityStatsEndpoint, - ReposGetCommitActivityStatsRequestOptions - ]; - "GET /repos/:owner/:repo/stats/contributors": [ - ReposGetContributorsStatsEndpoint, - ReposGetContributorsStatsRequestOptions - ]; - "GET /repos/:owner/:repo/stats/participation": [ - ReposGetParticipationStatsEndpoint, - ReposGetParticipationStatsRequestOptions - ]; - "GET /repos/:owner/:repo/stats/punch_card": [ - ReposGetPunchCardStatsEndpoint, - ReposGetPunchCardStatsRequestOptions - ]; - "GET /repos/:owner/:repo/subscribers": [ - ActivityListWatchersForRepoEndpoint, - ActivityListWatchersForRepoRequestOptions - ]; - "GET /repos/:owner/:repo/subscription": [ - ActivityGetRepoSubscriptionEndpoint, - ActivityGetRepoSubscriptionRequestOptions - ]; - "GET /repos/:owner/:repo/tags": [ - ReposListTagsEndpoint, - ReposListTagsRequestOptions - ]; - "GET /repos/:owner/:repo/teams": [ - ReposListTeamsEndpoint, - ReposListTeamsRequestOptions - ]; - "GET /repos/:owner/:repo/topics": [ - ReposListTopicsEndpoint, - ReposListTopicsRequestOptions - ]; - "GET /repos/:owner/:repo/traffic/clones": [ - ReposGetClonesEndpoint, - ReposGetClonesRequestOptions - ]; - "GET /repos/:owner/:repo/traffic/popular/paths": [ - ReposGetTopPathsEndpoint, - ReposGetTopPathsRequestOptions - ]; - "GET /repos/:owner/:repo/traffic/popular/referrers": [ - ReposGetTopReferrersEndpoint, - ReposGetTopReferrersRequestOptions - ]; - "GET /repos/:owner/:repo/traffic/views": [ - ReposGetViewsEndpoint, - ReposGetViewsRequestOptions - ]; - "GET /repos/:owner/:repo/vulnerability-alerts": [ - ReposCheckVulnerabilityAlertsEndpoint, - ReposCheckVulnerabilityAlertsRequestOptions - ]; - "GET /repositories": [ReposListPublicEndpoint, ReposListPublicRequestOptions]; - "GET /scim/v2/organizations/:org/Users": [ - ScimListProvisionedIdentitiesEndpoint, - ScimListProvisionedIdentitiesRequestOptions - ]; - "GET /scim/v2/organizations/:org/Users/:scim_user_id": [ - ScimGetProvisioningDetailsForUserEndpoint, - ScimGetProvisioningDetailsForUserRequestOptions - ]; - "GET /search/code": [SearchCodeEndpoint, SearchCodeRequestOptions]; - "GET /search/commits": [SearchCommitsEndpoint, SearchCommitsRequestOptions]; - "GET /search/issues": [ - SearchIssuesAndPullRequestsEndpoint | SearchIssuesEndpoint, - SearchIssuesAndPullRequestsRequestOptions | SearchIssuesRequestOptions - ]; - "GET /search/labels": [SearchLabelsEndpoint, SearchLabelsRequestOptions]; - "GET /search/repositories": [SearchReposEndpoint, SearchReposRequestOptions]; - "GET /search/topics": [SearchTopicsEndpoint, SearchTopicsRequestOptions]; - "GET /search/users": [SearchUsersEndpoint, SearchUsersRequestOptions]; - "GET /teams/:team_id": [TeamsGetEndpoint, TeamsGetRequestOptions]; - "GET /teams/:team_id/discussions": [ - TeamsListDiscussionsEndpoint, - TeamsListDiscussionsRequestOptions - ]; - "GET /teams/:team_id/discussions/:discussion_number": [ - TeamsGetDiscussionEndpoint, - TeamsGetDiscussionRequestOptions - ]; - "GET /teams/:team_id/discussions/:discussion_number/comments": [ - TeamsListDiscussionCommentsEndpoint, - TeamsListDiscussionCommentsRequestOptions - ]; - "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ - TeamsGetDiscussionCommentEndpoint, - TeamsGetDiscussionCommentRequestOptions - ]; - "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": [ - ReactionsListForTeamDiscussionCommentEndpoint, - ReactionsListForTeamDiscussionCommentRequestOptions - ]; - "GET /teams/:team_id/discussions/:discussion_number/reactions": [ - ReactionsListForTeamDiscussionEndpoint, - ReactionsListForTeamDiscussionRequestOptions - ]; - "GET /teams/:team_id/invitations": [ - TeamsListPendingInvitationsEndpoint, - TeamsListPendingInvitationsRequestOptions - ]; - "GET /teams/:team_id/members": [ - TeamsListMembersEndpoint, - TeamsListMembersRequestOptions - ]; - "GET /teams/:team_id/members/:username": [ - TeamsGetMemberEndpoint, - TeamsGetMemberRequestOptions - ]; - "GET /teams/:team_id/memberships/:username": [ - TeamsGetMembershipEndpoint, - TeamsGetMembershipRequestOptions - ]; - "GET /teams/:team_id/projects": [ - TeamsListProjectsEndpoint, - TeamsListProjectsRequestOptions - ]; - "GET /teams/:team_id/projects/:project_id": [ - TeamsReviewProjectEndpoint, - TeamsReviewProjectRequestOptions - ]; - "GET /teams/:team_id/repos": [ - TeamsListReposEndpoint, - TeamsListReposRequestOptions - ]; - "GET /teams/:team_id/repos/:owner/:repo": [ - TeamsCheckManagesRepoEndpoint, - TeamsCheckManagesRepoRequestOptions - ]; - "GET /teams/:team_id/team-sync/group-mappings": [ - TeamsListIdPGroupsEndpoint, - TeamsListIdPGroupsRequestOptions - ]; - "GET /teams/:team_id/teams": [ - TeamsListChildEndpoint, - TeamsListChildRequestOptions - ]; - "GET /user": [ - UsersGetAuthenticatedEndpoint, - UsersGetAuthenticatedRequestOptions - ]; - "GET /user/blocks": [ - UsersListBlockedEndpoint, - UsersListBlockedRequestOptions - ]; - "GET /user/blocks/:username": [ - UsersCheckBlockedEndpoint, - UsersCheckBlockedRequestOptions - ]; - "GET /user/emails": [UsersListEmailsEndpoint, UsersListEmailsRequestOptions]; - "GET /user/followers": [ - UsersListFollowersForAuthenticatedUserEndpoint, - UsersListFollowersForAuthenticatedUserRequestOptions - ]; - "GET /user/following": [ - UsersListFollowingForAuthenticatedUserEndpoint, - UsersListFollowingForAuthenticatedUserRequestOptions - ]; - "GET /user/following/:username": [ - UsersCheckFollowingEndpoint, - UsersCheckFollowingRequestOptions - ]; - "GET /user/gpg_keys": [ - UsersListGpgKeysEndpoint, - UsersListGpgKeysRequestOptions - ]; - "GET /user/gpg_keys/:gpg_key_id": [ - UsersGetGpgKeyEndpoint, - UsersGetGpgKeyRequestOptions - ]; - "GET /user/installations": [ - AppsListInstallationsForAuthenticatedUserEndpoint, - AppsListInstallationsForAuthenticatedUserRequestOptions - ]; - "GET /user/installations/:installation_id/repositories": [ - AppsListInstallationReposForAuthenticatedUserEndpoint, - AppsListInstallationReposForAuthenticatedUserRequestOptions - ]; - "GET /user/issues": [ - IssuesListForAuthenticatedUserEndpoint, - IssuesListForAuthenticatedUserRequestOptions - ]; - "GET /user/keys": [ - UsersListPublicKeysEndpoint, - UsersListPublicKeysRequestOptions - ]; - "GET /user/keys/:key_id": [ - UsersGetPublicKeyEndpoint, - UsersGetPublicKeyRequestOptions - ]; - "GET /user/marketplace_purchases": [ - AppsListMarketplacePurchasesForAuthenticatedUserEndpoint, - AppsListMarketplacePurchasesForAuthenticatedUserRequestOptions - ]; - "GET /user/marketplace_purchases/stubbed": [ - AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint, - AppsListMarketplacePurchasesForAuthenticatedUserStubbedRequestOptions - ]; - "GET /user/memberships/orgs": [ - OrgsListMembershipsEndpoint, - OrgsListMembershipsRequestOptions - ]; - "GET /user/memberships/orgs/:org": [ - OrgsGetMembershipForAuthenticatedUserEndpoint, - OrgsGetMembershipForAuthenticatedUserRequestOptions - ]; - "GET /user/migrations": [ - MigrationsListForAuthenticatedUserEndpoint, - MigrationsListForAuthenticatedUserRequestOptions - ]; - "GET /user/migrations/:migration_id": [ - MigrationsGetStatusForAuthenticatedUserEndpoint, - MigrationsGetStatusForAuthenticatedUserRequestOptions - ]; - "GET /user/migrations/:migration_id/archive": [ - MigrationsGetArchiveForAuthenticatedUserEndpoint, - MigrationsGetArchiveForAuthenticatedUserRequestOptions - ]; - "GET /user/orgs": [ - OrgsListForAuthenticatedUserEndpoint, - OrgsListForAuthenticatedUserRequestOptions - ]; - "GET /user/public_emails": [ - UsersListPublicEmailsEndpoint, - UsersListPublicEmailsRequestOptions - ]; - "GET /user/repos": [ReposListEndpoint, ReposListRequestOptions]; - "GET /user/repository_invitations": [ - ReposListInvitationsForAuthenticatedUserEndpoint, - ReposListInvitationsForAuthenticatedUserRequestOptions - ]; - "GET /user/starred": [ - ActivityListReposStarredByAuthenticatedUserEndpoint, - ActivityListReposStarredByAuthenticatedUserRequestOptions - ]; - "GET /user/starred/:owner/:repo": [ - ActivityCheckStarringRepoEndpoint, - ActivityCheckStarringRepoRequestOptions - ]; - "GET /user/subscriptions": [ - ActivityListWatchedReposForAuthenticatedUserEndpoint, - ActivityListWatchedReposForAuthenticatedUserRequestOptions - ]; - "GET /user/subscriptions/:owner/:repo": [ - ActivityCheckWatchingRepoLegacyEndpoint, - ActivityCheckWatchingRepoLegacyRequestOptions - ]; - "GET /user/teams": [ - TeamsListForAuthenticatedUserEndpoint, - TeamsListForAuthenticatedUserRequestOptions - ]; - "GET /users": [UsersListEndpoint, UsersListRequestOptions]; - "GET /users/:username": [ - UsersGetByUsernameEndpoint, - UsersGetByUsernameRequestOptions - ]; - "GET /users/:username/events": [ - ActivityListEventsForUserEndpoint, - ActivityListEventsForUserRequestOptions - ]; - "GET /users/:username/events/orgs/:org": [ - ActivityListEventsForOrgEndpoint, - ActivityListEventsForOrgRequestOptions - ]; - "GET /users/:username/events/public": [ - ActivityListPublicEventsForUserEndpoint, - ActivityListPublicEventsForUserRequestOptions - ]; - "GET /users/:username/followers": [ - UsersListFollowersForUserEndpoint, - UsersListFollowersForUserRequestOptions - ]; - "GET /users/:username/following": [ - UsersListFollowingForUserEndpoint, - UsersListFollowingForUserRequestOptions - ]; - "GET /users/:username/following/:target_user": [ - UsersCheckFollowingForUserEndpoint, - UsersCheckFollowingForUserRequestOptions - ]; - "GET /users/:username/gists": [ - GistsListPublicForUserEndpoint, - GistsListPublicForUserRequestOptions - ]; - "GET /users/:username/gpg_keys": [ - UsersListGpgKeysForUserEndpoint, - UsersListGpgKeysForUserRequestOptions - ]; - "GET /users/:username/hovercard": [ - UsersGetContextForUserEndpoint, - UsersGetContextForUserRequestOptions - ]; - "GET /users/:username/installation": [ - AppsGetUserInstallationEndpoint | AppsFindUserInstallationEndpoint, - - | AppsGetUserInstallationRequestOptions - | AppsFindUserInstallationRequestOptions - ]; - "GET /users/:username/keys": [ - UsersListPublicKeysForUserEndpoint, - UsersListPublicKeysForUserRequestOptions - ]; - "GET /users/:username/orgs": [ - OrgsListForUserEndpoint, - OrgsListForUserRequestOptions - ]; - "GET /users/:username/projects": [ - ProjectsListForUserEndpoint, - ProjectsListForUserRequestOptions - ]; - "GET /users/:username/received_events": [ - ActivityListReceivedEventsForUserEndpoint, - ActivityListReceivedEventsForUserRequestOptions - ]; - "GET /users/:username/received_events/public": [ - ActivityListReceivedPublicEventsForUserEndpoint, - ActivityListReceivedPublicEventsForUserRequestOptions - ]; - "GET /users/:username/repos": [ - ReposListForUserEndpoint, - ReposListForUserRequestOptions - ]; - "GET /users/:username/starred": [ - ActivityListReposStarredByUserEndpoint, - ActivityListReposStarredByUserRequestOptions - ]; - "GET /users/:username/subscriptions": [ - ActivityListReposWatchedByUserEndpoint, - ActivityListReposWatchedByUserRequestOptions - ]; - "PATCH /authorizations/:authorization_id": [ - OauthAuthorizationsUpdateAuthorizationEndpoint, - OauthAuthorizationsUpdateAuthorizationRequestOptions - ]; - "PATCH /gists/:gist_id": [GistsUpdateEndpoint, GistsUpdateRequestOptions]; - "PATCH /gists/:gist_id/comments/:comment_id": [ - GistsUpdateCommentEndpoint, - GistsUpdateCommentRequestOptions - ]; - "PATCH /notifications/threads/:thread_id": [ - ActivityMarkThreadAsReadEndpoint, - ActivityMarkThreadAsReadRequestOptions - ]; - "PATCH /orgs/:org": [OrgsUpdateEndpoint, OrgsUpdateRequestOptions]; - "PATCH /orgs/:org/hooks/:hook_id": [ - OrgsUpdateHookEndpoint, - OrgsUpdateHookRequestOptions - ]; - "PATCH /projects/:project_id": [ - ProjectsUpdateEndpoint, - ProjectsUpdateRequestOptions - ]; - "PATCH /projects/columns/:column_id": [ - ProjectsUpdateColumnEndpoint, - ProjectsUpdateColumnRequestOptions - ]; - "PATCH /projects/columns/cards/:card_id": [ - ProjectsUpdateCardEndpoint, - ProjectsUpdateCardRequestOptions - ]; - "PATCH /repos/:owner/:repo": [ReposUpdateEndpoint, ReposUpdateRequestOptions]; - "PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ - ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint, - ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions - ]; - "PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ - ReposUpdateProtectedBranchRequiredStatusChecksEndpoint, - ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions - ]; - "PATCH /repos/:owner/:repo/check-runs/:check_run_id": [ - ChecksUpdateEndpoint, - ChecksUpdateRequestOptions - ]; - "PATCH /repos/:owner/:repo/check-suites/preferences": [ - ChecksSetSuitesPreferencesEndpoint, - ChecksSetSuitesPreferencesRequestOptions - ]; - "PATCH /repos/:owner/:repo/comments/:comment_id": [ - ReposUpdateCommitCommentEndpoint, - ReposUpdateCommitCommentRequestOptions - ]; - "PATCH /repos/:owner/:repo/git/refs/:ref": [ - GitUpdateRefEndpoint, - GitUpdateRefRequestOptions - ]; - "PATCH /repos/:owner/:repo/hooks/:hook_id": [ - ReposUpdateHookEndpoint, - ReposUpdateHookRequestOptions - ]; - "PATCH /repos/:owner/:repo/import": [ - MigrationsUpdateImportEndpoint, - MigrationsUpdateImportRequestOptions - ]; - "PATCH /repos/:owner/:repo/import/authors/:author_id": [ - MigrationsMapCommitAuthorEndpoint, - MigrationsMapCommitAuthorRequestOptions - ]; - "PATCH /repos/:owner/:repo/import/lfs": [ - MigrationsSetLfsPreferenceEndpoint, - MigrationsSetLfsPreferenceRequestOptions - ]; - "PATCH /repos/:owner/:repo/invitations/:invitation_id": [ - ReposUpdateInvitationEndpoint, - ReposUpdateInvitationRequestOptions - ]; - "PATCH /repos/:owner/:repo/issues/:issue_number": [ - IssuesUpdateEndpoint, - IssuesUpdateRequestOptions - ]; - "PATCH /repos/:owner/:repo/issues/comments/:comment_id": [ - IssuesUpdateCommentEndpoint, - IssuesUpdateCommentRequestOptions - ]; - "PATCH /repos/:owner/:repo/labels/:name": [ - IssuesUpdateLabelEndpoint, - IssuesUpdateLabelRequestOptions - ]; - "PATCH /repos/:owner/:repo/milestones/:milestone_number": [ - IssuesUpdateMilestoneEndpoint, - IssuesUpdateMilestoneRequestOptions - ]; - "PATCH /repos/:owner/:repo/pulls/:pull_number": [ - PullsUpdateEndpoint, - PullsUpdateRequestOptions - ]; - "PATCH /repos/:owner/:repo/pulls/comments/:comment_id": [ - PullsUpdateCommentEndpoint, - PullsUpdateCommentRequestOptions - ]; - "PATCH /repos/:owner/:repo/releases/:release_id": [ - ReposUpdateReleaseEndpoint, - ReposUpdateReleaseRequestOptions - ]; - "PATCH /repos/:owner/:repo/releases/assets/:asset_id": [ - ReposUpdateReleaseAssetEndpoint, - ReposUpdateReleaseAssetRequestOptions - ]; - "PATCH /scim/v2/organizations/:org/Users/:scim_user_id": [ - ScimUpdateUserAttributeEndpoint, - ScimUpdateUserAttributeRequestOptions - ]; - "PATCH /teams/:team_id": [TeamsUpdateEndpoint, TeamsUpdateRequestOptions]; - "PATCH /teams/:team_id/discussions/:discussion_number": [ - TeamsUpdateDiscussionEndpoint, - TeamsUpdateDiscussionRequestOptions - ]; - "PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ - TeamsUpdateDiscussionCommentEndpoint, - TeamsUpdateDiscussionCommentRequestOptions - ]; - "PATCH /teams/:team_id/team-sync/group-mappings": [ - TeamsCreateOrUpdateIdPGroupConnectionsEndpoint, - TeamsCreateOrUpdateIdPGroupConnectionsRequestOptions - ]; - "PATCH /user": [ - UsersUpdateAuthenticatedEndpoint, - UsersUpdateAuthenticatedRequestOptions - ]; - "PATCH /user/email/visibility": [ - UsersTogglePrimaryEmailVisibilityEndpoint, - UsersTogglePrimaryEmailVisibilityRequestOptions - ]; - "PATCH /user/memberships/orgs/:org": [ - OrgsUpdateMembershipEndpoint, - OrgsUpdateMembershipRequestOptions - ]; - "PATCH /user/repository_invitations/:invitation_id": [ - ReposAcceptInvitationEndpoint, - ReposAcceptInvitationRequestOptions - ]; - "POST /app-manifests/:code/conversions": [ - AppsCreateFromManifestEndpoint, - AppsCreateFromManifestRequestOptions - ]; - "POST /app/installations/:installation_id/access_tokens": [ - AppsCreateInstallationTokenEndpoint, - AppsCreateInstallationTokenRequestOptions - ]; - "POST /applications/:client_id/tokens/:access_token": [ - OauthAuthorizationsResetAuthorizationEndpoint, - OauthAuthorizationsResetAuthorizationRequestOptions - ]; - "POST /authorizations": [ - OauthAuthorizationsCreateAuthorizationEndpoint, - OauthAuthorizationsCreateAuthorizationRequestOptions - ]; - "POST /content_references/:content_reference_id/attachments": [ - AppsCreateContentAttachmentEndpoint, - AppsCreateContentAttachmentRequestOptions - ]; - "POST /gists": [GistsCreateEndpoint, GistsCreateRequestOptions]; - "POST /gists/:gist_id/comments": [ - GistsCreateCommentEndpoint, - GistsCreateCommentRequestOptions - ]; - "POST /gists/:gist_id/forks": [GistsForkEndpoint, GistsForkRequestOptions]; - "POST /markdown": [MarkdownRenderEndpoint, MarkdownRenderRequestOptions]; - "POST /markdown/raw": [ - MarkdownRenderRawEndpoint, - MarkdownRenderRawRequestOptions - ]; - "POST /orgs/:org/hooks": [ - OrgsCreateHookEndpoint, - OrgsCreateHookRequestOptions - ]; - "POST /orgs/:org/hooks/:hook_id/pings": [ - OrgsPingHookEndpoint, - OrgsPingHookRequestOptions - ]; - "POST /orgs/:org/invitations": [ - OrgsCreateInvitationEndpoint, - OrgsCreateInvitationRequestOptions - ]; - "POST /orgs/:org/migrations": [ - MigrationsStartForOrgEndpoint, - MigrationsStartForOrgRequestOptions - ]; - "POST /orgs/:org/projects": [ - ProjectsCreateForOrgEndpoint, - ProjectsCreateForOrgRequestOptions - ]; - "POST /orgs/:org/repos": [ - ReposCreateInOrgEndpoint, - ReposCreateInOrgRequestOptions - ]; - "POST /orgs/:org/teams": [TeamsCreateEndpoint, TeamsCreateRequestOptions]; - "POST /projects/:project_id/columns": [ - ProjectsCreateColumnEndpoint, - ProjectsCreateColumnRequestOptions - ]; - "POST /projects/columns/:column_id/cards": [ - ProjectsCreateCardEndpoint, - ProjectsCreateCardRequestOptions - ]; - "POST /projects/columns/:column_id/moves": [ - ProjectsMoveColumnEndpoint, - ProjectsMoveColumnRequestOptions - ]; - "POST /projects/columns/cards/:card_id/moves": [ - ProjectsMoveCardEndpoint, - ProjectsMoveCardRequestOptions - ]; - "POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ - ReposAddProtectedBranchAdminEnforcementEndpoint, - ReposAddProtectedBranchAdminEnforcementRequestOptions - ]; - "POST /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ - ReposAddProtectedBranchRequiredSignaturesEndpoint, - ReposAddProtectedBranchRequiredSignaturesRequestOptions - ]; - "POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ - ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint, - ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions - ]; - "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ - ReposAddProtectedBranchAppRestrictionsEndpoint, - ReposAddProtectedBranchAppRestrictionsRequestOptions - ]; - "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ - ReposAddProtectedBranchTeamRestrictionsEndpoint, - ReposAddProtectedBranchTeamRestrictionsRequestOptions - ]; - "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ - ReposAddProtectedBranchUserRestrictionsEndpoint, - ReposAddProtectedBranchUserRestrictionsRequestOptions - ]; - "POST /repos/:owner/:repo/check-runs": [ - ChecksCreateEndpoint, - ChecksCreateRequestOptions - ]; - "POST /repos/:owner/:repo/check-suites": [ - ChecksCreateSuiteEndpoint, - ChecksCreateSuiteRequestOptions - ]; - "POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest": [ - ChecksRerequestSuiteEndpoint, - ChecksRerequestSuiteRequestOptions - ]; - "POST /repos/:owner/:repo/comments/:comment_id/reactions": [ - ReactionsCreateForCommitCommentEndpoint, - ReactionsCreateForCommitCommentRequestOptions - ]; - "POST /repos/:owner/:repo/commits/:commit_sha/comments": [ - ReposCreateCommitCommentEndpoint, - ReposCreateCommitCommentRequestOptions - ]; - "POST /repos/:owner/:repo/deployments": [ - ReposCreateDeploymentEndpoint, - ReposCreateDeploymentRequestOptions - ]; - "POST /repos/:owner/:repo/deployments/:deployment_id/statuses": [ - ReposCreateDeploymentStatusEndpoint, - ReposCreateDeploymentStatusRequestOptions - ]; - "POST /repos/:owner/:repo/dispatches": [ - ReposCreateDispatchEventEndpoint, - ReposCreateDispatchEventRequestOptions - ]; - "POST /repos/:owner/:repo/forks": [ - ReposCreateForkEndpoint, - ReposCreateForkRequestOptions - ]; - "POST /repos/:owner/:repo/git/blobs": [ - GitCreateBlobEndpoint, - GitCreateBlobRequestOptions - ]; - "POST /repos/:owner/:repo/git/commits": [ - GitCreateCommitEndpoint, - GitCreateCommitRequestOptions - ]; - "POST /repos/:owner/:repo/git/refs": [ - GitCreateRefEndpoint, - GitCreateRefRequestOptions - ]; - "POST /repos/:owner/:repo/git/tags": [ - GitCreateTagEndpoint, - GitCreateTagRequestOptions - ]; - "POST /repos/:owner/:repo/git/trees": [ - GitCreateTreeEndpoint, - GitCreateTreeRequestOptions - ]; - "POST /repos/:owner/:repo/hooks": [ - ReposCreateHookEndpoint, - ReposCreateHookRequestOptions - ]; - "POST /repos/:owner/:repo/hooks/:hook_id/pings": [ - ReposPingHookEndpoint, - ReposPingHookRequestOptions - ]; - "POST /repos/:owner/:repo/hooks/:hook_id/tests": [ - ReposTestPushHookEndpoint, - ReposTestPushHookRequestOptions - ]; - "POST /repos/:owner/:repo/issues": [ - IssuesCreateEndpoint, - IssuesCreateRequestOptions - ]; - "POST /repos/:owner/:repo/issues/:issue_number/assignees": [ - IssuesAddAssigneesEndpoint, - IssuesAddAssigneesRequestOptions - ]; - "POST /repos/:owner/:repo/issues/:issue_number/comments": [ - IssuesCreateCommentEndpoint, - IssuesCreateCommentRequestOptions - ]; - "POST /repos/:owner/:repo/issues/:issue_number/labels": [ - IssuesAddLabelsEndpoint, - IssuesAddLabelsRequestOptions - ]; - "POST /repos/:owner/:repo/issues/:issue_number/reactions": [ - ReactionsCreateForIssueEndpoint, - ReactionsCreateForIssueRequestOptions - ]; - "POST /repos/:owner/:repo/issues/comments/:comment_id/reactions": [ - ReactionsCreateForIssueCommentEndpoint, - ReactionsCreateForIssueCommentRequestOptions - ]; - "POST /repos/:owner/:repo/keys": [ - ReposAddDeployKeyEndpoint, - ReposAddDeployKeyRequestOptions - ]; - "POST /repos/:owner/:repo/labels": [ - IssuesCreateLabelEndpoint, - IssuesCreateLabelRequestOptions - ]; - "POST /repos/:owner/:repo/merges": [ - ReposMergeEndpoint, - ReposMergeRequestOptions - ]; - "POST /repos/:owner/:repo/milestones": [ - IssuesCreateMilestoneEndpoint, - IssuesCreateMilestoneRequestOptions - ]; - "POST /repos/:owner/:repo/pages": [ - ReposEnablePagesSiteEndpoint, - ReposEnablePagesSiteRequestOptions - ]; - "POST /repos/:owner/:repo/pages/builds": [ - ReposRequestPageBuildEndpoint, - ReposRequestPageBuildRequestOptions - ]; - "POST /repos/:owner/:repo/projects": [ - ProjectsCreateForRepoEndpoint, - ProjectsCreateForRepoRequestOptions - ]; - "POST /repos/:owner/:repo/pulls": [ - PullsCreateEndpoint, - PullsCreateRequestOptions - ]; - "POST /repos/:owner/:repo/pulls/:pull_number/comments": [ - PullsCreateCommentEndpoint | PullsCreateCommentReplyEndpoint, - PullsCreateCommentRequestOptions | PullsCreateCommentReplyRequestOptions - ]; - "POST /repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies": [ - PullsCreateReviewCommentReplyEndpoint, - PullsCreateReviewCommentReplyRequestOptions - ]; - "POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ - PullsCreateReviewRequestEndpoint, - PullsCreateReviewRequestRequestOptions - ]; - "POST /repos/:owner/:repo/pulls/:pull_number/reviews": [ - PullsCreateReviewEndpoint, - PullsCreateReviewRequestOptions - ]; - "POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events": [ - PullsSubmitReviewEndpoint, - PullsSubmitReviewRequestOptions - ]; - "POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions": [ - ReactionsCreateForPullRequestReviewCommentEndpoint, - ReactionsCreateForPullRequestReviewCommentRequestOptions - ]; - "POST /repos/:owner/:repo/releases": [ - ReposCreateReleaseEndpoint, - ReposCreateReleaseRequestOptions - ]; - "POST /repos/:owner/:repo/statuses/:sha": [ - ReposCreateStatusEndpoint, - ReposCreateStatusRequestOptions - ]; - "POST /repos/:owner/:repo/transfer": [ - ReposTransferEndpoint, - ReposTransferRequestOptions - ]; - "POST /repos/:template_owner/:template_repo/generate": [ - ReposCreateUsingTemplateEndpoint, - ReposCreateUsingTemplateRequestOptions - ]; - "POST /scim/v2/organizations/:org/Users": [ - ScimProvisionAndInviteUsersEndpoint | ScimProvisionInviteUsersEndpoint, - - | ScimProvisionAndInviteUsersRequestOptions - | ScimProvisionInviteUsersRequestOptions - ]; - "POST /teams/:team_id/discussions": [ - TeamsCreateDiscussionEndpoint, - TeamsCreateDiscussionRequestOptions - ]; - "POST /teams/:team_id/discussions/:discussion_number/comments": [ - TeamsCreateDiscussionCommentEndpoint, - TeamsCreateDiscussionCommentRequestOptions - ]; - "POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": [ - ReactionsCreateForTeamDiscussionCommentEndpoint, - ReactionsCreateForTeamDiscussionCommentRequestOptions - ]; - "POST /teams/:team_id/discussions/:discussion_number/reactions": [ - ReactionsCreateForTeamDiscussionEndpoint, - ReactionsCreateForTeamDiscussionRequestOptions - ]; - "POST /user/emails": [UsersAddEmailsEndpoint, UsersAddEmailsRequestOptions]; - "POST /user/gpg_keys": [ - UsersCreateGpgKeyEndpoint, - UsersCreateGpgKeyRequestOptions - ]; - "POST /user/keys": [ - UsersCreatePublicKeyEndpoint, - UsersCreatePublicKeyRequestOptions - ]; - "POST /user/migrations": [ - MigrationsStartForAuthenticatedUserEndpoint, - MigrationsStartForAuthenticatedUserRequestOptions - ]; - "POST /user/projects": [ - ProjectsCreateForAuthenticatedUserEndpoint, - ProjectsCreateForAuthenticatedUserRequestOptions - ]; - "POST /user/repos": [ - ReposCreateForAuthenticatedUserEndpoint, - ReposCreateForAuthenticatedUserRequestOptions - ]; - "PUT /authorizations/clients/:client_id": [ - OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint, - OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions - ]; - "PUT /authorizations/clients/:client_id/:fingerprint": [ - - | OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint - | OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintEndpoint, - - | OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions - | OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintRequestOptions - ]; - "PUT /gists/:gist_id/star": [GistsStarEndpoint, GistsStarRequestOptions]; - "PUT /notifications": [ - ActivityMarkAsReadEndpoint, - ActivityMarkAsReadRequestOptions - ]; - "PUT /notifications/threads/:thread_id/subscription": [ - ActivitySetThreadSubscriptionEndpoint, - ActivitySetThreadSubscriptionRequestOptions - ]; - "PUT /orgs/:org/blocks/:username": [ - OrgsBlockUserEndpoint, - OrgsBlockUserRequestOptions - ]; - "PUT /orgs/:org/interaction-limits": [ - InteractionsAddOrUpdateRestrictionsForOrgEndpoint, - InteractionsAddOrUpdateRestrictionsForOrgRequestOptions - ]; - "PUT /orgs/:org/memberships/:username": [ - OrgsAddOrUpdateMembershipEndpoint, - OrgsAddOrUpdateMembershipRequestOptions - ]; - "PUT /orgs/:org/outside_collaborators/:username": [ - OrgsConvertMemberToOutsideCollaboratorEndpoint, - OrgsConvertMemberToOutsideCollaboratorRequestOptions - ]; - "PUT /orgs/:org/public_members/:username": [ - OrgsPublicizeMembershipEndpoint, - OrgsPublicizeMembershipRequestOptions - ]; - "PUT /projects/:project_id/collaborators/:username": [ - ProjectsAddCollaboratorEndpoint, - ProjectsAddCollaboratorRequestOptions - ]; - "PUT /repos/:owner/:repo/automated-security-fixes": [ - ReposEnableAutomatedSecurityFixesEndpoint, - ReposEnableAutomatedSecurityFixesRequestOptions - ]; - "PUT /repos/:owner/:repo/branches/:branch/protection": [ - ReposUpdateBranchProtectionEndpoint, - ReposUpdateBranchProtectionRequestOptions - ]; - "PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ - ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint, - ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions - ]; - "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ - ReposReplaceProtectedBranchAppRestrictionsEndpoint, - ReposReplaceProtectedBranchAppRestrictionsRequestOptions - ]; - "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ - ReposReplaceProtectedBranchTeamRestrictionsEndpoint, - ReposReplaceProtectedBranchTeamRestrictionsRequestOptions - ]; - "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ - ReposReplaceProtectedBranchUserRestrictionsEndpoint, - ReposReplaceProtectedBranchUserRestrictionsRequestOptions - ]; - "PUT /repos/:owner/:repo/collaborators/:username": [ - ReposAddCollaboratorEndpoint, - ReposAddCollaboratorRequestOptions - ]; - "PUT /repos/:owner/:repo/contents/:path": [ - - | ReposCreateOrUpdateFileEndpoint - | ReposCreateFileEndpoint - | ReposUpdateFileEndpoint, - - | ReposCreateOrUpdateFileRequestOptions - | ReposCreateFileRequestOptions - | ReposUpdateFileRequestOptions - ]; - "PUT /repos/:owner/:repo/import": [ - MigrationsStartImportEndpoint, - MigrationsStartImportRequestOptions - ]; - "PUT /repos/:owner/:repo/interaction-limits": [ - InteractionsAddOrUpdateRestrictionsForRepoEndpoint, - InteractionsAddOrUpdateRestrictionsForRepoRequestOptions - ]; - "PUT /repos/:owner/:repo/issues/:issue_number/labels": [ - IssuesReplaceLabelsEndpoint, - IssuesReplaceLabelsRequestOptions - ]; - "PUT /repos/:owner/:repo/issues/:issue_number/lock": [ - IssuesLockEndpoint, - IssuesLockRequestOptions - ]; - "PUT /repos/:owner/:repo/notifications": [ - ActivityMarkNotificationsAsReadForRepoEndpoint, - ActivityMarkNotificationsAsReadForRepoRequestOptions - ]; - "PUT /repos/:owner/:repo/pages": [ - ReposUpdateInformationAboutPagesSiteEndpoint, - ReposUpdateInformationAboutPagesSiteRequestOptions - ]; - "PUT /repos/:owner/:repo/pulls/:pull_number/merge": [ - PullsMergeEndpoint, - PullsMergeRequestOptions - ]; - "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ - PullsUpdateReviewEndpoint, - PullsUpdateReviewRequestOptions - ]; - "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals": [ - PullsDismissReviewEndpoint, - PullsDismissReviewRequestOptions - ]; - "PUT /repos/:owner/:repo/pulls/:pull_number/update-branch": [ - PullsUpdateBranchEndpoint, - PullsUpdateBranchRequestOptions - ]; - "PUT /repos/:owner/:repo/subscription": [ - ActivitySetRepoSubscriptionEndpoint, - ActivitySetRepoSubscriptionRequestOptions - ]; - "PUT /repos/:owner/:repo/topics": [ - ReposReplaceTopicsEndpoint, - ReposReplaceTopicsRequestOptions - ]; - "PUT /repos/:owner/:repo/vulnerability-alerts": [ - ReposEnableVulnerabilityAlertsEndpoint, - ReposEnableVulnerabilityAlertsRequestOptions - ]; - "PUT /scim/v2/organizations/:org/Users/:scim_user_id": [ - - | ScimReplaceProvisionedUserInformationEndpoint - | ScimUpdateProvisionedOrgMembershipEndpoint, - - | ScimReplaceProvisionedUserInformationRequestOptions - | ScimUpdateProvisionedOrgMembershipRequestOptions - ]; - "PUT /teams/:team_id/members/:username": [ - TeamsAddMemberEndpoint, - TeamsAddMemberRequestOptions - ]; - "PUT /teams/:team_id/memberships/:username": [ - TeamsAddOrUpdateMembershipEndpoint, - TeamsAddOrUpdateMembershipRequestOptions - ]; - "PUT /teams/:team_id/projects/:project_id": [ - TeamsAddOrUpdateProjectEndpoint, - TeamsAddOrUpdateProjectRequestOptions - ]; - "PUT /teams/:team_id/repos/:owner/:repo": [ - TeamsAddOrUpdateRepoEndpoint, - TeamsAddOrUpdateRepoRequestOptions - ]; - "PUT /user/blocks/:username": [UsersBlockEndpoint, UsersBlockRequestOptions]; - "PUT /user/following/:username": [ - UsersFollowEndpoint, - UsersFollowRequestOptions - ]; - "PUT /user/installations/:installation_id/repositories/:repository_id": [ - AppsAddRepoToInstallationEndpoint, - AppsAddRepoToInstallationRequestOptions - ]; - "PUT /user/starred/:owner/:repo": [ - ActivityStarRepoEndpoint, - ActivityStarRepoRequestOptions - ]; - "PUT /user/subscriptions/:owner/:repo": [ - ActivityWatchRepoLegacyEndpoint, - ActivityWatchRepoLegacyRequestOptions - ]; -} - -type AppsGetAuthenticatedEndpoint = {}; -type AppsGetAuthenticatedRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsCreateFromManifestEndpoint = { - /** - * code parameter - */ - code: string; -}; -type AppsCreateFromManifestRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsListInstallationsEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type AppsListInstallationsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsGetInstallationEndpoint = { - /** - * installation_id parameter - */ - installation_id: number; -}; -type AppsGetInstallationRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsDeleteInstallationEndpoint = { - /** - * installation_id parameter - */ - installation_id: number; -}; -type AppsDeleteInstallationRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsCreateInstallationTokenEndpoint = { - /** - * installation_id parameter - */ - installation_id: number; - /** - * 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. - */ - repository_ids?: number[]; - /** - * 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)." - */ - permissions?: AppsCreateInstallationTokenParamsPermissions; -}; -type AppsCreateInstallationTokenRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsListGrantsEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type OauthAuthorizationsListGrantsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsGetGrantEndpoint = { - /** - * grant_id parameter - */ - grant_id: number; -}; -type OauthAuthorizationsGetGrantRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsDeleteGrantEndpoint = { - /** - * grant_id parameter - */ - grant_id: number; -}; -type OauthAuthorizationsDeleteGrantRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsRevokeGrantForApplicationEndpoint = { - /** - * client_id parameter - */ - client_id: string; - /** - * access_token parameter - */ - access_token: string; -}; -type OauthAuthorizationsRevokeGrantForApplicationRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsCheckAuthorizationEndpoint = { - /** - * client_id parameter - */ - client_id: string; - /** - * access_token parameter - */ - access_token: string; -}; -type OauthAuthorizationsCheckAuthorizationRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsResetAuthorizationEndpoint = { - /** - * client_id parameter - */ - client_id: string; - /** - * access_token parameter - */ - access_token: string; -}; -type OauthAuthorizationsResetAuthorizationRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint = { - /** - * client_id parameter - */ - client_id: string; - /** - * access_token parameter - */ - access_token: string; -}; -type OauthAuthorizationsRevokeAuthorizationForApplicationRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsGetBySlugEndpoint = { - /** - * app_slug parameter - */ - app_slug: string; -}; -type AppsGetBySlugRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsListAuthorizationsEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type OauthAuthorizationsListAuthorizationsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsCreateAuthorizationEndpoint = { - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; - /** - * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. - */ - note: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * The 20 character OAuth app client key for which to create the token. - */ - client_id?: string; - /** - * The 40 character OAuth app client secret for which to create the token. - */ - client_secret?: string; - /** - * A unique string to distinguish an authorization from others created for the same client ID and user. - */ - fingerprint?: string; -}; -type OauthAuthorizationsCreateAuthorizationRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint = { - /** - * client_id parameter - */ - client_id: string; - /** - * The 40 character OAuth app client secret associated with the client ID specified in the URL. - */ - client_secret: string; - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; - /** - * A note to remind you what the OAuth token is for. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint). - */ - fingerprint?: string; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint = { - /** - * client_id parameter - */ - client_id: string; - /** - * fingerprint parameter - */ - fingerprint: string; - /** - * The 40 character OAuth app client secret associated with the client ID specified in the URL. - */ - client_secret: string; - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; - /** - * A note to remind you what the OAuth token is for. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintEndpoint = { - /** - * client_id parameter - */ - client_id: string; - /** - * fingerprint parameter - */ - fingerprint: string; - /** - * The 40 character OAuth app client secret associated with the client ID specified in the URL. - */ - client_secret: string; - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; - /** - * A note to remind you what the OAuth token is for. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsGetAuthorizationEndpoint = { - /** - * authorization_id parameter - */ - authorization_id: number; -}; -type OauthAuthorizationsGetAuthorizationRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsUpdateAuthorizationEndpoint = { - /** - * authorization_id parameter - */ - authorization_id: number; - /** - * Replaces the authorization scopes with these. - */ - scopes?: string[]; - /** - * A list of scopes to add to this authorization. - */ - add_scopes?: string[]; - /** - * A list of scopes to remove from this authorization. - */ - remove_scopes?: string[]; - /** - * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * A unique string to distinguish an authorization from others created for the same client ID and user. - */ - fingerprint?: string; -}; -type OauthAuthorizationsUpdateAuthorizationRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OauthAuthorizationsDeleteAuthorizationEndpoint = { - /** - * authorization_id parameter - */ - authorization_id: number; -}; -type OauthAuthorizationsDeleteAuthorizationRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type CodesOfConductListConductCodesEndpoint = {}; -type CodesOfConductListConductCodesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type CodesOfConductGetConductCodeEndpoint = { - /** - * key parameter - */ - key: string; -}; -type CodesOfConductGetConductCodeRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsCreateContentAttachmentEndpoint = { - /** - * content_reference_id parameter - */ - content_reference_id: number; - /** - * The title of the content attachment displayed in the body or comment of an issue or pull request. - */ - title: string; - /** - * The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown. - */ - body: string; -}; -type AppsCreateContentAttachmentRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type EmojisGetEndpoint = {}; -type EmojisGetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListPublicEventsEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListPublicEventsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListFeedsEndpoint = {}; -type ActivityListFeedsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsListEndpoint = { - /** - * 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. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type GistsListRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsCreateEndpoint = { - /** - * The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`. - */ - files: GistsCreateParamsFiles; - /** - * A descriptive name for this gist. - */ - description?: string; - /** - * When `true`, the gist will be public and available for anyone to see. - */ - public?: boolean; -}; -type GistsCreateRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsListPublicEndpoint = { - /** - * 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. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type GistsListPublicRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsListStarredEndpoint = { - /** - * 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. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type GistsListStarredRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsGetEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; -}; -type GistsGetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsUpdateEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; - /** - * A descriptive name for this gist. - */ - description?: string; - /** - * The filenames and content that make up this gist. - */ - files?: GistsUpdateParamsFiles; -}; -type GistsUpdateRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsDeleteEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; -}; -type GistsDeleteRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsListCommentsEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type GistsListCommentsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsCreateCommentEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; - /** - * The comment text. - */ - body: string; -}; -type GistsCreateCommentRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsGetCommentEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; - /** - * comment_id parameter - */ - comment_id: number; -}; -type GistsGetCommentRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsUpdateCommentEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; - /** - * comment_id parameter - */ - comment_id: number; - /** - * The comment text. - */ - body: string; -}; -type GistsUpdateCommentRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsDeleteCommentEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; - /** - * comment_id parameter - */ - comment_id: number; -}; -type GistsDeleteCommentRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsListCommitsEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type GistsListCommitsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsForkEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; -}; -type GistsForkRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsListForksEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type GistsListForksRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsStarEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; -}; -type GistsStarRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsUnstarEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; -}; -type GistsUnstarRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsCheckIsStarredEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; -}; -type GistsCheckIsStarredRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsGetRevisionEndpoint = { - /** - * gist_id parameter - */ - gist_id: string; - /** - * sha parameter - */ - sha: string; -}; -type GistsGetRevisionRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitignoreListTemplatesEndpoint = {}; -type GitignoreListTemplatesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitignoreGetTemplateEndpoint = { - /** - * name parameter - */ - name: string; -}; -type GitignoreGetTemplateRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsListReposEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type AppsListReposRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListEndpoint = { - /** - * Indicates which sorts of issues to return. Can be one of: - * \* `assigned`: Issues assigned to you - * \* `created`: Issues created by you - * \* `mentioned`: Issues mentioning you - * \* `subscribed`: Issues you're subscribed to updates for - * \* `all`: All issues the authenticated user can see, regardless of participation or creation - */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; - /** - * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - /** - * A list of comma separated label names. Example: `bug,ui,@high` - */ - labels?: string; - /** - * What to sort results by. Can be either `created`, `updated`, `comments`. - */ - sort?: "created" | "updated" | "comments"; - /** - * The direction of the sort. Can be either `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * 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`. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type SearchIssuesLegacyEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repository parameter - */ - repository: string; - /** - * Indicates the state of the issues to return. Can be either `open` or `closed`. - */ - state: "open" | "closed"; - /** - * The search term. - */ - keyword: string; -}; -type SearchIssuesLegacyRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type SearchReposLegacyEndpoint = { - /** - * The search term. - */ - keyword: string; - /** - * Filter results by language. - */ - language?: string; - /** - * The page number to fetch. - */ - start_page?: string; - /** - * The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. - */ - sort?: "stars" | "forks" | "updated"; - /** - * The sort field. if `sort` param is provided. Can be either `asc` or `desc`. - */ - order?: "asc" | "desc"; -}; -type SearchReposLegacyRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type SearchEmailLegacyEndpoint = { - /** - * The email address. - */ - email: string; -}; -type SearchEmailLegacyRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type SearchUsersLegacyEndpoint = { - /** - * The search term. - */ - keyword: string; - /** - * The page number to fetch. - */ - start_page?: string; - /** - * The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. - */ - sort?: "stars" | "forks" | "updated"; - /** - * The sort field. if `sort` param is provided. Can be either `asc` or `desc`. - */ - order?: "asc" | "desc"; -}; -type SearchUsersLegacyRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type LicensesListCommonlyUsedEndpoint = {}; -type LicensesListCommonlyUsedRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type LicensesListEndpoint = {}; -type LicensesListRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type LicensesGetEndpoint = { - /** - * license parameter - */ - license: string; -}; -type LicensesGetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MarkdownRenderEndpoint = { - /** - * The Markdown text to render in HTML. Markdown content must be 400 KB or less. - */ - text: string; - /** - * The rendering mode. Can be either: - * \* `markdown` to render a document in plain Markdown, just like README.md files are rendered. - * \* `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. - */ - mode?: "markdown" | "gfm"; - /** - * The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode. - */ - context?: string; -}; -type MarkdownRenderRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MarkdownRenderRawEndpoint = { - /** - * data parameter - */ - data: string; -}; -type MarkdownRenderRawRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsCheckAccountIsAssociatedWithAnyEndpoint = { - /** - * account_id parameter - */ - account_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type AppsCheckAccountIsAssociatedWithAnyRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsListPlansEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type AppsListPlansRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsListAccountsUserOrOrgOnPlanEndpoint = { - /** - * plan_id parameter - */ - plan_id: number; - /** - * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. - */ - sort?: "created" | "updated"; - /** - * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. - */ - direction?: "asc" | "desc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type AppsListAccountsUserOrOrgOnPlanRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsCheckAccountIsAssociatedWithAnyStubbedEndpoint = { - /** - * account_id parameter - */ - account_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type AppsCheckAccountIsAssociatedWithAnyStubbedRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsListPlansStubbedEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type AppsListPlansStubbedRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsListAccountsUserOrOrgOnPlanStubbedEndpoint = { - /** - * plan_id parameter - */ - plan_id: number; - /** - * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. - */ - sort?: "created" | "updated"; - /** - * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. - */ - direction?: "asc" | "desc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type AppsListAccountsUserOrOrgOnPlanStubbedRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MetaGetEndpoint = {}; -type MetaGetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListPublicEventsForRepoNetworkEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListPublicEventsForRepoNetworkRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListNotificationsEndpoint = { - /** - * If `true`, show notifications marked as read. - */ - all?: boolean; - /** - * If `true`, only shows notifications in which the user is directly participating or mentioned. - */ - participating?: boolean; - /** - * 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`. - */ - since?: string; - /** - * 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`. - */ - before?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListNotificationsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityMarkAsReadEndpoint = { - /** - * Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. - */ - last_read_at?: string; -}; -type ActivityMarkAsReadRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityGetThreadEndpoint = { - /** - * thread_id parameter - */ - thread_id: number; -}; -type ActivityGetThreadRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityMarkThreadAsReadEndpoint = { - /** - * thread_id parameter - */ - thread_id: number; -}; -type ActivityMarkThreadAsReadRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityGetThreadSubscriptionEndpoint = { - /** - * thread_id parameter - */ - thread_id: number; -}; -type ActivityGetThreadSubscriptionRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivitySetThreadSubscriptionEndpoint = { - /** - * thread_id parameter - */ - thread_id: number; - /** - * Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread. - */ - ignored?: boolean; -}; -type ActivitySetThreadSubscriptionRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityDeleteThreadSubscriptionEndpoint = { - /** - * thread_id parameter - */ - thread_id: number; -}; -type ActivityDeleteThreadSubscriptionRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListEndpoint = { - /** - * The integer ID of the last Organization that you've seen. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type OrgsListRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsGetEndpoint = { - /** - * org parameter - */ - org: string; -}; -type OrgsGetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsUpdateEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Billing email address. This address is not publicized. - */ - billing_email?: string; - /** - * The company name. - */ - company?: string; - /** - * The publicly visible email address. - */ - email?: string; - /** - * The location. - */ - location?: string; - /** - * The shorthand name of the company. - */ - name?: string; - /** - * The description of the company. - */ - description?: string; - /** - * Toggles whether organization projects are enabled for the organization. - */ - has_organization_projects?: boolean; - /** - * Toggles whether repository projects are enabled for repositories that belong to the organization. - */ - has_repository_projects?: boolean; - /** - * Default permission level members have for organization repositories: - * \* `read` - can pull, but not push to or administer this repository. - * \* `write` - can pull and push, but not administer this repository. - * \* `admin` - can pull, push, and administer this repository. - * \* `none` - no permissions granted by default. - */ - default_repository_permission?: "read" | "write" | "admin" | "none"; - /** - * Toggles the ability of non-admin organization members to create repositories. Can be one of: - * \* `true` - all organization members can create repositories. - * \* `false` - only admin members can create repositories. - * Default: `true` - * **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. - */ - members_can_create_repositories?: boolean; - /** - * Specifies which types of repositories non-admin organization members can create. Can be one of: - * \* `all` - all organization members can create public and private repositories. - * \* `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). - * \* `none` - only admin members can create repositories. - * **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. - */ - members_allowed_repository_creation_type?: "all" | "private" | "none"; -}; -type OrgsUpdateRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListBlockedUsersEndpoint = { - /** - * org parameter - */ - org: string; -}; -type OrgsListBlockedUsersRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsCheckBlockedUserEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsCheckBlockedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsBlockUserEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsBlockUserRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsUnblockUserEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsUnblockUserRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListCredentialAuthorizationsEndpoint = { - /** - * org parameter - */ - org: string; -}; -type OrgsListCredentialAuthorizationsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsRemoveCredentialAuthorizationEndpoint = { - /** - * org parameter - */ - org: string; - /** - * credential_id parameter - */ - credential_id: number; -}; -type OrgsRemoveCredentialAuthorizationRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListPublicEventsForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListPublicEventsForOrgRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListHooksEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type OrgsListHooksRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsCreateHookEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Must be passed as "web". - */ - name: string; - /** - * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params). - */ - config: OrgsCreateHookParamsConfig; - /** - * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. - */ - events?: string[]; - /** - * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - */ - active?: boolean; -}; -type OrgsCreateHookRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsGetHookEndpoint = { - /** - * org parameter - */ - org: string; - /** - * hook_id parameter - */ - hook_id: number; -}; -type OrgsGetHookRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsUpdateHookEndpoint = { - /** - * org parameter - */ - org: string; - /** - * hook_id parameter - */ - hook_id: number; - /** - * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params). - */ - config?: OrgsUpdateHookParamsConfig; - /** - * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. - */ - events?: string[]; - /** - * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - */ - active?: boolean; -}; -type OrgsUpdateHookRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsDeleteHookEndpoint = { - /** - * org parameter - */ - org: string; - /** - * hook_id parameter - */ - hook_id: number; -}; -type OrgsDeleteHookRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsPingHookEndpoint = { - /** - * org parameter - */ - org: string; - /** - * hook_id parameter - */ - hook_id: number; -}; -type OrgsPingHookRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsGetOrgInstallationEndpoint = { - /** - * org parameter - */ - org: string; -}; -type AppsGetOrgInstallationRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsFindOrgInstallationEndpoint = { - /** - * org parameter - */ - org: string; -}; -type AppsFindOrgInstallationRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type InteractionsGetRestrictionsForOrgEndpoint = { - /** - * org parameter - */ - org: string; -}; -type InteractionsGetRestrictionsForOrgRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type InteractionsAddOrUpdateRestrictionsForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * 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`. - */ - limit: "existing_users" | "contributors_only" | "collaborators_only"; -}; -type InteractionsAddOrUpdateRestrictionsForOrgRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type InteractionsRemoveRestrictionsForOrgEndpoint = { - /** - * org parameter - */ - org: string; -}; -type InteractionsRemoveRestrictionsForOrgRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListPendingInvitationsEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type OrgsListPendingInvitationsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsCreateInvitationEndpoint = { - /** - * org parameter - */ - org: string; - /** - * **Required unless you provide `email`**. GitHub user ID for the person you are inviting. - */ - invitee_id?: number; - /** - * **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. - */ - email?: string; - /** - * Specify role for new member. Can be one of: - * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. - * \* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. - * \* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. - */ - role?: "admin" | "direct_member" | "billing_manager"; - /** - * Specify IDs for the teams you want to invite new members to. - */ - team_ids?: number[]; -}; -type OrgsCreateInvitationRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListInvitationTeamsEndpoint = { - /** - * org parameter - */ - org: string; - /** - * invitation_id parameter - */ - invitation_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type OrgsListInvitationTeamsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Indicates which sorts of issues to return. Can be one of: - * \* `assigned`: Issues assigned to you - * \* `created`: Issues created by you - * \* `mentioned`: Issues mentioning you - * \* `subscribed`: Issues you're subscribed to updates for - * \* `all`: All issues the authenticated user can see, regardless of participation or creation - */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; - /** - * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - /** - * A list of comma separated label names. Example: `bug,ui,@high` - */ - labels?: string; - /** - * What to sort results by. Can be either `created`, `updated`, `comments`. - */ - sort?: "created" | "updated" | "comments"; - /** - * The direction of the sort. Can be either `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * 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`. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListForOrgRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListMembersEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Filter members returned in the list. Can be one of: - * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. - * \* `all` - All members the authenticated user can see. - */ - filter?: "2fa_disabled" | "all"; - /** - * Filter members returned by their role. Can be one of: - * \* `all` - All members of the organization, regardless of role. - * \* `admin` - Organization owners. - * \* `member` - Non-owner organization members. - */ - role?: "all" | "admin" | "member"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type OrgsListMembersRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsCheckMembershipEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsCheckMembershipRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsRemoveMemberEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsRemoveMemberRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsGetMembershipEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsGetMembershipRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsAddOrUpdateMembershipEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; - /** - * The role to give the user in the organization. Can be one of: - * \* `admin` - The user will become an owner of the organization. - * \* `member` - The user will become a non-owner member of the organization. - */ - role?: "admin" | "member"; -}; -type OrgsAddOrUpdateMembershipRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsRemoveMembershipEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsRemoveMembershipRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsStartForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * A list of arrays indicating which repositories should be migrated. - */ - repositories: string[]; - /** - * Indicates whether repositories should be locked (to prevent manipulation) while migrating data. - */ - lock_repositories?: boolean; - /** - * Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). - */ - exclude_attachments?: boolean; -}; -type MigrationsStartForOrgRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsListForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type MigrationsListForOrgRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsGetStatusForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * migration_id parameter - */ - migration_id: number; -}; -type MigrationsGetStatusForOrgRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsGetArchiveForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * migration_id parameter - */ - migration_id: number; -}; -type MigrationsGetArchiveForOrgRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsDeleteArchiveForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * migration_id parameter - */ - migration_id: number; -}; -type MigrationsDeleteArchiveForOrgRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsUnlockRepoForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * migration_id parameter - */ - migration_id: number; - /** - * repo_name parameter - */ - repo_name: string; -}; -type MigrationsUnlockRepoForOrgRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListOutsideCollaboratorsEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Filter the list of outside collaborators. Can be one of: - * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. - * \* `all`: All outside collaborators. - */ - filter?: "2fa_disabled" | "all"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type OrgsListOutsideCollaboratorsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsRemoveOutsideCollaboratorEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsRemoveOutsideCollaboratorRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsConvertMemberToOutsideCollaboratorEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsConvertMemberToOutsideCollaboratorRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsListForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ProjectsListForOrgRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsCreateForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * The name of the project. - */ - name: string; - /** - * The description of the project. - */ - body?: string; -}; -type ProjectsCreateForOrgRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListPublicMembersEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type OrgsListPublicMembersRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsCheckPublicMembershipEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsCheckPublicMembershipRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsPublicizeMembershipEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsPublicizeMembershipRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsConcealMembershipEndpoint = { - /** - * org parameter - */ - org: string; - /** - * username parameter - */ - username: string; -}; -type OrgsConcealMembershipRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`. - */ - type?: "all" | "public" | "private" | "forks" | "sources" | "member"; - /** - * Can be one of `created`, `updated`, `pushed`, `full_name`. - */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** - * Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` - */ - direction?: "asc" | "desc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListForOrgRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateInOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * The name of the repository. - */ - name: string; - /** - * A short description of the repository. - */ - description?: string; - /** - * A URL with more information about the repository. - */ - homepage?: string; - /** - * Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account. - */ - private?: boolean; - /** - * Either `true` to enable issues for this repository or `false` to disable them. - */ - has_issues?: boolean; - /** - * 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. - */ - has_projects?: boolean; - /** - * Either `true` to enable the wiki for this repository or `false` to disable it. - */ - has_wiki?: boolean; - /** - * Either `true` to make this repo available as a template repository or `false` to prevent it. - */ - is_template?: boolean; - /** - * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. - */ - team_id?: number; - /** - * Pass `true` to create an initial commit with empty README. - */ - auto_init?: boolean; - /** - * 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". - */ - gitignore_template?: string; - /** - * 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". - */ - license_template?: string; - /** - * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. - */ - allow_squash_merge?: boolean; - /** - * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. - */ - allow_merge_commit?: boolean; - /** - * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. - */ - allow_rebase_merge?: boolean; -}; -type ReposCreateInOrgRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsListIdPGroupsForOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type TeamsListIdPGroupsForOrgRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsListEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type TeamsListRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsCreateEndpoint = { - /** - * org parameter - */ - org: string; - /** - * The name of the team. - */ - name: string; - /** - * The description of the team. - */ - description?: string; - /** - * The logins of organization members to add as maintainers of the team. - */ - maintainers?: string[]; - /** - * The full name (e.g., "organization-name/repository-name") of repositories to add the team to. - */ - repo_names?: string[]; - /** - * The level of privacy this team should have. The options are: - * **For a non-nested team:** - * \* `secret` - only visible to organization owners and members of this team. - * \* `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * \* `closed` - visible to all members of this organization. - * Default for child team: `closed` - * **Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams. - */ - privacy?: "secret" | "closed"; - /** - * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: - * \* `pull` - team members can pull, but not push to or administer newly-added repositories. - * \* `push` - team members can pull and push, but not administer newly-added repositories. - * \* `admin` - team members can pull, push and administer newly-added repositories. - */ - permission?: "pull" | "push" | "admin"; - /** - * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. - */ - parent_team_id?: number; -}; -type TeamsCreateRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsGetByNameEndpoint = { - /** - * org parameter - */ - org: string; - /** - * team_slug parameter - */ - team_slug: string; -}; -type TeamsGetByNameRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsGetCardEndpoint = { - /** - * card_id parameter - */ - card_id: number; -}; -type ProjectsGetCardRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsUpdateCardEndpoint = { - /** - * card_id parameter - */ - card_id: number; - /** - * The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`. - */ - note?: string; - /** - * Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card. - */ - archived?: boolean; -}; -type ProjectsUpdateCardRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsDeleteCardEndpoint = { - /** - * card_id parameter - */ - card_id: number; -}; -type ProjectsDeleteCardRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsMoveCardEndpoint = { - /** - * card_id parameter - */ - card_id: number; - /** - * 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`. - */ - position: string; - /** - * The `id` value of a column in the same project. - */ - column_id?: number; -}; -type ProjectsMoveCardRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsGetColumnEndpoint = { - /** - * column_id parameter - */ - column_id: number; -}; -type ProjectsGetColumnRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsUpdateColumnEndpoint = { - /** - * column_id parameter - */ - column_id: number; - /** - * The new name of the column. - */ - name: string; -}; -type ProjectsUpdateColumnRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsDeleteColumnEndpoint = { - /** - * column_id parameter - */ - column_id: number; -}; -type ProjectsDeleteColumnRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsListCardsEndpoint = { - /** - * column_id parameter - */ - column_id: number; - /** - * Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. - */ - archived_state?: "all" | "archived" | "not_archived"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ProjectsListCardsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsCreateCardEndpoint = { - /** - * column_id parameter - */ - column_id: number; - /** - * 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`. - */ - note?: string; - /** - * 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. - * **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_id?: number; - /** - * **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. - */ - content_type?: string; -}; -type ProjectsCreateCardRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsMoveColumnEndpoint = { - /** - * column_id parameter - */ - column_id: number; - /** - * Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project. - */ - position: string; -}; -type ProjectsMoveColumnRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsGetEndpoint = { - /** - * project_id parameter - */ - project_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ProjectsGetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsUpdateEndpoint = { - /** - * project_id parameter - */ - project_id: number; - /** - * The name of the project. - */ - name?: string; - /** - * The description of the project. - */ - body?: string; - /** - * State of the project. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * 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). - * - * **Note:** Updating a project's `organization_permission` requires `admin` access to the project. - * - * Can be one of: - * \* `read` - Organization members can read, but not write to or administer this project. - * \* `write` - Organization members can read and write, but not administer this project. - * \* `admin` - Organization members can read, write and administer this project. - * \* `none` - Organization members can only see this project if it is public. - */ - organization_permission?: string; - /** - * 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. - * - * Can be one of: - * \* `false` - Anyone can see the project. - * \* `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. - */ - private?: boolean; -}; -type ProjectsUpdateRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsDeleteEndpoint = { - /** - * project_id parameter - */ - project_id: number; -}; -type ProjectsDeleteRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsListCollaboratorsEndpoint = { - /** - * project_id parameter - */ - project_id: number; - /** - * Filters the collaborators by their affiliation. Can be one of: - * \* `outside`: Outside collaborators of a project that are not a member of the project's organization. - * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. - * \* `all`: All collaborators the authenticated user can see. - */ - affiliation?: "outside" | "direct" | "all"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ProjectsListCollaboratorsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsAddCollaboratorEndpoint = { - /** - * project_id parameter - */ - project_id: number; - /** - * username parameter - */ - username: string; - /** - * 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: - * \* `read` - can read, but not write to or administer this project. - * \* `write` - can read and write, but not administer this project. - * \* `admin` - can read, write and administer this project. - */ - permission?: "read" | "write" | "admin"; -}; -type ProjectsAddCollaboratorRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsRemoveCollaboratorEndpoint = { - /** - * project_id parameter - */ - project_id: number; - /** - * username parameter - */ - username: string; -}; -type ProjectsRemoveCollaboratorRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsReviewUserPermissionLevelEndpoint = { - /** - * project_id parameter - */ - project_id: number; - /** - * username parameter - */ - username: string; -}; -type ProjectsReviewUserPermissionLevelRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsListColumnsEndpoint = { - /** - * project_id parameter - */ - project_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ProjectsListColumnsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsCreateColumnEndpoint = { - /** - * project_id parameter - */ - project_id: number; - /** - * The name of the column. - */ - name: string; -}; -type ProjectsCreateColumnRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type RateLimitGetEndpoint = {}; -type RateLimitGetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsDeleteEndpoint = { - /** - * reaction_id parameter - */ - reaction_id: number; -}; -type ReactionsDeleteRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposGetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposUpdateEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The name of the repository. - */ - name?: string; - /** - * A short description of the repository. - */ - description?: string; - /** - * A URL with more information about the repository. - */ - homepage?: string; - /** - * Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. - * **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. - */ - private?: boolean; - /** - * Either `true` to enable issues for this repository or `false` to disable them. - */ - has_issues?: boolean; - /** - * 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. - */ - has_projects?: boolean; - /** - * Either `true` to enable the wiki for this repository or `false` to disable it. - */ - has_wiki?: boolean; - /** - * Either `true` to make this repo available as a template repository or `false` to prevent it. - */ - is_template?: boolean; - /** - * Updates the default branch for this repository. - */ - default_branch?: string; - /** - * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. - */ - allow_squash_merge?: boolean; - /** - * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. - */ - allow_merge_commit?: boolean; - /** - * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. - */ - allow_rebase_merge?: boolean; - /** - * `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. - */ - archived?: boolean; -}; -type ReposUpdateRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposDeleteEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposDeleteRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListAssigneesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListAssigneesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesCheckAssigneeEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * assignee parameter - */ - assignee: string; -}; -type IssuesCheckAssigneeRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposEnableAutomatedSecurityFixesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposEnableAutomatedSecurityFixesRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposDisableAutomatedSecurityFixesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposDisableAutomatedSecurityFixesRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListBranchesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. - */ - protected?: boolean; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListBranchesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetBranchEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposGetBranchRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetBranchProtectionEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposGetBranchProtectionRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposUpdateBranchProtectionEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * Require status checks to pass before merging. Set to `null` to disable. - */ - required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null; - /** - * Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. - */ - enforce_admins: boolean | null; - /** - * Require at least one approving review on a pull request, before merging. Set to `null` to disable. - */ - required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null; - /** - * Restrict who can push to this branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. - */ - restrictions: ReposUpdateBranchProtectionParamsRestrictions | null; -}; -type ReposUpdateBranchProtectionRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRemoveBranchProtectionEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposRemoveBranchProtectionRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetProtectedBranchAdminEnforcementEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposGetProtectedBranchAdminEnforcementRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposAddProtectedBranchAdminEnforcementEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposAddProtectedBranchAdminEnforcementRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRemoveProtectedBranchAdminEnforcementEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposRemoveProtectedBranchAdminEnforcementRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * 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. - */ - dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions; - /** - * Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. - */ - dismiss_stale_reviews?: boolean; - /** - * Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed. - */ - require_code_owner_reviews?: boolean; - /** - * Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6. - */ - required_approving_review_count?: number; -}; -type ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetProtectedBranchRequiredSignaturesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposGetProtectedBranchRequiredSignaturesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposAddProtectedBranchRequiredSignaturesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposAddProtectedBranchRequiredSignaturesRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRemoveProtectedBranchRequiredSignaturesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposRemoveProtectedBranchRequiredSignaturesRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetProtectedBranchRequiredStatusChecksEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposGetProtectedBranchRequiredStatusChecksRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposUpdateProtectedBranchRequiredStatusChecksEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * Require branches to be up to date before merging. - */ - strict?: boolean; - /** - * The list of status checks to require in order to merge into this branch - */ - contexts?: string[]; -}; -type ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRemoveProtectedBranchRequiredStatusChecksEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListProtectedBranchRequiredStatusChecksContextsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * contexts parameter - */ - contexts: string[]; -}; -type ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * contexts parameter - */ - contexts: string[]; -}; -type ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * contexts parameter - */ - contexts: string[]; -}; -type ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetProtectedBranchRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposGetProtectedBranchRestrictionsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRemoveProtectedBranchRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposRemoveProtectedBranchRestrictionsRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetAppsWithAccessToProtectedBranchEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposGetAppsWithAccessToProtectedBranchRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListAppsWithAccessToProtectedBranchEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposListAppsWithAccessToProtectedBranchRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposReplaceProtectedBranchAppRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * apps parameter - */ - apps: string[]; -}; -type ReposReplaceProtectedBranchAppRestrictionsRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposAddProtectedBranchAppRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * apps parameter - */ - apps: string[]; -}; -type ReposAddProtectedBranchAppRestrictionsRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRemoveProtectedBranchAppRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * apps parameter - */ - apps: string[]; -}; -type ReposRemoveProtectedBranchAppRestrictionsRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetTeamsWithAccessToProtectedBranchEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposGetTeamsWithAccessToProtectedBranchRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListProtectedBranchTeamRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposListProtectedBranchTeamRestrictionsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListTeamsWithAccessToProtectedBranchEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposListTeamsWithAccessToProtectedBranchRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposReplaceProtectedBranchTeamRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * teams parameter - */ - teams: string[]; -}; -type ReposReplaceProtectedBranchTeamRestrictionsRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposAddProtectedBranchTeamRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * teams parameter - */ - teams: string[]; -}; -type ReposAddProtectedBranchTeamRestrictionsRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRemoveProtectedBranchTeamRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * teams parameter - */ - teams: string[]; -}; -type ReposRemoveProtectedBranchTeamRestrictionsRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetUsersWithAccessToProtectedBranchEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposGetUsersWithAccessToProtectedBranchRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListProtectedBranchUserRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposListProtectedBranchUserRestrictionsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListUsersWithAccessToProtectedBranchEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; -}; -type ReposListUsersWithAccessToProtectedBranchRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposReplaceProtectedBranchUserRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * users parameter - */ - users: string[]; -}; -type ReposReplaceProtectedBranchUserRestrictionsRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposAddProtectedBranchUserRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * users parameter - */ - users: string[]; -}; -type ReposAddProtectedBranchUserRestrictionsRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRemoveProtectedBranchUserRestrictionsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * branch parameter - */ - branch: string; - /** - * users parameter - */ - users: string[]; -}; -type ReposRemoveProtectedBranchUserRestrictionsRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ChecksCreateEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The name of the check. For example, "code-coverage". - */ - name: string; - /** - * The SHA of the commit. - */ - head_sha: string; - /** - * The URL of the integrator's site that has the full details of the check. - */ - details_url?: string; - /** - * A reference for the run on the integrator's system. - */ - external_id?: string; - /** - * The current status. Can be one of `queued`, `in_progress`, or `completed`. - */ - status?: "queued" | "in_progress" | "completed"; - /** - * 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`. - */ - started_at?: string; - /** - * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. - */ - conclusion?: - | "success" - | "failure" - | "neutral" - | "cancelled" - | "timed_out" - | "action_required"; - /** - * 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`. - */ - completed_at?: string; - /** - * 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. - */ - output?: ChecksCreateParamsOutput; - /** - * 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)." - */ - actions?: ChecksCreateParamsActions[]; -}; -type ChecksCreateRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ChecksUpdateEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * check_run_id parameter - */ - check_run_id: number; - /** - * The name of the check. For example, "code-coverage". - */ - name?: string; - /** - * The URL of the integrator's site that has the full details of the check. - */ - details_url?: string; - /** - * A reference for the run on the integrator's system. - */ - external_id?: string; - /** - * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - started_at?: string; - /** - * The current status. Can be one of `queued`, `in_progress`, or `completed`. - */ - status?: "queued" | "in_progress" | "completed"; - /** - * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. - */ - conclusion?: - | "success" - | "failure" - | "neutral" - | "cancelled" - | "timed_out" - | "action_required"; - /** - * 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`. - */ - completed_at?: string; - /** - * 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. - */ - output?: ChecksUpdateParamsOutput; - /** - * 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)." - */ - actions?: ChecksUpdateParamsActions[]; -}; -type ChecksUpdateRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ChecksGetEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * check_run_id parameter - */ - check_run_id: number; -}; -type ChecksGetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ChecksListAnnotationsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * check_run_id parameter - */ - check_run_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ChecksListAnnotationsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ChecksCreateSuiteEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The sha of the head commit. - */ - head_sha: string; -}; -type ChecksCreateSuiteRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ChecksSetSuitesPreferencesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * 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. - */ - auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]; -}; -type ChecksSetSuitesPreferencesRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ChecksGetSuiteEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * check_suite_id parameter - */ - check_suite_id: number; -}; -type ChecksGetSuiteRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ChecksListForSuiteEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * check_suite_id parameter - */ - check_suite_id: number; - /** - * Returns check runs with the specified `name`. - */ - check_name?: string; - /** - * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. - */ - status?: "queued" | "in_progress" | "completed"; - /** - * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. - */ - filter?: "latest" | "all"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ChecksListForSuiteRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ChecksRerequestSuiteEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * check_suite_id parameter - */ - check_suite_id: number; -}; -type ChecksRerequestSuiteRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListCollaboratorsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Filter collaborators returned by their affiliation. Can be one of: - * \* `outside`: All outside collaborators of an organization-owned repository. - * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. - * \* `all`: All collaborators the authenticated user can see. - */ - affiliation?: "outside" | "direct" | "all"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListCollaboratorsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCheckCollaboratorEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * username parameter - */ - username: string; -}; -type ReposCheckCollaboratorRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposAddCollaboratorEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * username parameter - */ - username: string; - /** - * The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: - * \* `pull` - can pull, but not push to or administer this repository. - * \* `push` - can pull and push, but not administer this repository. - * \* `admin` - can pull, push and administer this repository. - */ - permission?: "pull" | "push" | "admin"; -}; -type ReposAddCollaboratorRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRemoveCollaboratorEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * username parameter - */ - username: string; -}; -type ReposRemoveCollaboratorRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetCollaboratorPermissionLevelEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * username parameter - */ - username: string; -}; -type ReposGetCollaboratorPermissionLevelRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListCommitCommentsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListCommitCommentsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetCommitCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; -}; -type ReposGetCommitCommentRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposUpdateCommitCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; - /** - * The contents of the comment - */ - body: string; -}; -type ReposUpdateCommitCommentRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposDeleteCommitCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; -}; -type ReposDeleteCommitCommentRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsListForCommitCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReactionsListForCommitCommentRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsCreateForCommitCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; -}; -type ReactionsCreateForCommitCommentRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListCommitsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). - */ - sha?: string; - /** - * Only commits containing this file path will be returned. - */ - path?: string; - /** - * GitHub login or email address by which to filter by commit author. - */ - author?: string; - /** - * 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`. - */ - since?: string; - /** - * 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`. - */ - until?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListCommitsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListBranchesForHeadCommitEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * commit_sha parameter - */ - commit_sha: string; -}; -type ReposListBranchesForHeadCommitRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListCommentsForCommitEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * commit_sha parameter - */ - commit_sha: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListCommentsForCommitRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateCommitCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * commit_sha parameter - */ - commit_sha: string; - /** - * The contents of the comment. - */ - body: string; - /** - * Relative path of the file to comment on. - */ - path?: string; - /** - * Line index in the diff to comment on. - */ - position?: number; - /** - * **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. - */ - line?: number; -}; -type ReposCreateCommitCommentRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListPullRequestsAssociatedWithCommitEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * commit_sha parameter - */ - commit_sha: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListPullRequestsAssociatedWithCommitRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetCommitEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * ref parameter - */ - ref: string; -}; -type ReposGetCommitRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ChecksListForRefEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * ref parameter - */ - ref: string; - /** - * Returns check runs with the specified `name`. - */ - check_name?: string; - /** - * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. - */ - status?: "queued" | "in_progress" | "completed"; - /** - * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. - */ - filter?: "latest" | "all"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ChecksListForRefRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ChecksListSuitesForRefEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * ref parameter - */ - ref: string; - /** - * Filters check suites by GitHub App `id`. - */ - app_id?: number; - /** - * Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/). - */ - check_name?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ChecksListSuitesForRefRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetCombinedStatusForRefEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * ref parameter - */ - ref: string; -}; -type ReposGetCombinedStatusForRefRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListStatusesForRefEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * ref parameter - */ - ref: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListStatusesForRefRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type CodesOfConductGetForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type CodesOfConductGetForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRetrieveCommunityProfileMetricsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposRetrieveCommunityProfileMetricsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCompareCommitsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * base parameter - */ - base: string; - /** - * head parameter - */ - head: string; -}; -type ReposCompareCommitsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetContentsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * path parameter - */ - path: string; - /** - * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) - */ - ref?: string; -}; -type ReposGetContentsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateOrUpdateFileEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * path parameter - */ - path: string; - /** - * The commit message. - */ - message: string; - /** - * The new file content, using Base64 encoding. - */ - content: string; - /** - * **Required if you are updating a file**. The blob SHA of the file being replaced. - */ - sha?: string; - /** - * The branch name. Default: the repository’s default branch (usually `master`) - */ - branch?: string; - /** - * The person that committed the file. Default: the authenticated user. - */ - committer?: ReposCreateOrUpdateFileParamsCommitter; - /** - * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. - */ - author?: ReposCreateOrUpdateFileParamsAuthor; -}; -type ReposCreateOrUpdateFileRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateFileEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * path parameter - */ - path: string; - /** - * The commit message. - */ - message: string; - /** - * The new file content, using Base64 encoding. - */ - content: string; - /** - * **Required if you are updating a file**. The blob SHA of the file being replaced. - */ - sha?: string; - /** - * The branch name. Default: the repository’s default branch (usually `master`) - */ - branch?: string; - /** - * The person that committed the file. Default: the authenticated user. - */ - committer?: ReposCreateFileParamsCommitter; - /** - * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. - */ - author?: ReposCreateFileParamsAuthor; -}; -type ReposCreateFileRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposUpdateFileEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * path parameter - */ - path: string; - /** - * The commit message. - */ - message: string; - /** - * The new file content, using Base64 encoding. - */ - content: string; - /** - * **Required if you are updating a file**. The blob SHA of the file being replaced. - */ - sha?: string; - /** - * The branch name. Default: the repository’s default branch (usually `master`) - */ - branch?: string; - /** - * The person that committed the file. Default: the authenticated user. - */ - committer?: ReposUpdateFileParamsCommitter; - /** - * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. - */ - author?: ReposUpdateFileParamsAuthor; -}; -type ReposUpdateFileRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposDeleteFileEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * path parameter - */ - path: string; - /** - * The commit message. - */ - message: string; - /** - * The blob SHA of the file being replaced. - */ - sha: string; - /** - * The branch name. Default: the repository’s default branch (usually `master`) - */ - branch?: string; - /** - * object containing information about the committer. - */ - committer?: ReposDeleteFileParamsCommitter; - /** - * object containing information about the author. - */ - author?: ReposDeleteFileParamsAuthor; -}; -type ReposDeleteFileRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListContributorsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Set to `1` or `true` to include anonymous contributors in results. - */ - anon?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListContributorsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListDeploymentsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The SHA recorded at creation time. - */ - sha?: string; - /** - * The name of the ref. This can be a branch, tag, or SHA. - */ - ref?: string; - /** - * The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). - */ - task?: string; - /** - * The name of the environment that was deployed to (e.g., `staging` or `production`). - */ - environment?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListDeploymentsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateDeploymentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The ref to deploy. This can be a branch, tag, or SHA. - */ - ref: string; - /** - * Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). - */ - task?: string; - /** - * Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. - */ - auto_merge?: boolean; - /** - * 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. - */ - required_contexts?: string[]; - /** - * JSON payload with extra information about the deployment. - */ - payload?: string; - /** - * Name for the target deployment environment (e.g., `production`, `staging`, `qa`). - */ - environment?: string; - /** - * Short description of the deployment. - */ - description?: string; - /** - * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` - * **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. - */ - transient_environment?: boolean; - /** - * Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. - * **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. - */ - production_environment?: boolean; -}; -type ReposCreateDeploymentRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetDeploymentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * deployment_id parameter - */ - deployment_id: number; -}; -type ReposGetDeploymentRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListDeploymentStatusesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * deployment_id parameter - */ - deployment_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListDeploymentStatusesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateDeploymentStatusEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * deployment_id parameter - */ - deployment_id: number; - /** - * 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. - */ - state: - | "error" - | "failure" - | "inactive" - | "in_progress" - | "queued" - | "pending" - | "success"; - /** - * 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`. - */ - target_url?: string; - /** - * 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: `""` - * **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. - */ - log_url?: string; - /** - * A short description of the status. The maximum description length is 140 characters. - */ - description?: string; - /** - * 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. - */ - environment?: "production" | "staging" | "qa"; - /** - * Sets the URL for accessing your environment. Default: `""` - * **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. - */ - environment_url?: string; - /** - * 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` - * **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. - * **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. - */ - auto_inactive?: boolean; -}; -type ReposCreateDeploymentStatusRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetDeploymentStatusEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * deployment_id parameter - */ - deployment_id: number; - /** - * status_id parameter - */ - status_id: number; -}; -type ReposGetDeploymentStatusRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateDispatchEventEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * **Required:** A custom webhook event name. - */ - event_type?: string; -}; -type ReposCreateDispatchEventRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListDownloadsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListDownloadsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetDownloadEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * download_id parameter - */ - download_id: number; -}; -type ReposGetDownloadRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposDeleteDownloadEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * download_id parameter - */ - download_id: number; -}; -type ReposDeleteDownloadRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListRepoEventsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListRepoEventsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListForksEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The sort order. Can be either `newest`, `oldest`, or `stargazers`. - */ - sort?: "newest" | "oldest" | "stargazers"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListForksRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateForkEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Optional parameter to specify the organization name if forking into an organization. - */ - organization?: string; -}; -type ReposCreateForkRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitCreateBlobEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The new blob's content. - */ - content: string; - /** - * The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. - */ - encoding?: string; -}; -type GitCreateBlobRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitGetBlobEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * file_sha parameter - */ - file_sha: string; -}; -type GitGetBlobRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitCreateCommitEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The commit message - */ - message: string; - /** - * The SHA of the tree object this commit points to - */ - tree: string; - /** - * 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. - */ - parents: string[]; - /** - * 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. - */ - author?: GitCreateCommitParamsAuthor; - /** - * 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. - */ - committer?: GitCreateCommitParamsCommitter; - /** - * 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. - */ - signature?: string; -}; -type GitCreateCommitRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitGetCommitEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * commit_sha parameter - */ - commit_sha: string; -}; -type GitGetCommitRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitListMatchingRefsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * ref parameter - */ - ref: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type GitListMatchingRefsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitGetRefEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * ref parameter - */ - ref: string; -}; -type GitGetRefRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitCreateRefEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * 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. - */ - ref: string; - /** - * The SHA1 value for this reference. - */ - sha: string; -}; -type GitCreateRefRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitUpdateRefEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * ref parameter - */ - ref: string; - /** - * The SHA1 value to set this reference to - */ - sha: string; - /** - * 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. - */ - force?: boolean; -}; -type GitUpdateRefRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitDeleteRefEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * ref parameter - */ - ref: string; -}; -type GitDeleteRefRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitCreateTagEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The tag's name. This is typically a version (e.g., "v0.0.1"). - */ - tag: string; - /** - * The tag message. - */ - message: string; - /** - * The SHA of the git object this is tagging. - */ - object: string; - /** - * The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. - */ - type: "commit" | "tree" | "blob"; - /** - * An object with information about the individual creating the tag. - */ - tagger?: GitCreateTagParamsTagger; -}; -type GitCreateTagRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitGetTagEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * tag_sha parameter - */ - tag_sha: string; -}; -type GitGetTagRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitCreateTreeEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. - */ - tree: GitCreateTreeParamsTree[]; - /** - * 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. - */ - base_tree?: string; -}; -type GitCreateTreeRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GitGetTreeEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * tree_sha parameter - */ - tree_sha: string; - /** - * recursive parameter - */ - recursive?: "1"; -}; -type GitGetTreeRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListHooksEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListHooksRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateHookEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. - */ - name?: string; - /** - * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). - */ - config: ReposCreateHookParamsConfig; - /** - * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. - */ - events?: string[]; - /** - * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - */ - active?: boolean; -}; -type ReposCreateHookRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetHookEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * hook_id parameter - */ - hook_id: number; -}; -type ReposGetHookRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposUpdateHookEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * hook_id parameter - */ - hook_id: number; - /** - * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). - */ - config?: ReposUpdateHookParamsConfig; - /** - * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events. - */ - events?: string[]; - /** - * Determines a list of events to be added to the list of events that the Hook triggers for. - */ - add_events?: string[]; - /** - * Determines a list of events to be removed from the list of events that the Hook triggers for. - */ - remove_events?: string[]; - /** - * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - */ - active?: boolean; -}; -type ReposUpdateHookRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposDeleteHookEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * hook_id parameter - */ - hook_id: number; -}; -type ReposDeleteHookRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposPingHookEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * hook_id parameter - */ - hook_id: number; -}; -type ReposPingHookRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposTestPushHookEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * hook_id parameter - */ - hook_id: number; -}; -type ReposTestPushHookRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsStartImportEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The URL of the originating repository. - */ - vcs_url: string; - /** - * 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. - */ - vcs?: "subversion" | "git" | "mercurial" | "tfvc"; - /** - * If authentication is required, the username to provide to `vcs_url`. - */ - vcs_username?: string; - /** - * If authentication is required, the password to provide to `vcs_url`. - */ - vcs_password?: string; - /** - * For a tfvc import, the name of the project that is being imported. - */ - tfvc_project?: string; -}; -type MigrationsStartImportRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsGetImportProgressEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type MigrationsGetImportProgressRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsUpdateImportEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The username to provide to the originating repository. - */ - vcs_username?: string; - /** - * The password to provide to the originating repository. - */ - vcs_password?: string; -}; -type MigrationsUpdateImportRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsCancelImportEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type MigrationsCancelImportRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsGetCommitAuthorsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * 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. - */ - since?: string; -}; -type MigrationsGetCommitAuthorsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsMapCommitAuthorEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * author_id parameter - */ - author_id: number; - /** - * The new Git author email. - */ - email?: string; - /** - * The new Git author name. - */ - name?: string; -}; -type MigrationsMapCommitAuthorRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsGetLargeFilesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type MigrationsGetLargeFilesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsSetLfsPreferenceEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * 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). - */ - use_lfs: "opt_in" | "opt_out"; -}; -type MigrationsSetLfsPreferenceRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsGetRepoInstallationEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type AppsGetRepoInstallationRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsFindRepoInstallationEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type AppsFindRepoInstallationRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type InteractionsGetRestrictionsForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type InteractionsGetRestrictionsForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type InteractionsAddOrUpdateRestrictionsForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * 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`. - */ - limit: "existing_users" | "contributors_only" | "collaborators_only"; -}; -type InteractionsAddOrUpdateRestrictionsForRepoRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type InteractionsRemoveRestrictionsForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type InteractionsRemoveRestrictionsForRepoRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListInvitationsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListInvitationsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposDeleteInvitationEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * invitation_id parameter - */ - invitation_id: number; -}; -type ReposDeleteInvitationRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposUpdateInvitationEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * invitation_id parameter - */ - invitation_id: number; - /** - * The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`. - */ - permissions?: "read" | "write" | "admin"; -}; -type ReposUpdateInvitationRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * 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. - */ - milestone?: string; - /** - * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - /** - * Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. - */ - assignee?: string; - /** - * The user that created the issue. - */ - creator?: string; - /** - * A user that's mentioned in the issue. - */ - mentioned?: string; - /** - * A list of comma separated label names. Example: `bug,ui,@high` - */ - labels?: string; - /** - * What to sort results by. Can be either `created`, `updated`, `comments`. - */ - sort?: "created" | "updated" | "comments"; - /** - * The direction of the sort. Can be either `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * 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`. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesCreateEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The title of the issue. - */ - title: string; - /** - * The contents of the issue. - */ - body?: string; - /** - * 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.**_ - */ - assignee?: string; - /** - * 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._ - */ - milestone?: number; - /** - * Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ - */ - labels?: string[]; - /** - * 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._ - */ - assignees?: string[]; -}; -type IssuesCreateRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListCommentsForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Either `created` or `updated`. - */ - sort?: "created" | "updated"; - /** - * Either `asc` or `desc`. Ignored without the `sort` parameter. - */ - direction?: "asc" | "desc"; - /** - * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - since?: string; -}; -type IssuesListCommentsForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesGetCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesGetCommentRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesUpdateCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; - /** - * The contents of the comment. - */ - body: string; -}; -type IssuesUpdateCommentRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesDeleteCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; -}; -type IssuesDeleteCommentRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsListForIssueCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReactionsListForIssueCommentRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsCreateForIssueCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; -}; -type ReactionsCreateForIssueCommentRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListEventsForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListEventsForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesGetEventEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * event_id parameter - */ - event_id: number; -}; -type IssuesGetEventRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesGetEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; -}; -type IssuesGetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesUpdateEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * The title of the issue. - */ - title?: string; - /** - * The contents of the issue. - */ - body?: string; - /** - * Login for the user that this issue should be assigned to. **This field is deprecated.** - */ - assignee?: string; - /** - * State of the issue. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ - */ - milestone?: number | null; - /** - * Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ - */ - labels?: string[]; - /** - * Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ - */ - assignees?: string[]; -}; -type IssuesUpdateRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesAddAssigneesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ - */ - assignees?: string[]; -}; -type IssuesAddAssigneesRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesRemoveAssigneesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ - */ - assignees?: string[]; -}; -type IssuesRemoveAssigneesRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListCommentsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListCommentsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesCreateCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * The contents of the comment. - */ - body: string; -}; -type IssuesCreateCommentRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListEventsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListEventsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListLabelsOnIssueEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListLabelsOnIssueRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesAddLabelsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. - */ - labels: string[]; -}; -type IssuesAddLabelsRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesReplaceLabelsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. - */ - labels?: string[]; -}; -type IssuesReplaceLabelsRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesRemoveLabelsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; -}; -type IssuesRemoveLabelsRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesRemoveLabelEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * name parameter - */ - name: string; -}; -type IssuesRemoveLabelRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesLockEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: - * \* `off-topic` - * \* `too heated` - * \* `resolved` - * \* `spam` - */ - lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; -}; -type IssuesLockRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesUnlockEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; -}; -type IssuesUnlockRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsListForIssueEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReactionsListForIssueRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsCreateForIssueEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; -}; -type ReactionsCreateForIssueRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListEventsForTimelineEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * issue_number parameter - */ - issue_number: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListEventsForTimelineRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListDeployKeysEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListDeployKeysRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposAddDeployKeyEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * A name for the key. - */ - title?: string; - /** - * The contents of the key. - */ - key: string; - /** - * If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. - * - * Deploy 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/)." - */ - read_only?: boolean; -}; -type ReposAddDeployKeyRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetDeployKeyEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * key_id parameter - */ - key_id: number; -}; -type ReposGetDeployKeyRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRemoveDeployKeyEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * key_id parameter - */ - key_id: number; -}; -type ReposRemoveDeployKeyRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListLabelsForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListLabelsForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesCreateLabelEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * 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/). - */ - name: string; - /** - * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. - */ - color: string; - /** - * A short description of the label. - */ - description?: string; -}; -type IssuesCreateLabelRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesGetLabelEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * name parameter - */ - name: string; -}; -type IssuesGetLabelRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesUpdateLabelEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * name parameter - */ - name: string; - /** - * The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). - */ - new_name?: string; - /** - * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. - */ - color?: string; - /** - * A short description of the label. - */ - description?: string; -}; -type IssuesUpdateLabelRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesDeleteLabelEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * name parameter - */ - name: string; -}; -type IssuesDeleteLabelRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListLanguagesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposListLanguagesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type LicensesGetForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type LicensesGetForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposMergeEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The name of the base branch that the head will be merged into. - */ - base: string; - /** - * The head to merge. This can be a branch name or a commit SHA1. - */ - head: string; - /** - * Commit message to use for the merge commit. If omitted, a default message will be used. - */ - commit_message?: string; -}; -type ReposMergeRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListMilestonesForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The state of the milestone. Either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - /** - * What to sort results by. Either `due_on` or `completeness`. - */ - sort?: "due_on" | "completeness"; - /** - * The direction of the sort. Either `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListMilestonesForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesCreateMilestoneEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The title of the milestone. - */ - title: string; - /** - * The state of the milestone. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * A description of the milestone. - */ - description?: string; - /** - * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - due_on?: string; -}; -type IssuesCreateMilestoneRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesGetMilestoneEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * milestone_number parameter - */ - milestone_number: number; -}; -type IssuesGetMilestoneRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesUpdateMilestoneEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * milestone_number parameter - */ - milestone_number: number; - /** - * The title of the milestone. - */ - title?: string; - /** - * The state of the milestone. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * A description of the milestone. - */ - description?: string; - /** - * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - due_on?: string; -}; -type IssuesUpdateMilestoneRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesDeleteMilestoneEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * milestone_number parameter - */ - milestone_number: number; -}; -type IssuesDeleteMilestoneRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListLabelsForMilestoneEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * milestone_number parameter - */ - milestone_number: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListLabelsForMilestoneRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListNotificationsForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * If `true`, show notifications marked as read. - */ - all?: boolean; - /** - * If `true`, only shows notifications in which the user is directly participating or mentioned. - */ - participating?: boolean; - /** - * 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`. - */ - since?: string; - /** - * 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`. - */ - before?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListNotificationsForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityMarkNotificationsAsReadForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. - */ - last_read_at?: string; -}; -type ActivityMarkNotificationsAsReadForRepoRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetPagesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposGetPagesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposEnablePagesSiteEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * source parameter - */ - source?: ReposEnablePagesSiteParamsSource; -}; -type ReposEnablePagesSiteRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposDisablePagesSiteEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposDisablePagesSiteRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposUpdateInformationAboutPagesSiteEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * 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/)." - */ - cname?: string; - /** - * 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"`. - */ - source?: '"gh-pages"' | '"master"' | '"master /docs"'; -}; -type ReposUpdateInformationAboutPagesSiteRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposRequestPageBuildEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposRequestPageBuildRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListPagesBuildsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListPagesBuildsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetLatestPagesBuildEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposGetLatestPagesBuildRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetPagesBuildEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * build_id parameter - */ - build_id: number; -}; -type ReposGetPagesBuildRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsListForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ProjectsListForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsCreateForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The name of the project. - */ - name: string; - /** - * The description of the project. - */ - body?: string; -}; -type ProjectsCreateForRepoRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsListEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Either `open`, `closed`, or `all` to filter by state. - */ - state?: "open" | "closed" | "all"; - /** - * 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`. - */ - head?: string; - /** - * Filter pulls by base branch name. Example: `gh-pages`. - */ - base?: string; - /** - * 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). - */ - sort?: "created" | "updated" | "popularity" | "long-running"; - /** - * The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. - */ - direction?: "asc" | "desc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type PullsListRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsCreateEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The title of the new pull request. - */ - title: string; - /** - * The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. - */ - head: string; - /** - * The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. - */ - base: string; - /** - * The contents of the pull request. - */ - body?: string; - /** - * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. - */ - maintainer_can_modify?: boolean; - /** - * Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. - */ - draft?: boolean; -}; -type PullsCreateRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsListCommentsForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Can be either `created` or `updated` comments. - */ - sort?: "created" | "updated"; - /** - * Can be either `asc` or `desc`. Ignored without `sort` parameter. - */ - direction?: "asc" | "desc"; - /** - * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type PullsListCommentsForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsGetCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; -}; -type PullsGetCommentRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsUpdateCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; - /** - * The text of the reply to the review comment. - */ - body: string; -}; -type PullsUpdateCommentRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsDeleteCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; -}; -type PullsDeleteCommentRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsListForPullRequestReviewCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; - /** - * 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. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReactionsListForPullRequestReviewCommentRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsCreateForPullRequestReviewCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * comment_id parameter - */ - comment_id: number; - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; -}; -type ReactionsCreateForPullRequestReviewCommentRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsGetEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; -}; -type PullsGetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsUpdateEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * The title of the pull request. - */ - title?: string; - /** - * The contents of the pull request. - */ - body?: string; - /** - * State of this Pull Request. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. - */ - base?: string; - /** - * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. - */ - maintainer_can_modify?: boolean; -}; -type PullsUpdateRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsListCommentsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * Can be either `created` or `updated` comments. - */ - sort?: "created" | "updated"; - /** - * Can be either `asc` or `desc`. Ignored without `sort` parameter. - */ - direction?: "asc" | "desc"; - /** - * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type PullsListCommentsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsCreateCommentEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * The relative path to the file that necessitates a comment. - */ - path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; -}; -type PullsCreateCommentRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsCreateCommentReplyEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * The relative path to the file that necessitates a comment. - */ - path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; -}; -type PullsCreateCommentReplyRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsCreateReviewCommentReplyEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * comment_id parameter - */ - comment_id: number; - /** - * The text of the review comment. - */ - body: string; -}; -type PullsCreateReviewCommentReplyRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsListCommitsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type PullsListCommitsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsListFilesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type PullsListFilesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsCheckIfMergedEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; -}; -type PullsCheckIfMergedRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsMergeEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * Title for the automatic commit message. - */ - commit_title?: string; - /** - * Extra detail to append to automatic commit message. - */ - commit_message?: string; - /** - * SHA that pull request head must match to allow merge. - */ - sha?: string; - /** - * Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. - */ - merge_method?: "merge" | "squash" | "rebase"; -}; -type PullsMergeRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsListReviewRequestsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type PullsListReviewRequestsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsCreateReviewRequestEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * An array of user `login`s that will be requested. - */ - reviewers?: string[]; - /** - * An array of team `slug`s that will be requested. - */ - team_reviewers?: string[]; -}; -type PullsCreateReviewRequestRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsDeleteReviewRequestEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * An array of user `login`s that will be removed. - */ - reviewers?: string[]; - /** - * An array of team `slug`s that will be removed. - */ - team_reviewers?: string[]; -}; -type PullsDeleteReviewRequestRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsListReviewsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type PullsListReviewsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsCreateReviewEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. - */ - commit_id?: string; - /** - * **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. - */ - body?: string; - /** - * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready. - */ - event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; - /** - * Use the following table to specify the location, destination, and contents of the draft review comment. - */ - comments?: PullsCreateReviewParamsComments[]; -}; -type PullsCreateReviewRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsGetReviewEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * review_id parameter - */ - review_id: number; -}; -type PullsGetReviewRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsDeletePendingReviewEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * review_id parameter - */ - review_id: number; -}; -type PullsDeletePendingReviewRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsUpdateReviewEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * review_id parameter - */ - review_id: number; - /** - * The body text of the pull request review. - */ - body: string; -}; -type PullsUpdateReviewRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsGetCommentsForReviewEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * review_id parameter - */ - review_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type PullsGetCommentsForReviewRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsDismissReviewEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * review_id parameter - */ - review_id: number; - /** - * The message for the pull request review dismissal - */ - message: string; -}; -type PullsDismissReviewRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsSubmitReviewEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * review_id parameter - */ - review_id: number; - /** - * The body text of the pull request review - */ - body?: string; - /** - * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. - */ - event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; -}; -type PullsSubmitReviewRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type PullsUpdateBranchEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * pull_number parameter - */ - pull_number: number; - /** - * 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. - */ - expected_head_sha?: string; -}; -type PullsUpdateBranchRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetReadmeEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) - */ - ref?: string; -}; -type ReposGetReadmeRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListReleasesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListReleasesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateReleaseEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The name of the tag. - */ - tag_name: string; - /** - * 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`). - */ - target_commitish?: string; - /** - * The name of the release. - */ - name?: string; - /** - * Text describing the contents of the tag. - */ - body?: string; - /** - * `true` to create a draft (unpublished) release, `false` to create a published one. - */ - draft?: boolean; - /** - * `true` to identify the release as a prerelease. `false` to identify the release as a full release. - */ - prerelease?: boolean; -}; -type ReposCreateReleaseRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetReleaseAssetEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * asset_id parameter - */ - asset_id: number; -}; -type ReposGetReleaseAssetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposUpdateReleaseAssetEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * asset_id parameter - */ - asset_id: number; - /** - * The file name of the asset. - */ - name?: string; - /** - * An alternate short description of the asset. Used in place of the filename. - */ - label?: string; -}; -type ReposUpdateReleaseAssetRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposDeleteReleaseAssetEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * asset_id parameter - */ - asset_id: number; -}; -type ReposDeleteReleaseAssetRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetLatestReleaseEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposGetLatestReleaseRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetReleaseByTagEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * tag parameter - */ - tag: string; -}; -type ReposGetReleaseByTagRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetReleaseEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * release_id parameter - */ - release_id: number; -}; -type ReposGetReleaseRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposUpdateReleaseEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * release_id parameter - */ - release_id: number; - /** - * The name of the tag. - */ - tag_name?: string; - /** - * 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`). - */ - target_commitish?: string; - /** - * The name of the release. - */ - name?: string; - /** - * Text describing the contents of the tag. - */ - body?: string; - /** - * `true` makes the release a draft, and `false` publishes the release. - */ - draft?: boolean; - /** - * `true` to identify the release as a prerelease, `false` to identify the release as a full release. - */ - prerelease?: boolean; -}; -type ReposUpdateReleaseRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposDeleteReleaseEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * release_id parameter - */ - release_id: number; -}; -type ReposDeleteReleaseRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListAssetsForReleaseEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * release_id parameter - */ - release_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListAssetsForReleaseRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListStargazersForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListStargazersForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetCodeFrequencyStatsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposGetCodeFrequencyStatsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetCommitActivityStatsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposGetCommitActivityStatsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetContributorsStatsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposGetContributorsStatsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetParticipationStatsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposGetParticipationStatsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetPunchCardStatsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposGetPunchCardStatsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateStatusEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * sha parameter - */ - sha: string; - /** - * The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. - */ - state: "error" | "failure" | "pending" | "success"; - /** - * 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. - * For 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: - * `http://ci.example.com/user/repo/build/sha` - */ - target_url?: string; - /** - * A short description of the status. - */ - description?: string; - /** - * A string label to differentiate this status from the status of other systems. - */ - context?: string; -}; -type ReposCreateStatusRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListWatchersForRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListWatchersForRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityGetRepoSubscriptionEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ActivityGetRepoSubscriptionRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivitySetRepoSubscriptionEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Determines if notifications should be received from this repository. - */ - subscribed?: boolean; - /** - * Determines if all notifications should be blocked from this repository. - */ - ignored?: boolean; -}; -type ActivitySetRepoSubscriptionRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityDeleteRepoSubscriptionEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ActivityDeleteRepoSubscriptionRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListTagsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListTagsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListTeamsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListTeamsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListTopicsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposListTopicsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposReplaceTopicsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * 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. - */ - names: string[]; -}; -type ReposReplaceTopicsRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetClonesEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Must be one of: `day`, `week`. - */ - per?: "day" | "week"; -}; -type ReposGetClonesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetTopPathsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposGetTopPathsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetTopReferrersEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposGetTopReferrersRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetViewsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * Must be one of: `day`, `week`. - */ - per?: "day" | "week"; -}; -type ReposGetViewsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposTransferEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * **Required:** The username or organization name the repository will be transferred to. - */ - new_owner?: string; - /** - * ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. - */ - team_ids?: number[]; -}; -type ReposTransferRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCheckVulnerabilityAlertsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposCheckVulnerabilityAlertsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposEnableVulnerabilityAlertsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposEnableVulnerabilityAlertsRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposDisableVulnerabilityAlertsEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ReposDisableVulnerabilityAlertsRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposGetArchiveLinkEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * archive_format parameter - */ - archive_format: string; - /** - * ref parameter - */ - ref: string; -}; -type ReposGetArchiveLinkRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateUsingTemplateEndpoint = { - /** - * template_owner parameter - */ - template_owner: string; - /** - * template_repo parameter - */ - template_repo: string; - /** - * 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. - */ - owner?: string; - /** - * The name of the new repository. - */ - name: string; - /** - * A short description of the new repository. - */ - description?: string; - /** - * Either `true` to create a new private repository or `false` to create a new public one. - */ - private?: boolean; -}; -type ReposCreateUsingTemplateRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListPublicEndpoint = { - /** - * The integer ID of the last Repository that you've seen. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListPublicRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ScimListProvisionedIdentitiesEndpoint = { - /** - * org parameter - */ - org: string; - /** - * Used for pagination: the index of the first result to return. - */ - startIndex?: number; - /** - * Used for pagination: the number of results to return. - */ - count?: number; - /** - * 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\"`. - */ - filter?: string; -}; -type ScimListProvisionedIdentitiesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ScimProvisionAndInviteUsersEndpoint = { - /** - * org parameter - */ - org: string; -}; -type ScimProvisionAndInviteUsersRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ScimProvisionInviteUsersEndpoint = { - /** - * org parameter - */ - org: string; -}; -type ScimProvisionInviteUsersRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ScimGetProvisioningDetailsForUserEndpoint = { - /** - * org parameter - */ - org: string; - /** - * scim_user_id parameter - */ - scim_user_id: number; -}; -type ScimGetProvisioningDetailsForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ScimReplaceProvisionedUserInformationEndpoint = { - /** - * org parameter - */ - org: string; - /** - * scim_user_id parameter - */ - scim_user_id: number; -}; -type ScimReplaceProvisionedUserInformationRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ScimUpdateProvisionedOrgMembershipEndpoint = { - /** - * org parameter - */ - org: string; - /** - * scim_user_id parameter - */ - scim_user_id: number; -}; -type ScimUpdateProvisionedOrgMembershipRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ScimUpdateUserAttributeEndpoint = { - /** - * org parameter - */ - org: string; - /** - * scim_user_id parameter - */ - scim_user_id: number; -}; -type ScimUpdateUserAttributeRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ScimRemoveUserFromOrgEndpoint = { - /** - * org parameter - */ - org: string; - /** - * scim_user_id parameter - */ - scim_user_id: number; -}; -type ScimRemoveUserFromOrgRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type SearchCodeEndpoint = { - /** - * 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. - */ - q: string; - /** - * 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) - */ - sort?: "indexed"; - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type SearchCodeRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type SearchCommitsEndpoint = { - /** - * 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. - */ - q: string; - /** - * Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) - */ - sort?: "author-date" | "committer-date"; - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type SearchCommitsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type SearchIssuesAndPullRequestsEndpoint = { - /** - * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. - */ - q: string; - /** - * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) - */ - sort?: - | "comments" - | "reactions" - | "reactions-+1" - | "reactions--1" - | "reactions-smile" - | "reactions-thinking_face" - | "reactions-heart" - | "reactions-tada" - | "interactions" - | "created" - | "updated"; - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type SearchIssuesAndPullRequestsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type SearchIssuesEndpoint = { - /** - * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. - */ - q: string; - /** - * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) - */ - sort?: - | "comments" - | "reactions" - | "reactions-+1" - | "reactions--1" - | "reactions-smile" - | "reactions-thinking_face" - | "reactions-heart" - | "reactions-tada" - | "interactions" - | "created" - | "updated"; - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type SearchIssuesRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type SearchLabelsEndpoint = { - /** - * The id of the repository. - */ - repository_id: number; - /** - * 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). - */ - q: string; - /** - * 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) - */ - sort?: "created" | "updated"; - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; -}; -type SearchLabelsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type SearchReposEndpoint = { - /** - * 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. - */ - q: string; - /** - * 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) - */ - sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type SearchReposRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type SearchTopicsEndpoint = { - /** - * 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). - */ - q: string; -}; -type SearchTopicsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type SearchUsersEndpoint = { - /** - * 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. - */ - q: string; - /** - * 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) - */ - sort?: "followers" | "repositories" | "joined"; - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type SearchUsersRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsGetEndpoint = { - /** - * team_id parameter - */ - team_id: number; -}; -type TeamsGetRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsUpdateEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * The name of the team. - */ - name: string; - /** - * The description of the team. - */ - description?: string; - /** - * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * \* `secret` - only visible to organization owners and members of this team. - * \* `closed` - visible to all members of this organization. - * **For a parent or child team:** - * \* `closed` - visible to all members of this organization. - */ - privacy?: "secret" | "closed"; - /** - * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: - * \* `pull` - team members can pull, but not push to or administer newly-added repositories. - * \* `push` - team members can pull and push, but not administer newly-added repositories. - * \* `admin` - team members can pull, push and administer newly-added repositories. - */ - permission?: "pull" | "push" | "admin"; - /** - * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. - */ - parent_team_id?: number; -}; -type TeamsUpdateRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsDeleteEndpoint = { - /** - * team_id parameter - */ - team_id: number; -}; -type TeamsDeleteRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsListDiscussionsEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type TeamsListDiscussionsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsCreateDiscussionEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * The discussion post's title. - */ - title: string; - /** - * The discussion post's body text. - */ - body: string; - /** - * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - */ - private?: boolean; -}; -type TeamsCreateDiscussionRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsGetDiscussionEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * discussion_number parameter - */ - discussion_number: number; -}; -type TeamsGetDiscussionRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsUpdateDiscussionEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * discussion_number parameter - */ - discussion_number: number; - /** - * The discussion post's title. - */ - title?: string; - /** - * The discussion post's body text. - */ - body?: string; -}; -type TeamsUpdateDiscussionRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsDeleteDiscussionEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * discussion_number parameter - */ - discussion_number: number; -}; -type TeamsDeleteDiscussionRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsListDiscussionCommentsEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * discussion_number parameter - */ - discussion_number: number; - /** - * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type TeamsListDiscussionCommentsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsCreateDiscussionCommentEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * discussion_number parameter - */ - discussion_number: number; - /** - * The discussion comment's body text. - */ - body: string; -}; -type TeamsCreateDiscussionCommentRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsGetDiscussionCommentEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * discussion_number parameter - */ - discussion_number: number; - /** - * comment_number parameter - */ - comment_number: number; -}; -type TeamsGetDiscussionCommentRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsUpdateDiscussionCommentEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * discussion_number parameter - */ - discussion_number: number; - /** - * comment_number parameter - */ - comment_number: number; - /** - * The discussion comment's body text. - */ - body: string; -}; -type TeamsUpdateDiscussionCommentRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsDeleteDiscussionCommentEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * discussion_number parameter - */ - discussion_number: number; - /** - * comment_number parameter - */ - comment_number: number; -}; -type TeamsDeleteDiscussionCommentRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsListForTeamDiscussionCommentEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * discussion_number parameter - */ - discussion_number: number; - /** - * comment_number parameter - */ - comment_number: number; - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReactionsListForTeamDiscussionCommentRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsCreateForTeamDiscussionCommentEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * discussion_number parameter - */ - discussion_number: number; - /** - * comment_number parameter - */ - comment_number: number; - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; -}; -type ReactionsCreateForTeamDiscussionCommentRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsListForTeamDiscussionEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * discussion_number parameter - */ - discussion_number: number; - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReactionsListForTeamDiscussionRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReactionsCreateForTeamDiscussionEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * discussion_number parameter - */ - discussion_number: number; - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; -}; -type ReactionsCreateForTeamDiscussionRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsListPendingInvitationsEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type TeamsListPendingInvitationsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsListMembersEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * Filters members returned by their role in the team. Can be one of: - * \* `member` - normal members of the team. - * \* `maintainer` - team maintainers. - * \* `all` - all members of the team. - */ - role?: "member" | "maintainer" | "all"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type TeamsListMembersRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsGetMemberEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * username parameter - */ - username: string; -}; -type TeamsGetMemberRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsAddMemberEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * username parameter - */ - username: string; -}; -type TeamsAddMemberRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsRemoveMemberEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * username parameter - */ - username: string; -}; -type TeamsRemoveMemberRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsGetMembershipEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * username parameter - */ - username: string; -}; -type TeamsGetMembershipRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsAddOrUpdateMembershipEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * username parameter - */ - username: string; - /** - * The role that this user should have in the team. Can be one of: - * \* `member` - a normal member of the team. - * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. - */ - role?: "member" | "maintainer"; -}; -type TeamsAddOrUpdateMembershipRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsRemoveMembershipEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * username parameter - */ - username: string; -}; -type TeamsRemoveMembershipRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsListProjectsEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type TeamsListProjectsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsReviewProjectEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * project_id parameter - */ - project_id: number; -}; -type TeamsReviewProjectRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsAddOrUpdateProjectEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * project_id parameter - */ - project_id: number; - /** - * The permission to grant to the team for this project. Can be one of: - * \* `read` - team members can read, but not write to or administer this project. - * \* `write` - team members can read and write, but not administer this project. - * \* `admin` - team members can read, write and administer this project. - * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team. - */ - permission?: "read" | "write" | "admin"; -}; -type TeamsAddOrUpdateProjectRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsRemoveProjectEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * project_id parameter - */ - project_id: number; -}; -type TeamsRemoveProjectRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsListReposEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type TeamsListReposRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsCheckManagesRepoEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type TeamsCheckManagesRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsAddOrUpdateRepoEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; - /** - * The permission to grant the team on this repository. Can be one of: - * \* `pull` - team members can pull, but not push to or administer this repository. - * \* `push` - team members can pull and push, but not administer this repository. - * \* `admin` - team members can pull, push and administer this repository. - * - * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team. - */ - permission?: "pull" | "push" | "admin"; -}; -type TeamsAddOrUpdateRepoRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsRemoveRepoEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type TeamsRemoveRepoRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsListIdPGroupsEndpoint = { - /** - * team_id parameter - */ - team_id: number; -}; -type TeamsListIdPGroupsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsCreateOrUpdateIdPGroupConnectionsEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * 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. - */ - groups: TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups[]; -}; -type TeamsCreateOrUpdateIdPGroupConnectionsRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsListChildEndpoint = { - /** - * team_id parameter - */ - team_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type TeamsListChildRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersGetAuthenticatedEndpoint = {}; -type UsersGetAuthenticatedRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersUpdateAuthenticatedEndpoint = { - /** - * The new name of the user. - */ - name?: string; - /** - * The publicly visible email address of the user. - */ - email?: string; - /** - * The new blog URL of the user. - */ - blog?: string; - /** - * The new company of the user. - */ - company?: string; - /** - * The new location of the user. - */ - location?: string; - /** - * The new hiring availability of the user. - */ - hireable?: boolean; - /** - * The new short biography of the user. - */ - bio?: string; -}; -type UsersUpdateAuthenticatedRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersListBlockedEndpoint = {}; -type UsersListBlockedRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersCheckBlockedEndpoint = { - /** - * username parameter - */ - username: string; -}; -type UsersCheckBlockedRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersBlockEndpoint = { - /** - * username parameter - */ - username: string; -}; -type UsersBlockRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersUnblockEndpoint = { - /** - * username parameter - */ - username: string; -}; -type UsersUnblockRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersTogglePrimaryEmailVisibilityEndpoint = { - /** - * Specify the _primary_ email address that needs a visibility change. - */ - email: string; - /** - * 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. - */ - visibility: string; -}; -type UsersTogglePrimaryEmailVisibilityRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersListEmailsEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type UsersListEmailsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersAddEmailsEndpoint = { - /** - * 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. - */ - emails: string[]; -}; -type UsersAddEmailsRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersDeleteEmailsEndpoint = { - /** - * 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. - */ - emails: string[]; -}; -type UsersDeleteEmailsRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersListFollowersForAuthenticatedUserEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type UsersListFollowersForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersListFollowingForAuthenticatedUserEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type UsersListFollowingForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersCheckFollowingEndpoint = { - /** - * username parameter - */ - username: string; -}; -type UsersCheckFollowingRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersFollowEndpoint = { - /** - * username parameter - */ - username: string; -}; -type UsersFollowRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersUnfollowEndpoint = { - /** - * username parameter - */ - username: string; -}; -type UsersUnfollowRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersListGpgKeysEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type UsersListGpgKeysRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersCreateGpgKeyEndpoint = { - /** - * 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. - */ - armored_public_key?: string; -}; -type UsersCreateGpgKeyRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersGetGpgKeyEndpoint = { - /** - * gpg_key_id parameter - */ - gpg_key_id: number; -}; -type UsersGetGpgKeyRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersDeleteGpgKeyEndpoint = { - /** - * gpg_key_id parameter - */ - gpg_key_id: number; -}; -type UsersDeleteGpgKeyRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsListInstallationsForAuthenticatedUserEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type AppsListInstallationsForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsListInstallationReposForAuthenticatedUserEndpoint = { - /** - * installation_id parameter - */ - installation_id: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type AppsListInstallationReposForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsAddRepoToInstallationEndpoint = { - /** - * installation_id parameter - */ - installation_id: number; - /** - * repository_id parameter - */ - repository_id: number; -}; -type AppsAddRepoToInstallationRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsRemoveRepoFromInstallationEndpoint = { - /** - * installation_id parameter - */ - installation_id: number; - /** - * repository_id parameter - */ - repository_id: number; -}; -type AppsRemoveRepoFromInstallationRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type IssuesListForAuthenticatedUserEndpoint = { - /** - * Indicates which sorts of issues to return. Can be one of: - * \* `assigned`: Issues assigned to you - * \* `created`: Issues created by you - * \* `mentioned`: Issues mentioning you - * \* `subscribed`: Issues you're subscribed to updates for - * \* `all`: All issues the authenticated user can see, regardless of participation or creation - */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; - /** - * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - /** - * A list of comma separated label names. Example: `bug,ui,@high` - */ - labels?: string; - /** - * What to sort results by. Can be either `created`, `updated`, `comments`. - */ - sort?: "created" | "updated" | "comments"; - /** - * The direction of the sort. Can be either `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * 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`. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type IssuesListForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersListPublicKeysEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type UsersListPublicKeysRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersCreatePublicKeyEndpoint = { - /** - * 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". - */ - title?: string; - /** - * 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. - */ - key?: string; -}; -type UsersCreatePublicKeyRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersGetPublicKeyEndpoint = { - /** - * key_id parameter - */ - key_id: number; -}; -type UsersGetPublicKeyRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersDeletePublicKeyEndpoint = { - /** - * key_id parameter - */ - key_id: number; -}; -type UsersDeletePublicKeyRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsListMarketplacePurchasesForAuthenticatedUserEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type AppsListMarketplacePurchasesForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type AppsListMarketplacePurchasesForAuthenticatedUserStubbedRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListMembershipsEndpoint = { - /** - * 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. - */ - state?: "active" | "pending"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type OrgsListMembershipsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsGetMembershipForAuthenticatedUserEndpoint = { - /** - * org parameter - */ - org: string; -}; -type OrgsGetMembershipForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsUpdateMembershipEndpoint = { - /** - * org parameter - */ - org: string; - /** - * The state that the membership should be in. Only `"active"` will be accepted. - */ - state: "active"; -}; -type OrgsUpdateMembershipRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsStartForAuthenticatedUserEndpoint = { - /** - * An array of repositories to include in the migration. - */ - repositories: string[]; - /** - * Locks the `repositories` to prevent changes during the migration when set to `true`. - */ - lock_repositories?: boolean; - /** - * 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. - */ - exclude_attachments?: boolean; -}; -type MigrationsStartForAuthenticatedUserRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsListForAuthenticatedUserEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type MigrationsListForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsGetStatusForAuthenticatedUserEndpoint = { - /** - * migration_id parameter - */ - migration_id: number; -}; -type MigrationsGetStatusForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsGetArchiveForAuthenticatedUserEndpoint = { - /** - * migration_id parameter - */ - migration_id: number; -}; -type MigrationsGetArchiveForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsDeleteArchiveForAuthenticatedUserEndpoint = { - /** - * migration_id parameter - */ - migration_id: number; -}; -type MigrationsDeleteArchiveForAuthenticatedUserRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type MigrationsUnlockRepoForAuthenticatedUserEndpoint = { - /** - * migration_id parameter - */ - migration_id: number; - /** - * repo_name parameter - */ - repo_name: string; -}; -type MigrationsUnlockRepoForAuthenticatedUserRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListForAuthenticatedUserEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type OrgsListForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsCreateForAuthenticatedUserEndpoint = { - /** - * The name of the project. - */ - name: string; - /** - * The description of the project. - */ - body?: string; -}; -type ProjectsCreateForAuthenticatedUserRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersListPublicEmailsEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type UsersListPublicEmailsRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListEndpoint = { - /** - * Can be one of `all`, `public`, or `private`. - */ - visibility?: "all" | "public" | "private"; - /** - * Comma-separated list of values. Can include: - * \* `owner`: Repositories that are owned by the authenticated user. - * \* `collaborator`: Repositories that the user has been added to as a collaborator. - * \* `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. - */ - affiliation?: string; - /** - * Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` - * - * Will 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**. - */ - type?: "all" | "owner" | "public" | "private" | "member"; - /** - * Can be one of `created`, `updated`, `pushed`, `full_name`. - */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** - * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` - */ - direction?: "asc" | "desc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposCreateForAuthenticatedUserEndpoint = { - /** - * The name of the repository. - */ - name: string; - /** - * A short description of the repository. - */ - description?: string; - /** - * A URL with more information about the repository. - */ - homepage?: string; - /** - * Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account. - */ - private?: boolean; - /** - * Either `true` to enable issues for this repository or `false` to disable them. - */ - has_issues?: boolean; - /** - * 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. - */ - has_projects?: boolean; - /** - * Either `true` to enable the wiki for this repository or `false` to disable it. - */ - has_wiki?: boolean; - /** - * Either `true` to make this repo available as a template repository or `false` to prevent it. - */ - is_template?: boolean; - /** - * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. - */ - team_id?: number; - /** - * Pass `true` to create an initial commit with empty README. - */ - auto_init?: boolean; - /** - * 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". - */ - gitignore_template?: string; - /** - * 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". - */ - license_template?: string; - /** - * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. - */ - allow_squash_merge?: boolean; - /** - * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. - */ - allow_merge_commit?: boolean; - /** - * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. - */ - allow_rebase_merge?: boolean; -}; -type ReposCreateForAuthenticatedUserRequestOptions = { - method: "POST"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListInvitationsForAuthenticatedUserEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListInvitationsForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposAcceptInvitationEndpoint = { - /** - * invitation_id parameter - */ - invitation_id: number; -}; -type ReposAcceptInvitationRequestOptions = { - method: "PATCH"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposDeclineInvitationEndpoint = { - /** - * invitation_id parameter - */ - invitation_id: number; -}; -type ReposDeclineInvitationRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListReposStarredByAuthenticatedUserEndpoint = { - /** - * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). - */ - sort?: "created" | "updated"; - /** - * One of `asc` (ascending) or `desc` (descending). - */ - direction?: "asc" | "desc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListReposStarredByAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityCheckStarringRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ActivityCheckStarringRepoRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityStarRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ActivityStarRepoRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityUnstarRepoEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ActivityUnstarRepoRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListWatchedReposForAuthenticatedUserEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListWatchedReposForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityCheckWatchingRepoLegacyEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ActivityCheckWatchingRepoLegacyRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityWatchRepoLegacyEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ActivityWatchRepoLegacyRequestOptions = { - method: "PUT"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityStopWatchingRepoLegacyEndpoint = { - /** - * owner parameter - */ - owner: string; - /** - * repo parameter - */ - repo: string; -}; -type ActivityStopWatchingRepoLegacyRequestOptions = { - method: "DELETE"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type TeamsListForAuthenticatedUserEndpoint = { - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type TeamsListForAuthenticatedUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersListEndpoint = { - /** - * The integer ID of the last User that you've seen. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type UsersListRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersGetByUsernameEndpoint = { - /** - * username parameter - */ - username: string; -}; -type UsersGetByUsernameRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListEventsForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListEventsForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListEventsForOrgEndpoint = { - /** - * username parameter - */ - username: string; - /** - * org parameter - */ - org: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListEventsForOrgRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListPublicEventsForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListPublicEventsForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersListFollowersForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type UsersListFollowersForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersListFollowingForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type UsersListFollowingForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersCheckFollowingForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * target_user parameter - */ - target_user: string; -}; -type UsersCheckFollowingForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type GistsListPublicForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * 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. - */ - since?: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type GistsListPublicForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersListGpgKeysForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type UsersListGpgKeysForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersGetContextForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * 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`. - */ - subject_type?: "organization" | "repository" | "issue" | "pull_request"; - /** - * Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. - */ - subject_id?: string; -}; -type UsersGetContextForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsGetUserInstallationEndpoint = { - /** - * username parameter - */ - username: string; -}; -type AppsGetUserInstallationRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type AppsFindUserInstallationEndpoint = { - /** - * username parameter - */ - username: string; -}; -type AppsFindUserInstallationRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type UsersListPublicKeysForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type UsersListPublicKeysForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type OrgsListForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type OrgsListForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ProjectsListForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. - */ - state?: "open" | "closed" | "all"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ProjectsListForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListReceivedEventsForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListReceivedEventsForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListReceivedPublicEventsForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListReceivedPublicEventsForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ReposListForUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * Can be one of `all`, `owner`, `member`. - */ - type?: "all" | "owner" | "member"; - /** - * Can be one of `created`, `updated`, `pushed`, `full_name`. - */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** - * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` - */ - direction?: "asc" | "desc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ReposListForUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListReposStarredByUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). - */ - sort?: "created" | "updated"; - /** - * One of `asc` (ascending) or `desc` (descending). - */ - direction?: "asc" | "desc"; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListReposStarredByUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; -type ActivityListReposWatchedByUserEndpoint = { - /** - * username parameter - */ - username: string; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Page number of the results to fetch. - */ - page?: number; -}; -type ActivityListReposWatchedByUserRequestOptions = { - method: "GET"; - url: Url; - headers: RequestHeaders; - request: RequestRequestOptions; -}; - -export type AppsCreateInstallationTokenParamsPermissions = {}; -export type GistsCreateParamsFiles = { - content?: string; -}; -export type GistsUpdateParamsFiles = { - content?: string; - filename?: string; -}; -export type OrgsCreateHookParamsConfig = { - url: string; - content_type?: string; - secret?: string; - insecure_ssl?: string; -}; -export type OrgsUpdateHookParamsConfig = { - url: string; - content_type?: string; - secret?: string; - insecure_ssl?: string; -}; -export type ReposUpdateBranchProtectionParamsRequiredStatusChecks = { - strict: boolean; - contexts: string[]; -}; -export type ReposUpdateBranchProtectionParamsRequiredPullRequestReviews = { - dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions; - dismiss_stale_reviews?: boolean; - require_code_owner_reviews?: boolean; - required_approving_review_count?: number; -}; -export type ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions = { - users?: string[]; - teams?: string[]; -}; -export type ReposUpdateBranchProtectionParamsRestrictions = { - users: string[]; - teams: string[]; - apps?: string[]; -}; -export type ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions = { - users?: string[]; - teams?: string[]; -}; -export type ChecksCreateParamsOutput = { - title: string; - summary: string; - text?: string; - annotations?: ChecksCreateParamsOutputAnnotations[]; - images?: ChecksCreateParamsOutputImages[]; -}; -export type ChecksCreateParamsOutputAnnotations = { - path: string; - start_line: number; - end_line: number; - start_column?: number; - end_column?: number; - annotation_level: "notice" | "warning" | "failure"; - message: string; - title?: string; - raw_details?: string; -}; -export type ChecksCreateParamsOutputImages = { - alt: string; - image_url: string; - caption?: string; -}; -export type ChecksCreateParamsActions = { - label: string; - description: string; - identifier: string; -}; -export type ChecksUpdateParamsOutput = { - title?: string; - summary: string; - text?: string; - annotations?: ChecksUpdateParamsOutputAnnotations[]; - images?: ChecksUpdateParamsOutputImages[]; -}; -export type ChecksUpdateParamsOutputAnnotations = { - path: string; - start_line: number; - end_line: number; - start_column?: number; - end_column?: number; - annotation_level: "notice" | "warning" | "failure"; - message: string; - title?: string; - raw_details?: string; -}; -export type ChecksUpdateParamsOutputImages = { - alt: string; - image_url: string; - caption?: string; -}; -export type ChecksUpdateParamsActions = { - label: string; - description: string; - identifier: string; -}; -export type ChecksSetSuitesPreferencesParamsAutoTriggerChecks = { - app_id: number; - setting: boolean; -}; -export type ReposCreateOrUpdateFileParamsCommitter = { - name: string; - email: string; -}; -export type ReposCreateOrUpdateFileParamsAuthor = { - name: string; - email: string; -}; -export type ReposCreateFileParamsCommitter = { - name: string; - email: string; -}; -export type ReposCreateFileParamsAuthor = { - name: string; - email: string; -}; -export type ReposUpdateFileParamsCommitter = { - name: string; - email: string; -}; -export type ReposUpdateFileParamsAuthor = { - name: string; - email: string; -}; -export type ReposDeleteFileParamsCommitter = { - name?: string; - email?: string; -}; -export type ReposDeleteFileParamsAuthor = { - name?: string; - email?: string; -}; -export type GitCreateCommitParamsAuthor = { - name?: string; - email?: string; - date?: string; -}; -export type GitCreateCommitParamsCommitter = { - name?: string; - email?: string; - date?: string; -}; -export type GitCreateTagParamsTagger = { - name?: string; - email?: string; - date?: string; -}; -export type GitCreateTreeParamsTree = { - path?: string; - mode?: "100644" | "100755" | "040000" | "160000" | "120000"; - type?: "blob" | "tree" | "commit"; - sha?: string; - content?: string; -}; -export type ReposCreateHookParamsConfig = { - url: string; - content_type?: string; - secret?: string; - insecure_ssl?: string; -}; -export type ReposUpdateHookParamsConfig = { - url: string; - content_type?: string; - secret?: string; - insecure_ssl?: string; -}; -export type ReposEnablePagesSiteParamsSource = { - branch?: "master" | "gh-pages"; - path?: string; -}; -export type PullsCreateReviewParamsComments = { - path: string; - position: number; - body: string; -}; -export type TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups = { - group_id: string; - group_name: string; - group_description: string; -}; diff --git a/node_modules/@octokit/types/src/generated/README.md b/node_modules/@octokit/types/src/generated/README.md deleted file mode 100644 index 2bc90d2..0000000 --- a/node_modules/@octokit/types/src/generated/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# ⚠️ Do not edit files in this folder - -All files are generated. Manual changes will be overwritten. If you find a problem, please look into how they are generated. When in doubt, please open a new issue. diff --git a/node_modules/@types/node/LICENSE b/node_modules/@types/node/LICENSE index 4b1ad51..9e841e7 100644 --- a/node_modules/@types/node/LICENSE +++ b/node_modules/@types/node/LICENSE @@ -1,21 +1,21 @@ - MIT License - - Copyright (c) Microsoft Corporation. All rights reserved. - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to deal - in the Software without restriction, including without limitation the rights - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE + MIT License + + Copyright (c) Microsoft Corporation. + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE diff --git a/node_modules/@types/node/README.md b/node_modules/@types/node/README.md index d842f1f..b100407 100644 --- a/node_modules/@types/node/README.md +++ b/node_modules/@types/node/README.md @@ -8,9 +8,9 @@ This package contains type definitions for Node.js (http://nodejs.org/). Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node. ### Additional Details - * Last updated: Tue, 19 Nov 2019 19:44:54 GMT + * Last updated: Tue, 19 Jan 2021 23:09:28 GMT * Dependencies: none - * Global values: `Buffer`, `NodeJS`, `Symbol`, `__dirname`, `__filename`, `clearImmediate`, `clearInterval`, `clearTimeout`, `console`, `exports`, `global`, `module`, `process`, `queueMicrotask`, `require`, `setImmediate`, `setInterval`, `setTimeout` + * Global values: `Buffer`, `__dirname`, `__filename`, `clearImmediate`, `clearInterval`, `clearTimeout`, `console`, `exports`, `global`, `module`, `process`, `queueMicrotask`, `require`, `setImmediate`, `setInterval`, `setTimeout` # Credits -These definitions were written by Microsoft TypeScript (https://github.com/Microsoft), DefinitelyTyped (https://github.com/DefinitelyTyped), Alberto Schiabel (https://github.com/jkomyno), Alexander T. (https://github.com/a-tarasyuk), Alvis HT Tang (https://github.com/alvis), Andrew Makarov (https://github.com/r3nya), Benjamin Toueg (https://github.com/btoueg), Bruno Scheufler (https://github.com/brunoscheufler), Chigozirim C. (https://github.com/smac89), Christian Vaagland Tellnes (https://github.com/tellnes), David Junger (https://github.com/touffy), Deividas Bakanas (https://github.com/DeividasBakanas), Eugene Y. Q. Shen (https://github.com/eyqs), Flarna (https://github.com/Flarna), Hannes Magnusson (https://github.com/Hannes-Magnusson-CK), Hoàng Văn Khải (https://github.com/KSXGitHub), Huw (https://github.com/hoo29), Kelvin Jin (https://github.com/kjin), Klaus Meinhardt (https://github.com/ajafff), Lishude (https://github.com/islishude), Mariusz Wiktorczyk (https://github.com/mwiktorczyk), Mohsen Azimi (https://github.com/mohsen1), Nicolas Even (https://github.com/n-e), Nicolas Voigt (https://github.com/octo-sniffle), Nikita Galkin (https://github.com/galkin), Parambir Singh (https://github.com/parambirs), Sebastian Silbermann (https://github.com/eps1lon), Simon Schick (https://github.com/SimonSchick), Thomas den Hollander (https://github.com/ThomasdenH), Wilco Bakker (https://github.com/WilcoBakker), wwwy3y3 (https://github.com/wwwy3y3), Zane Hannan AU (https://github.com/ZaneHannanAU), Samuel Ainsworth (https://github.com/samuela), Kyle Uehlein (https://github.com/kuehlein), Jordi Oliveras Rovira (https://github.com/j-oliveras), Thanik Bhongbhibhat (https://github.com/bhongy), Marcin Kopacz (https://github.com/chyzwar), Trivikram Kamat (https://github.com/trivikr), Minh Son Nguyen (https://github.com/nguymin4), and Junxiao Shi (https://github.com/yoursunny). +These definitions were written by [Microsoft TypeScript](https://github.com/Microsoft), [DefinitelyTyped](https://github.com/DefinitelyTyped), [Alberto Schiabel](https://github.com/jkomyno), [Alexander T.](https://github.com/a-tarasyuk), [Alvis HT Tang](https://github.com/alvis), [Andrew Makarov](https://github.com/r3nya), [Benjamin Toueg](https://github.com/btoueg), [Bruno Scheufler](https://github.com/brunoscheufler), [Chigozirim C.](https://github.com/smac89), [David Junger](https://github.com/touffy), [Deividas Bakanas](https://github.com/DeividasBakanas), [Eugene Y. Q. Shen](https://github.com/eyqs), [Flarna](https://github.com/Flarna), [Hannes Magnusson](https://github.com/Hannes-Magnusson-CK), [Hoàng Văn Khải](https://github.com/KSXGitHub), [Huw](https://github.com/hoo29), [Kelvin Jin](https://github.com/kjin), [Klaus Meinhardt](https://github.com/ajafff), [Lishude](https://github.com/islishude), [Mariusz Wiktorczyk](https://github.com/mwiktorczyk), [Mohsen Azimi](https://github.com/mohsen1), [Nicolas Even](https://github.com/n-e), [Nikita Galkin](https://github.com/galkin), [Parambir Singh](https://github.com/parambirs), [Sebastian Silbermann](https://github.com/eps1lon), [Simon Schick](https://github.com/SimonSchick), [Thomas den Hollander](https://github.com/ThomasdenH), [Wilco Bakker](https://github.com/WilcoBakker), [wwwy3y3](https://github.com/wwwy3y3), [Samuel Ainsworth](https://github.com/samuela), [Kyle Uehlein](https://github.com/kuehlein), [Jordi Oliveras Rovira](https://github.com/j-oliveras), [Thanik Bhongbhibhat](https://github.com/bhongy), [Marcin Kopacz](https://github.com/chyzwar), [Trivikram Kamat](https://github.com/trivikr), [Minh Son Nguyen](https://github.com/nguymin4), [Junxiao Shi](https://github.com/yoursunny), [Ilia Baryshnikov](https://github.com/qwelias), [ExE Boss](https://github.com/ExE-Boss), [Surasak Chaisurin](https://github.com/Ryan-Willpower), [Piotr Błażejewicz](https://github.com/peterblazejewicz), [Anna Henningsen](https://github.com/addaleax), [Jason Kwok](https://github.com/JasonHK), [Victor Perin](https://github.com/victorperin), and [Yongsheng Zhang](https://github.com/ZYSzys). diff --git a/node_modules/@types/node/assert.d.ts b/node_modules/@types/node/assert.d.ts index 1244813..e9e3585 100644 --- a/node_modules/@types/node/assert.d.ts +++ b/node_modules/@types/node/assert.d.ts @@ -1,9 +1,8 @@ -declare module "assert" { - function internal(value: any, message?: string | Error): void; - namespace internal { - class AssertionError implements Error { - name: string; - message: string; +declare module 'assert' { + /** An alias of `assert.ok()`. */ + function assert(value: any, message?: string | Error): asserts value; + namespace assert { + class AssertionError extends Error { actual: any; expected: any; operator: string; @@ -11,38 +10,115 @@ declare module "assert" { code: 'ERR_ASSERTION'; constructor(options?: { - message?: string; actual?: any; expected?: any; - operator?: string; stackStartFn?: Function + /** If provided, the error message is set to this value. */ + message?: string; + /** The `actual` property on the error instance. */ + actual?: any; + /** The `expected` property on the error instance. */ + expected?: any; + /** The `operator` property on the error instance. */ + operator?: string; + /** If provided, the generated stack trace omits frames before this function. */ + // tslint:disable-next-line:ban-types + stackStartFn?: Function; }); } + class CallTracker { + calls(exact?: number): () => void; + calls any>(fn?: Func, exact?: number): Func; + report(): CallTrackerReportInformation[]; + verify(): void; + } + interface CallTrackerReportInformation { + message: string; + /** The actual number of times the function was called. */ + actual: number; + /** The number of times the function was expected to be called. */ + expected: number; + /** The name of the function that is wrapped. */ + operator: string; + /** A stack trace of the function. */ + stack: object; + } + + type AssertPredicate = RegExp | (new () => object) | ((thrown: any) => boolean) | object | Error; + function fail(message?: string | Error): never; /** @deprecated since v10.0.0 - use fail([message]) or other assert functions instead. */ - function fail(actual: any, expected: any, message?: string | Error, operator?: string, stackStartFn?: Function): never; - function ok(value: any, message?: string | Error): void; + function fail( + actual: any, + expected: any, + message?: string | Error, + operator?: string, + // tslint:disable-next-line:ban-types + stackStartFn?: Function, + ): never; + function ok(value: any, message?: string | Error): asserts value; + /** @deprecated since v9.9.0 - use strictEqual() instead. */ function equal(actual: any, expected: any, message?: string | Error): void; + /** @deprecated since v9.9.0 - use notStrictEqual() instead. */ function notEqual(actual: any, expected: any, message?: string | Error): void; + /** @deprecated since v9.9.0 - use deepStrictEqual() instead. */ function deepEqual(actual: any, expected: any, message?: string | Error): void; + /** @deprecated since v9.9.0 - use notDeepStrictEqual() instead. */ function notDeepEqual(actual: any, expected: any, message?: string | Error): void; - function strictEqual(actual: any, expected: any, message?: string | Error): void; + function strictEqual(actual: any, expected: T, message?: string | Error): asserts actual is T; function notStrictEqual(actual: any, expected: any, message?: string | Error): void; - function deepStrictEqual(actual: any, expected: any, message?: string | Error): void; + function deepStrictEqual(actual: any, expected: T, message?: string | Error): asserts actual is T; function notDeepStrictEqual(actual: any, expected: any, message?: string | Error): void; function throws(block: () => any, message?: string | Error): void; - function throws(block: () => any, error: RegExp | Function | Object | Error, message?: string | Error): void; + function throws(block: () => any, error: AssertPredicate, message?: string | Error): void; function doesNotThrow(block: () => any, message?: string | Error): void; - function doesNotThrow(block: () => any, error: RegExp | Function, message?: string | Error): void; + function doesNotThrow(block: () => any, error: AssertPredicate, message?: string | Error): void; - function ifError(value: any): void; + function ifError(value: any): asserts value is null | undefined; function rejects(block: (() => Promise) | Promise, message?: string | Error): Promise; - function rejects(block: (() => Promise) | Promise, error: RegExp | Function | Object | Error, message?: string | Error): Promise; + function rejects( + block: (() => Promise) | Promise, + error: AssertPredicate, + message?: string | Error, + ): Promise; function doesNotReject(block: (() => Promise) | Promise, message?: string | Error): Promise; - function doesNotReject(block: (() => Promise) | Promise, error: RegExp | Function, message?: string | Error): Promise; + function doesNotReject( + block: (() => Promise) | Promise, + error: AssertPredicate, + message?: string | Error, + ): Promise; - const strict: typeof internal; + function match(value: string, regExp: RegExp, message?: string | Error): void; + function doesNotMatch(value: string, regExp: RegExp, message?: string | Error): void; + + const strict: Omit< + typeof assert, + | 'equal' + | 'notEqual' + | 'deepEqual' + | 'notDeepEqual' + | 'ok' + | 'strictEqual' + | 'deepStrictEqual' + | 'ifError' + | 'strict' + > & { + (value: any, message?: string | Error): asserts value; + equal: typeof strictEqual; + notEqual: typeof notStrictEqual; + deepEqual: typeof deepStrictEqual; + notDeepEqual: typeof notDeepStrictEqual; + + // Mapped types and assertion functions are incompatible? + // TS2775: Assertions require every name in the call target + // to be declared with an explicit type annotation. + ok: typeof ok; + strictEqual: typeof strictEqual; + deepStrictEqual: typeof deepStrictEqual; + ifError: typeof ifError; + strict: typeof strict; + }; } - export = internal; + export = assert; } diff --git a/node_modules/@types/node/async_hooks.d.ts b/node_modules/@types/node/async_hooks.d.ts index cca992e..ab35e5d 100644 --- a/node_modules/@types/node/async_hooks.d.ts +++ b/node_modules/@types/node/async_hooks.d.ts @@ -7,6 +7,20 @@ declare module "async_hooks" { */ function executionAsyncId(): number; + /** + * The resource representing the current execution. + * Useful to store data within the resource. + * + * Resource objects returned by `executionAsyncResource()` are most often internal + * Node.js handle objects with undocumented APIs. Using any functions or properties + * on the object is likely to crash your application and should be avoided. + * + * Using `executionAsyncResource()` in the top-level execution context will + * return an empty object as there is no handle or request object to use, + * but having an object representing the top-level can be helpful. + */ + function executionAsyncResource(): object; + /** * Returns the ID of the resource responsible for calling the callback that is currently being executed. */ @@ -20,7 +34,7 @@ declare module "async_hooks" { * @param triggerAsyncId the unique ID of the async resource in whose execution context this async resource was created * @param resource reference to the resource representing the async operation, needs to be released during destroy */ - init?(asyncId: number, type: string, triggerAsyncId: number, resource: Object): void; + init?(asyncId: number, type: string, triggerAsyncId: number, resource: object): void; /** * When an asynchronous operation is initiated or completes a callback is called to notify the user. @@ -101,6 +115,19 @@ declare module "async_hooks" { */ constructor(type: string, triggerAsyncId?: number|AsyncResourceOptions); + /** + * Binds the given function to the current execution context. + * @param fn The function to bind to the current execution context. + * @param type An optional name to associate with the underlying `AsyncResource`. + */ + static bind any>(fn: Func, type?: string): Func & { asyncResource: AsyncResource }; + + /** + * Binds the given function to execute to this `AsyncResource`'s scope. + * @param fn The function to bind to the current `AsyncResource`. + */ + bind any>(fn: Func): Func & { asyncResource: AsyncResource }; + /** * Call the provided function with the provided arguments in the * execution context of the async resource. This will establish the @@ -129,4 +156,71 @@ declare module "async_hooks" { */ triggerAsyncId(): number; } + + /** + * When having multiple instances of `AsyncLocalStorage`, they are independent + * from each other. It is safe to instantiate this class multiple times. + */ + class AsyncLocalStorage { + /** + * This method disables the instance of `AsyncLocalStorage`. All subsequent calls + * to `asyncLocalStorage.getStore()` will return `undefined` until + * `asyncLocalStorage.run()` is called again. + * + * When calling `asyncLocalStorage.disable()`, all current contexts linked to the + * instance will be exited. + * + * Calling `asyncLocalStorage.disable()` is required before the + * `asyncLocalStorage` can be garbage collected. This does not apply to stores + * provided by the `asyncLocalStorage`, as those objects are garbage collected + * along with the corresponding async resources. + * + * This method is to be used when the `asyncLocalStorage` is not in use anymore + * in the current process. + */ + disable(): void; + + /** + * This method returns the current store. If this method is called outside of an + * asynchronous context initialized by calling `asyncLocalStorage.run`, it will + * return `undefined`. + */ + getStore(): T | undefined; + + /** + * This methods runs a function synchronously within a context and return its + * return value. The store is not accessible outside of the callback function or + * the asynchronous operations created within the callback. + * + * Optionally, arguments can be passed to the function. They will be passed to the + * callback function. + * + * I the callback function throws an error, it will be thrown by `run` too. The + * stacktrace will not be impacted by this call and the context will be exited. + */ + // TODO: Apply generic vararg once available + run(store: T, callback: (...args: any[]) => R, ...args: any[]): R; + + /** + * This methods runs a function synchronously outside of a context and return its + * return value. The store is not accessible within the callback function or the + * asynchronous operations created within the callback. + * + * Optionally, arguments can be passed to the function. They will be passed to the + * callback function. + * + * If the callback function throws an error, it will be thrown by `exit` too. The + * stacktrace will not be impacted by this call and the context will be + * re-entered. + */ + // TODO: Apply generic vararg once available + exit(callback: (...args: any[]) => R, ...args: any[]): R; + + /** + * Calling `asyncLocalStorage.enterWith(store)` will transition into the context + * for the remainder of the current synchronous execution and will persist + * through any following asynchronous calls. + */ + enterWith(store: T): void; + } } diff --git a/node_modules/@types/node/base.d.ts b/node_modules/@types/node/base.d.ts index 70983d9..fa67179 100644 --- a/node_modules/@types/node/base.d.ts +++ b/node_modules/@types/node/base.d.ts @@ -1,41 +1,19 @@ -// base definnitions for all NodeJS modules that are not specific to any version of TypeScript -/// +// NOTE: These definitions support NodeJS and TypeScript 3.7. + +// NOTE: TypeScript version-specific augmentations can be found in the following paths: +// - ~/base.d.ts - Shared definitions common to all TypeScript versions +// - ~/index.d.ts - Definitions specific to TypeScript 2.1 +// - ~/ts3.7/base.d.ts - Definitions specific to TypeScript 3.7 +// - ~/ts3.7/index.d.ts - Definitions specific to TypeScript 3.7 with assert pulled in + +// Reference required types from the default lib: +/// +/// +/// +/// + +// Base definitions for all NodeJS modules that are not specific to any version of TypeScript: +/// + +// TypeScript 3.7-specific augmentations: /// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// diff --git a/node_modules/@types/node/buffer.d.ts b/node_modules/@types/node/buffer.d.ts index 7eb1061..76c92cf 100644 --- a/node_modules/@types/node/buffer.d.ts +++ b/node_modules/@types/node/buffer.d.ts @@ -13,7 +13,7 @@ declare module "buffer" { export function transcode(source: Uint8Array, fromEnc: TranscodeEncoding, toEnc: TranscodeEncoding): Buffer; export const SlowBuffer: { - /** @deprecated since v6.0.0, use Buffer.allocUnsafeSlow() */ + /** @deprecated since v6.0.0, use `Buffer.allocUnsafeSlow()` */ new(size: number): Buffer; prototype: Buffer; }; diff --git a/node_modules/@types/node/child_process.d.ts b/node_modules/@types/node/child_process.d.ts index c220e19..9b6e094 100644 --- a/node_modules/@types/node/child_process.d.ts +++ b/node_modules/@types/node/child_process.d.ts @@ -1,8 +1,12 @@ declare module "child_process" { + import { BaseEncodingOptions } from 'fs'; import * as events from "events"; import * as net from "net"; import { Writable, Readable, Stream, Pipe } from "stream"; + type Serializable = string | object | number | boolean; + type SendHandle = net.Socket | net.Server; + interface ChildProcess extends events.EventEmitter { stdin: Writable | null; stdout: Readable | null; @@ -18,10 +22,14 @@ declare module "child_process" { readonly killed: boolean; readonly pid: number; readonly connected: boolean; - kill(signal?: string): void; - send(message: any, callback?: (error: Error | null) => void): boolean; - send(message: any, sendHandle?: net.Socket | net.Server, callback?: (error: Error | null) => void): boolean; - send(message: any, sendHandle?: net.Socket | net.Server, options?: MessageOptions, callback?: (error: Error | null) => void): boolean; + readonly exitCode: number | null; + readonly signalCode: NodeJS.Signals | null; + readonly spawnargs: string[]; + readonly spawnfile: string; + kill(signal?: NodeJS.Signals | number): boolean; + send(message: Serializable, callback?: (error: Error | null) => void): boolean; + send(message: Serializable, sendHandle?: SendHandle, callback?: (error: Error | null) => void): boolean; + send(message: Serializable, sendHandle?: SendHandle, options?: MessageOptions, callback?: (error: Error | null) => void): boolean; disconnect(): void; unref(): void; ref(): void; @@ -36,46 +44,46 @@ declare module "child_process" { */ addListener(event: string, listener: (...args: any[]) => void): this; - addListener(event: "close", listener: (code: number, signal: string) => void): this; + addListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; addListener(event: "disconnect", listener: () => void): this; addListener(event: "error", listener: (err: Error) => void): this; - addListener(event: "exit", listener: (code: number | null, signal: string | null) => void): this; - addListener(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this; + addListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + addListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; emit(event: string | symbol, ...args: any[]): boolean; - emit(event: "close", code: number, signal: string): boolean; + emit(event: "close", code: number | null, signal: NodeJS.Signals | null): boolean; emit(event: "disconnect"): boolean; emit(event: "error", err: Error): boolean; - emit(event: "exit", code: number | null, signal: string | null): boolean; - emit(event: "message", message: any, sendHandle: net.Socket | net.Server): boolean; + emit(event: "exit", code: number | null, signal: NodeJS.Signals | null): boolean; + emit(event: "message", message: Serializable, sendHandle: SendHandle): boolean; on(event: string, listener: (...args: any[]) => void): this; - on(event: "close", listener: (code: number, signal: string) => void): this; + on(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; on(event: "disconnect", listener: () => void): this; on(event: "error", listener: (err: Error) => void): this; - on(event: "exit", listener: (code: number | null, signal: string | null) => void): this; - on(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this; + on(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + on(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; once(event: string, listener: (...args: any[]) => void): this; - once(event: "close", listener: (code: number, signal: string) => void): this; + once(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; once(event: "disconnect", listener: () => void): this; once(event: "error", listener: (err: Error) => void): this; - once(event: "exit", listener: (code: number | null, signal: string | null) => void): this; - once(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this; + once(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + once(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; prependListener(event: string, listener: (...args: any[]) => void): this; - prependListener(event: "close", listener: (code: number, signal: string) => void): this; + prependListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; prependListener(event: "disconnect", listener: () => void): this; prependListener(event: "error", listener: (err: Error) => void): this; - prependListener(event: "exit", listener: (code: number | null, signal: string | null) => void): this; - prependListener(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this; + prependListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + prependListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; prependOnceListener(event: string, listener: (...args: any[]) => void): this; - prependOnceListener(event: "close", listener: (code: number, signal: string) => void): this; + prependOnceListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; prependOnceListener(event: "disconnect", listener: () => void): this; prependOnceListener(event: "error", listener: (err: Error) => void): this; - prependOnceListener(event: "exit", listener: (code: number | null, signal: string | null) => void): this; - prependOnceListener(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this; + prependOnceListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + prependOnceListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; } // return this object when stdio option is undefined or not specified @@ -116,6 +124,16 @@ declare module "child_process" { type StdioOptions = "pipe" | "ignore" | "inherit" | Array<("pipe" | "ipc" | "ignore" | "inherit" | Stream | number | null | undefined)>; + type SerializationType = 'json' | 'advanced'; + + interface MessagingOptions { + /** + * Specify the kind of serialization used for sending messages between processes. + * @default 'json' + */ + serialization?: SerializationType; + } + interface ProcessEnvOptions { uid?: number; gid?: number; @@ -134,14 +152,17 @@ declare module "child_process" { timeout?: number; } - interface SpawnOptions extends CommonOptions { + interface CommonSpawnOptions extends CommonOptions, MessagingOptions { argv0?: string; stdio?: StdioOptions; - detached?: boolean; shell?: boolean | string; windowsVerbatimArguments?: boolean; } + interface SpawnOptions extends CommonSpawnOptions { + detached?: boolean; + } + interface SpawnOptionsWithoutStdio extends SpawnOptions { stdio?: 'pipe' | Array; } @@ -244,7 +265,7 @@ declare module "child_process" { interface ExecOptions extends CommonOptions { shell?: string; maxBuffer?: number; - killSignal?: string; + killSignal?: NodeJS.Signals | number; } interface ExecOptionsWithStringEncoding extends ExecOptions { @@ -252,14 +273,14 @@ declare module "child_process" { } interface ExecOptionsWithBufferEncoding extends ExecOptions { - encoding: string | null; // specify `null`. + encoding: BufferEncoding | null; // specify `null`. } interface ExecException extends Error { cmd?: string; killed?: boolean; code?: number; - signal?: string; + signal?: NodeJS.Signals; } // no `options` definitely means stdout/stderr are `string`. @@ -273,7 +294,11 @@ declare module "child_process" { // `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`. // There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`. - function exec(command: string, options: { encoding: string } & ExecOptions, callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void): ChildProcess; + function exec( + command: string, + options: { encoding: BufferEncoding } & ExecOptions, + callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, + ): ChildProcess; // `options` without an `encoding` means stdout/stderr are definitely `string`. function exec(command: string, options: ExecOptions, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; @@ -281,7 +306,7 @@ declare module "child_process" { // fallback if nothing else matches. Worst case is always `string | Buffer`. function exec( command: string, - options: ({ encoding?: string | null } & ExecOptions) | undefined | null, + options: (BaseEncodingOptions & ExecOptions) | undefined | null, callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, ): ChildProcess; @@ -295,12 +320,12 @@ declare module "child_process" { function __promisify__(command: string, options: { encoding: "buffer" | null } & ExecOptions): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>; function __promisify__(command: string, options: { encoding: BufferEncoding } & ExecOptions): PromiseWithChild<{ stdout: string, stderr: string }>; function __promisify__(command: string, options: ExecOptions): PromiseWithChild<{ stdout: string, stderr: string }>; - function __promisify__(command: string, options?: ({ encoding?: string | null } & ExecOptions) | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; + function __promisify__(command: string, options?: (BaseEncodingOptions & ExecOptions) | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; } interface ExecFileOptions extends CommonOptions { maxBuffer?: number; - killSignal?: string; + killSignal?: NodeJS.Signals | number; windowsVerbatimArguments?: boolean; shell?: boolean | string; } @@ -311,34 +336,34 @@ declare module "child_process" { encoding: 'buffer' | null; } interface ExecFileOptionsWithOtherEncoding extends ExecFileOptions { - encoding: string; + encoding: BufferEncoding; } function execFile(file: string): ChildProcess; - function execFile(file: string, options: ({ encoding?: string | null } & ExecFileOptions) | undefined | null): ChildProcess; + function execFile(file: string, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess; function execFile(file: string, args?: ReadonlyArray | null): ChildProcess; - function execFile(file: string, args: ReadonlyArray | undefined | null, options: ({ encoding?: string | null } & ExecFileOptions) | undefined | null): ChildProcess; + function execFile(file: string, args: ReadonlyArray | undefined | null, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess; // no `options` definitely means stdout/stderr are `string`. - function execFile(file: string, callback: (error: Error | null, stdout: string, stderr: string) => void): ChildProcess; - function execFile(file: string, args: ReadonlyArray | undefined | null, callback: (error: Error | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile(file: string, callback: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile(file: string, args: ReadonlyArray | undefined | null, callback: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; // `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`. - function execFile(file: string, options: ExecFileOptionsWithBufferEncoding, callback: (error: Error | null, stdout: Buffer, stderr: Buffer) => void): ChildProcess; + function execFile(file: string, options: ExecFileOptionsWithBufferEncoding, callback: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void): ChildProcess; function execFile( file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptionsWithBufferEncoding, - callback: (error: Error | null, stdout: Buffer, stderr: Buffer) => void, + callback: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void, ): ChildProcess; // `options` with well known `encoding` means stdout/stderr are definitely `string`. - function execFile(file: string, options: ExecFileOptionsWithStringEncoding, callback: (error: Error | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile(file: string, options: ExecFileOptionsWithStringEncoding, callback: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; function execFile( file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptionsWithStringEncoding, - callback: (error: Error | null, stdout: string, stderr: string) => void, + callback: (error: ExecException | null, stdout: string, stderr: string) => void, ): ChildProcess; // `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`. @@ -346,53 +371,62 @@ declare module "child_process" { function execFile( file: string, options: ExecFileOptionsWithOtherEncoding, - callback: (error: Error | null, stdout: string | Buffer, stderr: string | Buffer) => void, + callback: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, ): ChildProcess; function execFile( file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptionsWithOtherEncoding, - callback: (error: Error | null, stdout: string | Buffer, stderr: string | Buffer) => void, + callback: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, ): ChildProcess; // `options` without an `encoding` means stdout/stderr are definitely `string`. - function execFile(file: string, options: ExecFileOptions, callback: (error: Error | null, stdout: string, stderr: string) => void): ChildProcess; - function execFile(file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptions, callback: (error: Error | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile(file: string, options: ExecFileOptions, callback: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile( + file: string, + args: ReadonlyArray | undefined | null, + options: ExecFileOptions, + callback: (error: ExecException | null, stdout: string, stderr: string) => void + ): ChildProcess; // fallback if nothing else matches. Worst case is always `string | Buffer`. function execFile( file: string, - options: ({ encoding?: string | null } & ExecFileOptions) | undefined | null, - callback: ((error: Error | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null, + options: (BaseEncodingOptions & ExecFileOptions) | undefined | null, + callback: ((error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null, ): ChildProcess; function execFile( file: string, args: ReadonlyArray | undefined | null, - options: ({ encoding?: string | null } & ExecFileOptions) | undefined | null, - callback: ((error: Error | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null, + options: (BaseEncodingOptions & ExecFileOptions) | undefined | null, + callback: ((error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null, ): ChildProcess; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. namespace execFile { function __promisify__(file: string): PromiseWithChild<{ stdout: string, stderr: string }>; - function __promisify__(file: string, args: string[] | undefined | null): PromiseWithChild<{ stdout: string, stderr: string }>; + function __promisify__(file: string, args: ReadonlyArray | undefined | null): PromiseWithChild<{ stdout: string, stderr: string }>; function __promisify__(file: string, options: ExecFileOptionsWithBufferEncoding): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>; - function __promisify__(file: string, args: string[] | undefined | null, options: ExecFileOptionsWithBufferEncoding): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>; + function __promisify__(file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptionsWithBufferEncoding): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>; function __promisify__(file: string, options: ExecFileOptionsWithStringEncoding): PromiseWithChild<{ stdout: string, stderr: string }>; - function __promisify__(file: string, args: string[] | undefined | null, options: ExecFileOptionsWithStringEncoding): PromiseWithChild<{ stdout: string, stderr: string }>; + function __promisify__(file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptionsWithStringEncoding): PromiseWithChild<{ stdout: string, stderr: string }>; function __promisify__(file: string, options: ExecFileOptionsWithOtherEncoding): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; - function __promisify__(file: string, args: string[] | undefined | null, options: ExecFileOptionsWithOtherEncoding): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; - function __promisify__(file: string, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>; - function __promisify__(file: string, args: string[] | undefined | null, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>; - function __promisify__(file: string, options: ({ encoding?: string | null } & ExecFileOptions) | undefined | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; function __promisify__( file: string, - args: string[] | undefined | null, - options: ({ encoding?: string | null } & ExecFileOptions) | undefined | null, + args: ReadonlyArray | undefined | null, + options: ExecFileOptionsWithOtherEncoding, + ): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; + function __promisify__(file: string, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>; + function __promisify__(file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>; + function __promisify__(file: string, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; + function __promisify__( + file: string, + args: ReadonlyArray | undefined | null, + options: (BaseEncodingOptions & ExecFileOptions) | undefined | null, ): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; } - interface ForkOptions extends ProcessEnvOptions { + interface ForkOptions extends ProcessEnvOptions, MessagingOptions { execPath?: string; execArgv?: string[]; silent?: boolean; @@ -400,23 +434,20 @@ declare module "child_process" { detached?: boolean; windowsVerbatimArguments?: boolean; } + function fork(modulePath: string, options?: ForkOptions): ChildProcess; function fork(modulePath: string, args?: ReadonlyArray, options?: ForkOptions): ChildProcess; - interface SpawnSyncOptions extends CommonOptions { - argv0?: string; // Not specified in the docs + interface SpawnSyncOptions extends CommonSpawnOptions { input?: string | NodeJS.ArrayBufferView; - stdio?: StdioOptions; - killSignal?: string | number; + killSignal?: NodeJS.Signals | number; maxBuffer?: number; - encoding?: string; - shell?: boolean | string; - windowsVerbatimArguments?: boolean; + encoding?: BufferEncoding | 'buffer' | null; } interface SpawnSyncOptionsWithStringEncoding extends SpawnSyncOptions { encoding: BufferEncoding; } interface SpawnSyncOptionsWithBufferEncoding extends SpawnSyncOptions { - encoding: string; // specify `null`. + encoding?: 'buffer' | null; } interface SpawnSyncReturns { pid: number; @@ -424,7 +455,7 @@ declare module "child_process" { stdout: T; stderr: T; status: number | null; - signal: string | null; + signal: NodeJS.Signals | null; error?: Error; } function spawnSync(command: string): SpawnSyncReturns; @@ -439,15 +470,15 @@ declare module "child_process" { input?: string | Uint8Array; stdio?: StdioOptions; shell?: string; - killSignal?: string | number; + killSignal?: NodeJS.Signals | number; maxBuffer?: number; - encoding?: string; + encoding?: BufferEncoding | 'buffer' | null; } interface ExecSyncOptionsWithStringEncoding extends ExecSyncOptions { encoding: BufferEncoding; } interface ExecSyncOptionsWithBufferEncoding extends ExecSyncOptions { - encoding: string; // specify `null`. + encoding?: 'buffer' | null; } function execSync(command: string): Buffer; function execSync(command: string, options?: ExecSyncOptionsWithStringEncoding): string; @@ -457,16 +488,16 @@ declare module "child_process" { interface ExecFileSyncOptions extends CommonOptions { input?: string | NodeJS.ArrayBufferView; stdio?: StdioOptions; - killSignal?: string | number; + killSignal?: NodeJS.Signals | number; maxBuffer?: number; - encoding?: string; + encoding?: BufferEncoding; shell?: boolean | string; } interface ExecFileSyncOptionsWithStringEncoding extends ExecFileSyncOptions { encoding: BufferEncoding; } interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions { - encoding: string; // specify `null`. + encoding: BufferEncoding; // specify `null`. } function execFileSync(command: string): Buffer; function execFileSync(command: string, options?: ExecFileSyncOptionsWithStringEncoding): string; diff --git a/node_modules/@types/node/cluster.d.ts b/node_modules/@types/node/cluster.d.ts index 43340ff..0ef6c2a 100644 --- a/node_modules/@types/node/cluster.d.ts +++ b/node_modules/@types/node/cluster.d.ts @@ -24,7 +24,7 @@ declare module "cluster" { class Worker extends events.EventEmitter { id: number; process: child.ChildProcess; - send(message: any, sendHandle?: any, callback?: (error: Error | null) => void): boolean; + send(message: child.Serializable, sendHandle?: child.SendHandle, callback?: (error: Error | null) => void): boolean; kill(signal?: string): void; destroy(signal?: string): void; disconnect(): void; @@ -96,13 +96,14 @@ declare module "cluster" { fork(env?: any): Worker; isMaster: boolean; isWorker: boolean; - // TODO: cluster.schedulingPolicy + schedulingPolicy: number; settings: ClusterSettings; setupMaster(settings?: ClusterSettings): void; worker?: Worker; - workers?: { - [index: string]: Worker | undefined - }; + workers?: NodeJS.Dict; + + readonly SCHED_NONE: number; + readonly SCHED_RR: number; /** * events.EventEmitter @@ -170,17 +171,18 @@ declare module "cluster" { prependOnceListener(event: "setup", listener: (settings: ClusterSettings) => void): this; } + const SCHED_NONE: number; + const SCHED_RR: number; + function disconnect(callback?: () => void): void; function fork(env?: any): Worker; const isMaster: boolean; const isWorker: boolean; - // TODO: cluster.schedulingPolicy + let schedulingPolicy: number; const settings: ClusterSettings; function setupMaster(settings?: ClusterSettings): void; const worker: Worker; - const workers: { - [index: string]: Worker | undefined - }; + const workers: NodeJS.Dict; /** * events.EventEmitter diff --git a/node_modules/@types/node/console.d.ts b/node_modules/@types/node/console.d.ts index d30d13f..178beb4 100644 --- a/node_modules/@types/node/console.d.ts +++ b/node_modules/@types/node/console.d.ts @@ -1,3 +1,133 @@ declare module "console" { + import { InspectOptions } from 'util'; + + global { + // This needs to be global to avoid TS2403 in case lib.dom.d.ts is present in the same build + interface Console { + Console: NodeJS.ConsoleConstructor; + /** + * A simple assertion test that verifies whether `value` is truthy. + * If it is not, an `AssertionError` is thrown. + * If provided, the error `message` is formatted using `util.format()` and used as the error message. + */ + assert(value: any, message?: string, ...optionalParams: any[]): void; + /** + * When `stdout` is a TTY, calling `console.clear()` will attempt to clear the TTY. + * When `stdout` is not a TTY, this method does nothing. + */ + clear(): void; + /** + * Maintains an internal counter specific to `label` and outputs to `stdout` the number of times `console.count()` has been called with the given `label`. + */ + count(label?: string): void; + /** + * Resets the internal counter specific to `label`. + */ + countReset(label?: string): void; + /** + * The `console.debug()` function is an alias for {@link console.log()}. + */ + debug(message?: any, ...optionalParams: any[]): void; + /** + * Uses {@link util.inspect()} on `obj` and prints the resulting string to `stdout`. + * This function bypasses any custom `inspect()` function defined on `obj`. + */ + dir(obj: any, options?: InspectOptions): void; + /** + * This method calls {@link console.log()} passing it the arguments received. Please note that this method does not produce any XML formatting + */ + dirxml(...data: any[]): void; + /** + * Prints to `stderr` with newline. + */ + error(message?: any, ...optionalParams: any[]): void; + /** + * Increases indentation of subsequent lines by two spaces. + * If one or more `label`s are provided, those are printed first without the additional indentation. + */ + group(...label: any[]): void; + /** + * The `console.groupCollapsed()` function is an alias for {@link console.group()}. + */ + groupCollapsed(...label: any[]): void; + /** + * Decreases indentation of subsequent lines by two spaces. + */ + groupEnd(): void; + /** + * The {@link console.info()} function is an alias for {@link console.log()}. + */ + info(message?: any, ...optionalParams: any[]): void; + /** + * Prints to `stdout` with newline. + */ + log(message?: any, ...optionalParams: any[]): void; + /** + * This method does not display anything unless used in the inspector. + * Prints to `stdout` the array `array` formatted as a table. + */ + table(tabularData: any, properties?: ReadonlyArray): void; + /** + * Starts a timer that can be used to compute the duration of an operation. Timers are identified by a unique `label`. + */ + time(label?: string): void; + /** + * Stops a timer that was previously started by calling {@link console.time()} and prints the result to `stdout`. + */ + timeEnd(label?: string): void; + /** + * For a timer that was previously started by calling {@link console.time()}, prints the elapsed time and other `data` arguments to `stdout`. + */ + timeLog(label?: string, ...data: any[]): void; + /** + * Prints to `stderr` the string 'Trace :', followed by the {@link util.format()} formatted message and stack trace to the current position in the code. + */ + trace(message?: any, ...optionalParams: any[]): void; + /** + * The {@link console.warn()} function is an alias for {@link console.error()}. + */ + warn(message?: any, ...optionalParams: any[]): void; + + // --- Inspector mode only --- + /** + * This method does not display anything unless used in the inspector. + * Starts a JavaScript CPU profile with an optional label. + */ + profile(label?: string): void; + /** + * This method does not display anything unless used in the inspector. + * Stops the current JavaScript CPU profiling session if one has been started and prints the report to the Profiles panel of the inspector. + */ + profileEnd(label?: string): void; + /** + * This method does not display anything unless used in the inspector. + * Adds an event with the label `label` to the Timeline panel of the inspector. + */ + timeStamp(label?: string): void; + } + + var console: Console; + + namespace NodeJS { + interface ConsoleConstructorOptions { + stdout: WritableStream; + stderr?: WritableStream; + ignoreErrors?: boolean; + colorMode?: boolean | 'auto'; + inspectOptions?: InspectOptions; + } + + interface ConsoleConstructor { + prototype: Console; + new(stdout: WritableStream, stderr?: WritableStream, ignoreErrors?: boolean): Console; + new(options: ConsoleConstructorOptions): Console; + } + + interface Global { + console: typeof console; + } + } + } + export = console; } diff --git a/node_modules/@types/node/constants.d.ts b/node_modules/@types/node/constants.d.ts index ebd463b..d124ae6 100644 --- a/node_modules/@types/node/constants.d.ts +++ b/node_modules/@types/node/constants.d.ts @@ -1,448 +1,8 @@ /** @deprecated since v6.3.0 - use constants property exposed by the relevant module instead. */ declare module "constants" { - /** @deprecated since v6.3.0 - use `os.constants.errno.E2BIG` instead. */ - const E2BIG: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EACCES` instead. */ - const EACCES: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EADDRINUSE` instead. */ - const EADDRINUSE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EADDRNOTAVAIL` instead. */ - const EADDRNOTAVAIL: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EAFNOSUPPORT` instead. */ - const EAFNOSUPPORT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EAGAIN` instead. */ - const EAGAIN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EALREADY` instead. */ - const EALREADY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EBADF` instead. */ - const EBADF: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EBADMSG` instead. */ - const EBADMSG: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EBUSY` instead. */ - const EBUSY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ECANCELED` instead. */ - const ECANCELED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ECHILD` instead. */ - const ECHILD: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ECONNABORTED` instead. */ - const ECONNABORTED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ECONNREFUSED` instead. */ - const ECONNREFUSED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ECONNRESET` instead. */ - const ECONNRESET: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EDEADLK` instead. */ - const EDEADLK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EDESTADDRREQ` instead. */ - const EDESTADDRREQ: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EDOM` instead. */ - const EDOM: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EEXIST` instead. */ - const EEXIST: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EFAULT` instead. */ - const EFAULT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EFBIG` instead. */ - const EFBIG: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EHOSTUNREACH` instead. */ - const EHOSTUNREACH: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EIDRM` instead. */ - const EIDRM: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EILSEQ` instead. */ - const EILSEQ: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EINPROGRESS` instead. */ - const EINPROGRESS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EINTR` instead. */ - const EINTR: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EINVAL` instead. */ - const EINVAL: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EIO` instead. */ - const EIO: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EISCONN` instead. */ - const EISCONN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EISDIR` instead. */ - const EISDIR: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ELOOP` instead. */ - const ELOOP: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EMFILE` instead. */ - const EMFILE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EMLINK` instead. */ - const EMLINK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EMSGSIZE` instead. */ - const EMSGSIZE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENAMETOOLONG` instead. */ - const ENAMETOOLONG: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENETDOWN` instead. */ - const ENETDOWN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENETRESET` instead. */ - const ENETRESET: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENETUNREACH` instead. */ - const ENETUNREACH: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENFILE` instead. */ - const ENFILE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOBUFS` instead. */ - const ENOBUFS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENODATA` instead. */ - const ENODATA: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENODEV` instead. */ - const ENODEV: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOENT` instead. */ - const ENOENT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOEXEC` instead. */ - const ENOEXEC: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOLCK` instead. */ - const ENOLCK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOLINK` instead. */ - const ENOLINK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOMEM` instead. */ - const ENOMEM: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOMSG` instead. */ - const ENOMSG: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOPROTOOPT` instead. */ - const ENOPROTOOPT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOSPC` instead. */ - const ENOSPC: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOSR` instead. */ - const ENOSR: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOSTR` instead. */ - const ENOSTR: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOSYS` instead. */ - const ENOSYS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOTCONN` instead. */ - const ENOTCONN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOTDIR` instead. */ - const ENOTDIR: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOTEMPTY` instead. */ - const ENOTEMPTY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOTSOCK` instead. */ - const ENOTSOCK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOTSUP` instead. */ - const ENOTSUP: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENOTTY` instead. */ - const ENOTTY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ENXIO` instead. */ - const ENXIO: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EOPNOTSUPP` instead. */ - const EOPNOTSUPP: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EOVERFLOW` instead. */ - const EOVERFLOW: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EPERM` instead. */ - const EPERM: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EPIPE` instead. */ - const EPIPE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EPROTO` instead. */ - const EPROTO: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EPROTONOSUPPORT` instead. */ - const EPROTONOSUPPORT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EPROTOTYPE` instead. */ - const EPROTOTYPE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ERANGE` instead. */ - const ERANGE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EROFS` instead. */ - const EROFS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ESPIPE` instead. */ - const ESPIPE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ESRCH` instead. */ - const ESRCH: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ETIME` instead. */ - const ETIME: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ETIMEDOUT` instead. */ - const ETIMEDOUT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.ETXTBSY` instead. */ - const ETXTBSY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EWOULDBLOCK` instead. */ - const EWOULDBLOCK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.EXDEV` instead. */ - const EXDEV: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEINTR` instead. */ - const WSAEINTR: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEBADF` instead. */ - const WSAEBADF: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEACCES` instead. */ - const WSAEACCES: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEFAULT` instead. */ - const WSAEFAULT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEINVAL` instead. */ - const WSAEINVAL: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEMFILE` instead. */ - const WSAEMFILE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEWOULDBLOCK` instead. */ - const WSAEWOULDBLOCK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEINPROGRESS` instead. */ - const WSAEINPROGRESS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEALREADY` instead. */ - const WSAEALREADY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENOTSOCK` instead. */ - const WSAENOTSOCK: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEDESTADDRREQ` instead. */ - const WSAEDESTADDRREQ: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEMSGSIZE` instead. */ - const WSAEMSGSIZE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEPROTOTYPE` instead. */ - const WSAEPROTOTYPE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENOPROTOOPT` instead. */ - const WSAENOPROTOOPT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEPROTONOSUPPORT` instead. */ - const WSAEPROTONOSUPPORT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAESOCKTNOSUPPORT` instead. */ - const WSAESOCKTNOSUPPORT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEOPNOTSUPP` instead. */ - const WSAEOPNOTSUPP: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEPFNOSUPPORT` instead. */ - const WSAEPFNOSUPPORT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEAFNOSUPPORT` instead. */ - const WSAEAFNOSUPPORT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEADDRINUSE` instead. */ - const WSAEADDRINUSE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEADDRNOTAVAIL` instead. */ - const WSAEADDRNOTAVAIL: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENETDOWN` instead. */ - const WSAENETDOWN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENETUNREACH` instead. */ - const WSAENETUNREACH: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENETRESET` instead. */ - const WSAENETRESET: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAECONNABORTED` instead. */ - const WSAECONNABORTED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAECONNRESET` instead. */ - const WSAECONNRESET: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENOBUFS` instead. */ - const WSAENOBUFS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEISCONN` instead. */ - const WSAEISCONN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENOTCONN` instead. */ - const WSAENOTCONN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAESHUTDOWN` instead. */ - const WSAESHUTDOWN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAETOOMANYREFS` instead. */ - const WSAETOOMANYREFS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAETIMEDOUT` instead. */ - const WSAETIMEDOUT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAECONNREFUSED` instead. */ - const WSAECONNREFUSED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAELOOP` instead. */ - const WSAELOOP: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENAMETOOLONG` instead. */ - const WSAENAMETOOLONG: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEHOSTDOWN` instead. */ - const WSAEHOSTDOWN: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEHOSTUNREACH` instead. */ - const WSAEHOSTUNREACH: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENOTEMPTY` instead. */ - const WSAENOTEMPTY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEPROCLIM` instead. */ - const WSAEPROCLIM: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEUSERS` instead. */ - const WSAEUSERS: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEDQUOT` instead. */ - const WSAEDQUOT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAESTALE` instead. */ - const WSAESTALE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEREMOTE` instead. */ - const WSAEREMOTE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSASYSNOTREADY` instead. */ - const WSASYSNOTREADY: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAVERNOTSUPPORTED` instead. */ - const WSAVERNOTSUPPORTED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSANOTINITIALISED` instead. */ - const WSANOTINITIALISED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEDISCON` instead. */ - const WSAEDISCON: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAENOMORE` instead. */ - const WSAENOMORE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAECANCELLED` instead. */ - const WSAECANCELLED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEINVALIDPROCTABLE` instead. */ - const WSAEINVALIDPROCTABLE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEINVALIDPROVIDER` instead. */ - const WSAEINVALIDPROVIDER: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEPROVIDERFAILEDINIT` instead. */ - const WSAEPROVIDERFAILEDINIT: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSASYSCALLFAILURE` instead. */ - const WSASYSCALLFAILURE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSASERVICE_NOT_FOUND` instead. */ - const WSASERVICE_NOT_FOUND: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSATYPE_NOT_FOUND` instead. */ - const WSATYPE_NOT_FOUND: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSA_E_NO_MORE` instead. */ - const WSA_E_NO_MORE: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSA_E_CANCELLED` instead. */ - const WSA_E_CANCELLED: number; - /** @deprecated since v6.3.0 - use `os.constants.errno.WSAEREFUSED` instead. */ - const WSAEREFUSED: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGHUP` instead. */ - const SIGHUP: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGINT` instead. */ - const SIGINT: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGILL` instead. */ - const SIGILL: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGABRT` instead. */ - const SIGABRT: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGFPE` instead. */ - const SIGFPE: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGKILL` instead. */ - const SIGKILL: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGSEGV` instead. */ - const SIGSEGV: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGTERM` instead. */ - const SIGTERM: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGBREAK` instead. */ - const SIGBREAK: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGWINCH` instead. */ - const SIGWINCH: number; - const SSL_OP_ALL: number; - const SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number; - const SSL_OP_CIPHER_SERVER_PREFERENCE: number; - const SSL_OP_CISCO_ANYCONNECT: number; - const SSL_OP_COOKIE_EXCHANGE: number; - const SSL_OP_CRYPTOPRO_TLSEXT_BUG: number; - const SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number; - const SSL_OP_EPHEMERAL_RSA: number; - const SSL_OP_LEGACY_SERVER_CONNECT: number; - const SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number; - const SSL_OP_MICROSOFT_SESS_ID_BUG: number; - const SSL_OP_MSIE_SSLV2_RSA_PADDING: number; - const SSL_OP_NETSCAPE_CA_DN_BUG: number; - const SSL_OP_NETSCAPE_CHALLENGE_BUG: number; - const SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number; - const SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number; - const SSL_OP_NO_COMPRESSION: number; - const SSL_OP_NO_QUERY_MTU: number; - const SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number; - const SSL_OP_NO_SSLv2: number; - const SSL_OP_NO_SSLv3: number; - const SSL_OP_NO_TICKET: number; - const SSL_OP_NO_TLSv1: number; - const SSL_OP_NO_TLSv1_1: number; - const SSL_OP_NO_TLSv1_2: number; - const SSL_OP_PKCS1_CHECK_1: number; - const SSL_OP_PKCS1_CHECK_2: number; - const SSL_OP_SINGLE_DH_USE: number; - const SSL_OP_SINGLE_ECDH_USE: number; - const SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number; - const SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number; - const SSL_OP_TLS_BLOCK_PADDING_BUG: number; - const SSL_OP_TLS_D5_BUG: number; - const SSL_OP_TLS_ROLLBACK_BUG: number; - const ENGINE_METHOD_DSA: number; - const ENGINE_METHOD_DH: number; - const ENGINE_METHOD_RAND: number; - const ENGINE_METHOD_ECDH: number; - const ENGINE_METHOD_ECDSA: number; - const ENGINE_METHOD_CIPHERS: number; - const ENGINE_METHOD_DIGESTS: number; - const ENGINE_METHOD_STORE: number; - const ENGINE_METHOD_PKEY_METHS: number; - const ENGINE_METHOD_PKEY_ASN1_METHS: number; - const ENGINE_METHOD_ALL: number; - const ENGINE_METHOD_NONE: number; - const DH_CHECK_P_NOT_SAFE_PRIME: number; - const DH_CHECK_P_NOT_PRIME: number; - const DH_UNABLE_TO_CHECK_GENERATOR: number; - const DH_NOT_SUITABLE_GENERATOR: number; - const RSA_PKCS1_PADDING: number; - const RSA_SSLV23_PADDING: number; - const RSA_NO_PADDING: number; - const RSA_PKCS1_OAEP_PADDING: number; - const RSA_X931_PADDING: number; - const RSA_PKCS1_PSS_PADDING: number; - const POINT_CONVERSION_COMPRESSED: number; - const POINT_CONVERSION_UNCOMPRESSED: number; - const POINT_CONVERSION_HYBRID: number; - const O_RDONLY: number; - const O_WRONLY: number; - const O_RDWR: number; - const S_IFMT: number; - const S_IFREG: number; - const S_IFDIR: number; - const S_IFCHR: number; - const S_IFBLK: number; - const S_IFIFO: number; - const S_IFSOCK: number; - const S_IRWXU: number; - const S_IRUSR: number; - const S_IWUSR: number; - const S_IXUSR: number; - const S_IRWXG: number; - const S_IRGRP: number; - const S_IWGRP: number; - const S_IXGRP: number; - const S_IRWXO: number; - const S_IROTH: number; - const S_IWOTH: number; - const S_IXOTH: number; - const S_IFLNK: number; - const O_CREAT: number; - const O_EXCL: number; - const O_NOCTTY: number; - const O_DIRECTORY: number; - const O_NOATIME: number; - const O_NOFOLLOW: number; - const O_SYNC: number; - const O_DSYNC: number; - const O_SYMLINK: number; - const O_DIRECT: number; - const O_NONBLOCK: number; - const O_TRUNC: number; - const O_APPEND: number; - const F_OK: number; - const R_OK: number; - const W_OK: number; - const X_OK: number; - const COPYFILE_EXCL: number; - const COPYFILE_FICLONE: number; - const COPYFILE_FICLONE_FORCE: number; - const UV_UDP_REUSEADDR: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGQUIT` instead. */ - const SIGQUIT: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGTRAP` instead. */ - const SIGTRAP: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGIOT` instead. */ - const SIGIOT: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGBUS` instead. */ - const SIGBUS: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGUSR1` instead. */ - const SIGUSR1: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGUSR2` instead. */ - const SIGUSR2: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGPIPE` instead. */ - const SIGPIPE: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGALRM` instead. */ - const SIGALRM: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGCHLD` instead. */ - const SIGCHLD: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGSTKFLT` instead. */ - const SIGSTKFLT: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGCONT` instead. */ - const SIGCONT: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGSTOP` instead. */ - const SIGSTOP: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGTSTP` instead. */ - const SIGTSTP: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGTTIN` instead. */ - const SIGTTIN: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGTTOU` instead. */ - const SIGTTOU: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGURG` instead. */ - const SIGURG: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGXCPU` instead. */ - const SIGXCPU: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGXFSZ` instead. */ - const SIGXFSZ: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGVTALRM` instead. */ - const SIGVTALRM: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGPROF` instead. */ - const SIGPROF: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGIO` instead. */ - const SIGIO: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGPOLL` instead. */ - const SIGPOLL: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGPWR` instead. */ - const SIGPWR: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGSYS` instead. */ - const SIGSYS: number; - /** @deprecated since v6.3.0 - use `os.constants.signals.SIGUNUSED` instead. */ - const SIGUNUSED: number; - const defaultCoreCipherList: string; - const defaultCipherList: string; - const ENGINE_METHOD_RSA: number; - const ALPN_ENABLED: number; + import { constants as osConstants, SignalConstants } from 'os'; + import { constants as cryptoConstants } from 'crypto'; + import { constants as fsConstants } from 'fs'; + const exp: typeof osConstants.errno & typeof osConstants.priority & SignalConstants & typeof cryptoConstants & typeof fsConstants; + export = exp; } diff --git a/node_modules/@types/node/crypto.d.ts b/node_modules/@types/node/crypto.d.ts index ee0dd7f..bf3c237 100644 --- a/node_modules/@types/node/crypto.d.ts +++ b/node_modules/@types/node/crypto.d.ts @@ -1,17 +1,36 @@ -declare module "crypto" { - import * as stream from "stream"; +declare module 'crypto' { + import * as stream from 'stream'; interface Certificate { + /** + * @param spkac + * @returns The challenge component of the `spkac` data structure, + * which includes a public key and a challenge. + */ exportChallenge(spkac: BinaryLike): Buffer; - exportPublicKey(spkac: BinaryLike): Buffer; + /** + * @param spkac + * @param encoding The encoding of the spkac string. + * @returns The public key component of the `spkac` data structure, + * which includes a public key and a challenge. + */ + exportPublicKey(spkac: BinaryLike, encoding?: string): Buffer; + /** + * @param spkac + * @returns `true` if the given `spkac` data structure is valid, + * `false` otherwise. + */ verifySpkac(spkac: NodeJS.ArrayBufferView): boolean; } - const Certificate: { - new(): Certificate; + const Certificate: Certificate & { + /** @deprecated since v14.9.0 - Use static methods of `crypto.Certificate` instead. */ + new (): Certificate; + /** @deprecated since v14.9.0 - Use static methods of `crypto.Certificate` instead. */ (): Certificate; }; - namespace constants { // https://nodejs.org/dist/latest-v10.x/docs/api/crypto.html#crypto_crypto_constants + namespace constants { + // https://nodejs.org/dist/latest-v10.x/docs/api/crypto.html#crypto_crypto_constants const OPENSSL_VERSION_NUMBER: number; /** Applies multiple bug workarounds within OpenSSL. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html for detail. */ @@ -118,27 +137,31 @@ declare module "crypto" { const fips: boolean; function createHash(algorithm: string, options?: HashOptions): Hash; - function createHmac(algorithm: string, key: BinaryLike, options?: stream.TransformOptions): Hmac; + function createHmac(algorithm: string, key: BinaryLike | KeyObject, options?: stream.TransformOptions): Hmac; - type Utf8AsciiLatin1Encoding = "utf8" | "ascii" | "latin1"; - type HexBase64Latin1Encoding = "latin1" | "hex" | "base64"; - type Utf8AsciiBinaryEncoding = "utf8" | "ascii" | "binary"; - type HexBase64BinaryEncoding = "binary" | "base64" | "hex"; - type ECDHKeyFormat = "compressed" | "uncompressed" | "hybrid"; + // https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings + type BinaryToTextEncoding = 'base64' | 'hex'; + type CharacterEncoding = 'utf8' | 'utf-8' | 'utf16le' | 'latin1'; + type LegacyCharacterEncoding = 'ascii' | 'binary' | 'ucs2' | 'ucs-2'; + + type Encoding = BinaryToTextEncoding | CharacterEncoding | LegacyCharacterEncoding; + + type ECDHKeyFormat = 'compressed' | 'uncompressed' | 'hybrid'; class Hash extends stream.Transform { private constructor(); + copy(): Hash; update(data: BinaryLike): Hash; - update(data: string, input_encoding: Utf8AsciiLatin1Encoding): Hash; + update(data: string, input_encoding: Encoding): Hash; digest(): Buffer; - digest(encoding: HexBase64Latin1Encoding): string; + digest(encoding: BinaryToTextEncoding): string; } class Hmac extends stream.Transform { private constructor(); update(data: BinaryLike): Hmac; - update(data: string, input_encoding: Utf8AsciiLatin1Encoding): Hmac; + update(data: string, input_encoding: Encoding): Hmac; digest(): Buffer; - digest(encoding: HexBase64Latin1Encoding): string; + digest(encoding: BinaryToTextEncoding): string; } type KeyObjectType = 'secret' | 'public' | 'private'; @@ -160,11 +183,11 @@ declare module "crypto" { asymmetricKeySize?: number; export(options: KeyExportOptions<'pem'>): string | Buffer; export(options?: KeyExportOptions<'der'>): Buffer; - symmetricSize?: number; + symmetricKeySize?: number; type: KeyObjectType; } - type CipherCCMTypes = 'aes-128-ccm' | 'aes-192-ccm' | 'aes-256-ccm'; + type CipherCCMTypes = 'aes-128-ccm' | 'aes-192-ccm' | 'aes-256-ccm' | 'chacha20-poly1305'; type CipherGCMTypes = 'aes-128-gcm' | 'aes-192-gcm' | 'aes-256-gcm'; type BinaryLike = string | NodeJS.ArrayBufferView; @@ -177,78 +200,86 @@ declare module "crypto" { interface CipherGCMOptions extends stream.TransformOptions { authTagLength?: number; } - /** @deprecated since v10.0.0 use createCipheriv() */ + /** @deprecated since v10.0.0 use `createCipheriv()` */ function createCipher(algorithm: CipherCCMTypes, password: BinaryLike, options: CipherCCMOptions): CipherCCM; - /** @deprecated since v10.0.0 use createCipheriv() */ + /** @deprecated since v10.0.0 use `createCipheriv()` */ function createCipher(algorithm: CipherGCMTypes, password: BinaryLike, options?: CipherGCMOptions): CipherGCM; - /** @deprecated since v10.0.0 use createCipheriv() */ + /** @deprecated since v10.0.0 use `createCipheriv()` */ function createCipher(algorithm: string, password: BinaryLike, options?: stream.TransformOptions): Cipher; function createCipheriv( algorithm: CipherCCMTypes, key: CipherKey, iv: BinaryLike | null, - options: CipherCCMOptions + options: CipherCCMOptions, ): CipherCCM; function createCipheriv( algorithm: CipherGCMTypes, key: CipherKey, iv: BinaryLike | null, - options?: CipherGCMOptions + options?: CipherGCMOptions, ): CipherGCM; function createCipheriv( - algorithm: string, key: CipherKey, iv: BinaryLike | null, options?: stream.TransformOptions + algorithm: string, + key: CipherKey, + iv: BinaryLike | null, + options?: stream.TransformOptions, ): Cipher; class Cipher extends stream.Transform { private constructor(); update(data: BinaryLike): Buffer; - update(data: string, input_encoding: Utf8AsciiBinaryEncoding): Buffer; - update(data: NodeJS.ArrayBufferView, input_encoding: undefined, output_encoding: HexBase64BinaryEncoding): string; - update(data: string, input_encoding: Utf8AsciiBinaryEncoding | undefined, output_encoding: HexBase64BinaryEncoding): string; + update(data: string, input_encoding: Encoding): Buffer; + update(data: NodeJS.ArrayBufferView, input_encoding: undefined, output_encoding: BinaryToTextEncoding): string; + update(data: string, input_encoding: Encoding | undefined, output_encoding: BinaryToTextEncoding): string; final(): Buffer; - final(output_encoding: string): string; + final(output_encoding: BufferEncoding): string; setAutoPadding(auto_padding?: boolean): this; // getAuthTag(): Buffer; - // setAAD(buffer: Buffer): this; // docs only say buffer + // setAAD(buffer: NodeJS.ArrayBufferView): this; } interface CipherCCM extends Cipher { - setAAD(buffer: Buffer, options: { plaintextLength: number }): this; + setAAD(buffer: NodeJS.ArrayBufferView, options: { plaintextLength: number }): this; getAuthTag(): Buffer; } interface CipherGCM extends Cipher { - setAAD(buffer: Buffer, options?: { plaintextLength: number }): this; + setAAD(buffer: NodeJS.ArrayBufferView, options?: { plaintextLength: number }): this; getAuthTag(): Buffer; } - /** @deprecated since v10.0.0 use createCipheriv() */ + /** @deprecated since v10.0.0 use `createDecipheriv()` */ function createDecipher(algorithm: CipherCCMTypes, password: BinaryLike, options: CipherCCMOptions): DecipherCCM; - /** @deprecated since v10.0.0 use createCipheriv() */ + /** @deprecated since v10.0.0 use `createDecipheriv()` */ function createDecipher(algorithm: CipherGCMTypes, password: BinaryLike, options?: CipherGCMOptions): DecipherGCM; - /** @deprecated since v10.0.0 use createCipheriv() */ + /** @deprecated since v10.0.0 use `createDecipheriv()` */ function createDecipher(algorithm: string, password: BinaryLike, options?: stream.TransformOptions): Decipher; function createDecipheriv( algorithm: CipherCCMTypes, - key: BinaryLike, + key: CipherKey, iv: BinaryLike | null, options: CipherCCMOptions, ): DecipherCCM; function createDecipheriv( algorithm: CipherGCMTypes, - key: BinaryLike, + key: CipherKey, iv: BinaryLike | null, options?: CipherGCMOptions, ): DecipherGCM; - function createDecipheriv(algorithm: string, key: BinaryLike, iv: BinaryLike | null, options?: stream.TransformOptions): Decipher; + function createDecipheriv( + algorithm: string, + key: CipherKey, + iv: BinaryLike | null, + options?: stream.TransformOptions, + ): Decipher; class Decipher extends stream.Transform { private constructor(); update(data: NodeJS.ArrayBufferView): Buffer; - update(data: string, input_encoding: HexBase64BinaryEncoding): Buffer; - update(data: NodeJS.ArrayBufferView, input_encoding: HexBase64BinaryEncoding | undefined, output_encoding: Utf8AsciiBinaryEncoding): string; - update(data: string, input_encoding: HexBase64BinaryEncoding | undefined, output_encoding: Utf8AsciiBinaryEncoding): string; + update(data: string, input_encoding: BinaryToTextEncoding): Buffer; + update(data: NodeJS.ArrayBufferView, input_encoding: undefined, output_encoding: Encoding): string; + update(data: string, input_encoding: BinaryToTextEncoding | undefined, output_encoding: Encoding): string; final(): Buffer; - final(output_encoding: string): string; + final(output_encoding: BufferEncoding): string; setAutoPadding(auto_padding?: boolean): this; // setAuthTag(tag: NodeJS.ArrayBufferView): this; // setAAD(buffer: NodeJS.ArrayBufferView): this; @@ -277,19 +308,28 @@ declare module "crypto" { function createPrivateKey(key: PrivateKeyInput | string | Buffer): KeyObject; function createPublicKey(key: PublicKeyInput | string | Buffer | KeyObject): KeyObject; - function createSecretKey(key: Buffer): KeyObject; + function createSecretKey(key: NodeJS.ArrayBufferView): KeyObject; function createSign(algorithm: string, options?: stream.WritableOptions): Signer; + type DSAEncoding = 'der' | 'ieee-p1363'; + interface SigningOptions { /** * @See crypto.constants.RSA_PKCS1_PADDING */ padding?: number; saltLength?: number; + dsaEncoding?: DSAEncoding; } - interface SignPrivateKeyInput extends PrivateKeyInput, SigningOptions { + interface SignPrivateKeyInput extends PrivateKeyInput, SigningOptions {} + interface SignKeyObjectInput extends SigningOptions { + key: KeyObject; + } + interface VerifyPublicKeyInput extends PublicKeyInput, SigningOptions {} + interface VerifyKeyObjectInput extends SigningOptions { + key: KeyObject; } type KeyLike = string | Buffer | KeyObject; @@ -298,9 +338,12 @@ declare module "crypto" { private constructor(); update(data: BinaryLike): Signer; - update(data: string, input_encoding: Utf8AsciiLatin1Encoding): Signer; - sign(private_key: SignPrivateKeyInput | KeyLike): Buffer; - sign(private_key: SignPrivateKeyInput | KeyLike, output_format: HexBase64Latin1Encoding): string; + update(data: string, input_encoding: Encoding): Signer; + sign(private_key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput): Buffer; + sign( + private_key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput, + output_format: BinaryToTextEncoding, + ): string; } function createVerify(algorithm: string, options?: stream.WritableOptions): Verify; @@ -308,37 +351,57 @@ declare module "crypto" { private constructor(); update(data: BinaryLike): Verify; - update(data: string, input_encoding: Utf8AsciiLatin1Encoding): Verify; - verify(object: Object | KeyLike, signature: NodeJS.ArrayBufferView): boolean; - verify(object: Object | KeyLike, signature: string, signature_format?: HexBase64Latin1Encoding): boolean; + update(data: string, input_encoding: Encoding): Verify; + verify( + object: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput, + signature: NodeJS.ArrayBufferView, + ): boolean; + verify( + object: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput, + signature: string, + signature_format?: BinaryToTextEncoding, + ): boolean; // https://nodejs.org/api/crypto.html#crypto_verifier_verify_object_signature_signature_format // The signature field accepts a TypedArray type, but it is only available starting ES2017 } function createDiffieHellman(prime_length: number, generator?: number | NodeJS.ArrayBufferView): DiffieHellman; function createDiffieHellman(prime: NodeJS.ArrayBufferView): DiffieHellman; - function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding): DiffieHellman; - function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding, generator: number | NodeJS.ArrayBufferView): DiffieHellman; - function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding, generator: string, generator_encoding: HexBase64Latin1Encoding): DiffieHellman; + function createDiffieHellman(prime: string, prime_encoding: BinaryToTextEncoding): DiffieHellman; + function createDiffieHellman( + prime: string, + prime_encoding: BinaryToTextEncoding, + generator: number | NodeJS.ArrayBufferView, + ): DiffieHellman; + function createDiffieHellman( + prime: string, + prime_encoding: BinaryToTextEncoding, + generator: string, + generator_encoding: BinaryToTextEncoding, + ): DiffieHellman; class DiffieHellman { private constructor(); generateKeys(): Buffer; - generateKeys(encoding: HexBase64Latin1Encoding): string; + generateKeys(encoding: BinaryToTextEncoding): string; computeSecret(other_public_key: NodeJS.ArrayBufferView): Buffer; - computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding): Buffer; - computeSecret(other_public_key: NodeJS.ArrayBufferView, output_encoding: HexBase64Latin1Encoding): string; - computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding, output_encoding: HexBase64Latin1Encoding): string; + computeSecret(other_public_key: string, input_encoding: BinaryToTextEncoding): Buffer; + computeSecret(other_public_key: NodeJS.ArrayBufferView, output_encoding: BinaryToTextEncoding): string; + computeSecret( + other_public_key: string, + input_encoding: BinaryToTextEncoding, + output_encoding: BinaryToTextEncoding, + ): string; getPrime(): Buffer; - getPrime(encoding: HexBase64Latin1Encoding): string; + getPrime(encoding: BinaryToTextEncoding): string; getGenerator(): Buffer; - getGenerator(encoding: HexBase64Latin1Encoding): string; + getGenerator(encoding: BinaryToTextEncoding): string; getPublicKey(): Buffer; - getPublicKey(encoding: HexBase64Latin1Encoding): string; + getPublicKey(encoding: BinaryToTextEncoding): string; getPrivateKey(): Buffer; - getPrivateKey(encoding: HexBase64Latin1Encoding): string; + getPrivateKey(encoding: BinaryToTextEncoding): string; setPublicKey(public_key: NodeJS.ArrayBufferView): void; - setPublicKey(public_key: string, encoding: string): void; + setPublicKey(public_key: string, encoding: BufferEncoding): void; setPrivateKey(private_key: NodeJS.ArrayBufferView): void; - setPrivateKey(private_key: string, encoding: string): void; + setPrivateKey(private_key: string, encoding: BufferEncoding): void; verifyError: number; } function getDiffieHellman(group_name: string): DiffieHellman; @@ -350,19 +413,45 @@ declare module "crypto" { digest: string, callback: (err: Error | null, derivedKey: Buffer) => any, ): void; - function pbkdf2Sync(password: BinaryLike, salt: BinaryLike, iterations: number, keylen: number, digest: string): Buffer; + function pbkdf2Sync( + password: BinaryLike, + salt: BinaryLike, + iterations: number, + keylen: number, + digest: string, + ): Buffer; function randomBytes(size: number): Buffer; function randomBytes(size: number, callback: (err: Error | null, buf: Buffer) => void): void; function pseudoRandomBytes(size: number): Buffer; function pseudoRandomBytes(size: number, callback: (err: Error | null, buf: Buffer) => void): void; + function randomInt(max: number): number; + function randomInt(min: number, max: number): number; + function randomInt(max: number, callback: (err: Error | null, value: number) => void): void; + function randomInt(min: number, max: number, callback: (err: Error | null, value: number) => void): void; + function randomFillSync(buffer: T, offset?: number, size?: number): T; - function randomFill(buffer: T, callback: (err: Error | null, buf: T) => void): void; - function randomFill(buffer: T, offset: number, callback: (err: Error | null, buf: T) => void): void; - function randomFill(buffer: T, offset: number, size: number, callback: (err: Error | null, buf: T) => void): void; + function randomFill( + buffer: T, + callback: (err: Error | null, buf: T) => void, + ): void; + function randomFill( + buffer: T, + offset: number, + callback: (err: Error | null, buf: T) => void, + ): void; + function randomFill( + buffer: T, + offset: number, + size: number, + callback: (err: Error | null, buf: T) => void, + ): void; interface ScryptOptions { + cost?: number; + blockSize?: number; + parallelization?: number; N?: number; r?: number; p?: number; @@ -371,7 +460,8 @@ declare module "crypto" { function scrypt( password: BinaryLike, salt: BinaryLike, - keylen: number, callback: (err: Error | null, derivedKey: Buffer) => void, + keylen: number, + callback: (err: Error | null, derivedKey: Buffer) => void, ): void; function scrypt( password: BinaryLike, @@ -402,35 +492,40 @@ declare module "crypto" { function privateEncrypt(private_key: RsaPrivateKey | KeyLike, buffer: NodeJS.ArrayBufferView): Buffer; function getCiphers(): string[]; function getCurves(): string[]; + function getFips(): 1 | 0; function getHashes(): string[]; class ECDH { private constructor(); static convertKey( key: BinaryLike, curve: string, - inputEncoding?: HexBase64Latin1Encoding, - outputEncoding?: "latin1" | "hex" | "base64", - format?: "uncompressed" | "compressed" | "hybrid", + inputEncoding?: BinaryToTextEncoding, + outputEncoding?: 'latin1' | 'hex' | 'base64', + format?: 'uncompressed' | 'compressed' | 'hybrid', ): Buffer | string; generateKeys(): Buffer; - generateKeys(encoding: HexBase64Latin1Encoding, format?: ECDHKeyFormat): string; + generateKeys(encoding: BinaryToTextEncoding, format?: ECDHKeyFormat): string; computeSecret(other_public_key: NodeJS.ArrayBufferView): Buffer; - computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding): Buffer; - computeSecret(other_public_key: NodeJS.ArrayBufferView, output_encoding: HexBase64Latin1Encoding): string; - computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding, output_encoding: HexBase64Latin1Encoding): string; + computeSecret(other_public_key: string, input_encoding: BinaryToTextEncoding): Buffer; + computeSecret(other_public_key: NodeJS.ArrayBufferView, output_encoding: BinaryToTextEncoding): string; + computeSecret( + other_public_key: string, + input_encoding: BinaryToTextEncoding, + output_encoding: BinaryToTextEncoding, + ): string; getPrivateKey(): Buffer; - getPrivateKey(encoding: HexBase64Latin1Encoding): string; + getPrivateKey(encoding: BinaryToTextEncoding): string; getPublicKey(): Buffer; - getPublicKey(encoding: HexBase64Latin1Encoding, format?: ECDHKeyFormat): string; + getPublicKey(encoding: BinaryToTextEncoding, format?: ECDHKeyFormat): string; setPrivateKey(private_key: NodeJS.ArrayBufferView): void; - setPrivateKey(private_key: string, encoding: HexBase64Latin1Encoding): void; + setPrivateKey(private_key: string, encoding: BinaryToTextEncoding): void; } function createECDH(curve_name: string): ECDH; function timingSafeEqual(a: NodeJS.ArrayBufferView, b: NodeJS.ArrayBufferView): boolean; /** @deprecated since v10.0.0 */ - const DEFAULT_ENCODING: string; + const DEFAULT_ENCODING: BufferEncoding; - type KeyType = 'rsa' | 'dsa' | 'ec'; + type KeyType = 'rsa' | 'dsa' | 'ec' | 'ed25519' | 'ed448' | 'x25519' | 'x448'; type KeyFormat = 'pem' | 'der'; interface BasePrivateKeyEncodingOptions { @@ -444,6 +539,30 @@ declare module "crypto" { privateKey: KeyObject; } + interface ED25519KeyPairKeyObjectOptions { + /** + * No options. + */ + } + + interface ED448KeyPairKeyObjectOptions { + /** + * No options. + */ + } + + interface X25519KeyPairKeyObjectOptions { + /** + * No options. + */ + } + + interface X448KeyPairKeyObjectOptions { + /** + * No options. + */ + } + interface ECKeyPairKeyObjectOptions { /** * Name of the curve to use. @@ -528,65 +647,491 @@ declare module "crypto" { }; } + interface ED25519KeyPairOptions { + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + + interface ED448KeyPairOptions { + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + + interface X25519KeyPairOptions { + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + + interface X448KeyPairOptions { + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + interface KeyPairSyncResult { publicKey: T1; privateKey: T2; } - function generateKeyPairSync(type: 'rsa', options: RSAKeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; - function generateKeyPairSync(type: 'rsa', options: RSAKeyPairOptions<'pem', 'der'>): KeyPairSyncResult; - function generateKeyPairSync(type: 'rsa', options: RSAKeyPairOptions<'der', 'pem'>): KeyPairSyncResult; - function generateKeyPairSync(type: 'rsa', options: RSAKeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync( + type: 'rsa', + options: RSAKeyPairOptions<'pem', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'rsa', + options: RSAKeyPairOptions<'pem', 'der'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'rsa', + options: RSAKeyPairOptions<'der', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'rsa', + options: RSAKeyPairOptions<'der', 'der'>, + ): KeyPairSyncResult; function generateKeyPairSync(type: 'rsa', options: RSAKeyPairKeyObjectOptions): KeyPairKeyObjectResult; - function generateKeyPairSync(type: 'dsa', options: DSAKeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; - function generateKeyPairSync(type: 'dsa', options: DSAKeyPairOptions<'pem', 'der'>): KeyPairSyncResult; - function generateKeyPairSync(type: 'dsa', options: DSAKeyPairOptions<'der', 'pem'>): KeyPairSyncResult; - function generateKeyPairSync(type: 'dsa', options: DSAKeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync( + type: 'dsa', + options: DSAKeyPairOptions<'pem', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'dsa', + options: DSAKeyPairOptions<'pem', 'der'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'dsa', + options: DSAKeyPairOptions<'der', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'dsa', + options: DSAKeyPairOptions<'der', 'der'>, + ): KeyPairSyncResult; function generateKeyPairSync(type: 'dsa', options: DSAKeyPairKeyObjectOptions): KeyPairKeyObjectResult; - function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; - function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'pem', 'der'>): KeyPairSyncResult; - function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'der', 'pem'>): KeyPairSyncResult; - function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync( + type: 'ec', + options: ECKeyPairOptions<'pem', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'ec', + options: ECKeyPairOptions<'pem', 'der'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'ec', + options: ECKeyPairOptions<'der', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'ec', + options: ECKeyPairOptions<'der', 'der'>, + ): KeyPairSyncResult; function generateKeyPairSync(type: 'ec', options: ECKeyPairKeyObjectOptions): KeyPairKeyObjectResult; - function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; - function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; - function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; - function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; - function generateKeyPair(type: 'rsa', options: RSAKeyPairKeyObjectOptions, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + function generateKeyPairSync( + type: 'ed25519', + options: ED25519KeyPairOptions<'pem', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'ed25519', + options: ED25519KeyPairOptions<'pem', 'der'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'ed25519', + options: ED25519KeyPairOptions<'der', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'ed25519', + options: ED25519KeyPairOptions<'der', 'der'>, + ): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed25519', options?: ED25519KeyPairKeyObjectOptions): KeyPairKeyObjectResult; - function generateKeyPair(type: 'dsa', options: DSAKeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; - function generateKeyPair(type: 'dsa', options: DSAKeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; - function generateKeyPair(type: 'dsa', options: DSAKeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; - function generateKeyPair(type: 'dsa', options: DSAKeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; - function generateKeyPair(type: 'dsa', options: DSAKeyPairKeyObjectOptions, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + function generateKeyPairSync( + type: 'ed448', + options: ED448KeyPairOptions<'pem', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'ed448', + options: ED448KeyPairOptions<'pem', 'der'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'ed448', + options: ED448KeyPairOptions<'der', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'ed448', + options: ED448KeyPairOptions<'der', 'der'>, + ): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed448', options?: ED448KeyPairKeyObjectOptions): KeyPairKeyObjectResult; - function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; - function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; - function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; - function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; - function generateKeyPair(type: 'ec', options: ECKeyPairKeyObjectOptions, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + function generateKeyPairSync( + type: 'x25519', + options: X25519KeyPairOptions<'pem', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'x25519', + options: X25519KeyPairOptions<'pem', 'der'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'x25519', + options: X25519KeyPairOptions<'der', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'x25519', + options: X25519KeyPairOptions<'der', 'der'>, + ): KeyPairSyncResult; + function generateKeyPairSync(type: 'x25519', options?: X25519KeyPairKeyObjectOptions): KeyPairKeyObjectResult; + + function generateKeyPairSync( + type: 'x448', + options: X448KeyPairOptions<'pem', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'x448', + options: X448KeyPairOptions<'pem', 'der'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'x448', + options: X448KeyPairOptions<'der', 'pem'>, + ): KeyPairSyncResult; + function generateKeyPairSync( + type: 'x448', + options: X448KeyPairOptions<'der', 'der'>, + ): KeyPairSyncResult; + function generateKeyPairSync(type: 'x448', options?: X448KeyPairKeyObjectOptions): KeyPairKeyObjectResult; + + function generateKeyPair( + type: 'rsa', + options: RSAKeyPairOptions<'pem', 'pem'>, + callback: (err: Error | null, publicKey: string, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'rsa', + options: RSAKeyPairOptions<'pem', 'der'>, + callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'rsa', + options: RSAKeyPairOptions<'der', 'pem'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'rsa', + options: RSAKeyPairOptions<'der', 'der'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'rsa', + options: RSAKeyPairKeyObjectOptions, + callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void, + ): void; + + function generateKeyPair( + type: 'dsa', + options: DSAKeyPairOptions<'pem', 'pem'>, + callback: (err: Error | null, publicKey: string, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'dsa', + options: DSAKeyPairOptions<'pem', 'der'>, + callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'dsa', + options: DSAKeyPairOptions<'der', 'pem'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'dsa', + options: DSAKeyPairOptions<'der', 'der'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'dsa', + options: DSAKeyPairKeyObjectOptions, + callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void, + ): void; + + function generateKeyPair( + type: 'ec', + options: ECKeyPairOptions<'pem', 'pem'>, + callback: (err: Error | null, publicKey: string, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'ec', + options: ECKeyPairOptions<'pem', 'der'>, + callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'ec', + options: ECKeyPairOptions<'der', 'pem'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'ec', + options: ECKeyPairOptions<'der', 'der'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'ec', + options: ECKeyPairKeyObjectOptions, + callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void, + ): void; + + function generateKeyPair( + type: 'ed25519', + options: ED25519KeyPairOptions<'pem', 'pem'>, + callback: (err: Error | null, publicKey: string, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'ed25519', + options: ED25519KeyPairOptions<'pem', 'der'>, + callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'ed25519', + options: ED25519KeyPairOptions<'der', 'pem'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'ed25519', + options: ED25519KeyPairOptions<'der', 'der'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'ed25519', + options: ED25519KeyPairKeyObjectOptions | undefined, + callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void, + ): void; + + function generateKeyPair( + type: 'ed448', + options: ED448KeyPairOptions<'pem', 'pem'>, + callback: (err: Error | null, publicKey: string, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'ed448', + options: ED448KeyPairOptions<'pem', 'der'>, + callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'ed448', + options: ED448KeyPairOptions<'der', 'pem'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'ed448', + options: ED448KeyPairOptions<'der', 'der'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'ed448', + options: ED448KeyPairKeyObjectOptions | undefined, + callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void, + ): void; + + function generateKeyPair( + type: 'x25519', + options: X25519KeyPairOptions<'pem', 'pem'>, + callback: (err: Error | null, publicKey: string, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'x25519', + options: X25519KeyPairOptions<'pem', 'der'>, + callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'x25519', + options: X25519KeyPairOptions<'der', 'pem'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'x25519', + options: X25519KeyPairOptions<'der', 'der'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'x25519', + options: X25519KeyPairKeyObjectOptions | undefined, + callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void, + ): void; + + function generateKeyPair( + type: 'x448', + options: X448KeyPairOptions<'pem', 'pem'>, + callback: (err: Error | null, publicKey: string, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'x448', + options: X448KeyPairOptions<'pem', 'der'>, + callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'x448', + options: X448KeyPairOptions<'der', 'pem'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void, + ): void; + function generateKeyPair( + type: 'x448', + options: X448KeyPairOptions<'der', 'der'>, + callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void, + ): void; + function generateKeyPair( + type: 'x448', + options: X448KeyPairKeyObjectOptions | undefined, + callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void, + ): void; namespace generateKeyPair { - function __promisify__(type: "rsa", options: RSAKeyPairOptions<'pem', 'pem'>): Promise<{ publicKey: string, privateKey: string }>; - function __promisify__(type: "rsa", options: RSAKeyPairOptions<'pem', 'der'>): Promise<{ publicKey: string, privateKey: Buffer }>; - function __promisify__(type: "rsa", options: RSAKeyPairOptions<'der', 'pem'>): Promise<{ publicKey: Buffer, privateKey: string }>; - function __promisify__(type: "rsa", options: RSAKeyPairOptions<'der', 'der'>): Promise<{ publicKey: Buffer, privateKey: Buffer }>; - function __promisify__(type: "rsa", options: RSAKeyPairKeyObjectOptions): Promise; + function __promisify__( + type: 'rsa', + options: RSAKeyPairOptions<'pem', 'pem'>, + ): Promise<{ publicKey: string; privateKey: string }>; + function __promisify__( + type: 'rsa', + options: RSAKeyPairOptions<'pem', 'der'>, + ): Promise<{ publicKey: string; privateKey: Buffer }>; + function __promisify__( + type: 'rsa', + options: RSAKeyPairOptions<'der', 'pem'>, + ): Promise<{ publicKey: Buffer; privateKey: string }>; + function __promisify__( + type: 'rsa', + options: RSAKeyPairOptions<'der', 'der'>, + ): Promise<{ publicKey: Buffer; privateKey: Buffer }>; + function __promisify__(type: 'rsa', options: RSAKeyPairKeyObjectOptions): Promise; - function __promisify__(type: "dsa", options: DSAKeyPairOptions<'pem', 'pem'>): Promise<{ publicKey: string, privateKey: string }>; - function __promisify__(type: "dsa", options: DSAKeyPairOptions<'pem', 'der'>): Promise<{ publicKey: string, privateKey: Buffer }>; - function __promisify__(type: "dsa", options: DSAKeyPairOptions<'der', 'pem'>): Promise<{ publicKey: Buffer, privateKey: string }>; - function __promisify__(type: "dsa", options: DSAKeyPairOptions<'der', 'der'>): Promise<{ publicKey: Buffer, privateKey: Buffer }>; - function __promisify__(type: "dsa", options: DSAKeyPairKeyObjectOptions): Promise; + function __promisify__( + type: 'dsa', + options: DSAKeyPairOptions<'pem', 'pem'>, + ): Promise<{ publicKey: string; privateKey: string }>; + function __promisify__( + type: 'dsa', + options: DSAKeyPairOptions<'pem', 'der'>, + ): Promise<{ publicKey: string; privateKey: Buffer }>; + function __promisify__( + type: 'dsa', + options: DSAKeyPairOptions<'der', 'pem'>, + ): Promise<{ publicKey: Buffer; privateKey: string }>; + function __promisify__( + type: 'dsa', + options: DSAKeyPairOptions<'der', 'der'>, + ): Promise<{ publicKey: Buffer; privateKey: Buffer }>; + function __promisify__(type: 'dsa', options: DSAKeyPairKeyObjectOptions): Promise; - function __promisify__(type: "ec", options: ECKeyPairOptions<'pem', 'pem'>): Promise<{ publicKey: string, privateKey: string }>; - function __promisify__(type: "ec", options: ECKeyPairOptions<'pem', 'der'>): Promise<{ publicKey: string, privateKey: Buffer }>; - function __promisify__(type: "ec", options: ECKeyPairOptions<'der', 'pem'>): Promise<{ publicKey: Buffer, privateKey: string }>; - function __promisify__(type: "ec", options: ECKeyPairOptions<'der', 'der'>): Promise<{ publicKey: Buffer, privateKey: Buffer }>; - function __promisify__(type: "ec", options: ECKeyPairKeyObjectOptions): Promise; + function __promisify__( + type: 'ec', + options: ECKeyPairOptions<'pem', 'pem'>, + ): Promise<{ publicKey: string; privateKey: string }>; + function __promisify__( + type: 'ec', + options: ECKeyPairOptions<'pem', 'der'>, + ): Promise<{ publicKey: string; privateKey: Buffer }>; + function __promisify__( + type: 'ec', + options: ECKeyPairOptions<'der', 'pem'>, + ): Promise<{ publicKey: Buffer; privateKey: string }>; + function __promisify__( + type: 'ec', + options: ECKeyPairOptions<'der', 'der'>, + ): Promise<{ publicKey: Buffer; privateKey: Buffer }>; + function __promisify__(type: 'ec', options: ECKeyPairKeyObjectOptions): Promise; + + function __promisify__( + type: 'ed25519', + options: ED25519KeyPairOptions<'pem', 'pem'>, + ): Promise<{ publicKey: string; privateKey: string }>; + function __promisify__( + type: 'ed25519', + options: ED25519KeyPairOptions<'pem', 'der'>, + ): Promise<{ publicKey: string; privateKey: Buffer }>; + function __promisify__( + type: 'ed25519', + options: ED25519KeyPairOptions<'der', 'pem'>, + ): Promise<{ publicKey: Buffer; privateKey: string }>; + function __promisify__( + type: 'ed25519', + options: ED25519KeyPairOptions<'der', 'der'>, + ): Promise<{ publicKey: Buffer; privateKey: Buffer }>; + function __promisify__( + type: 'ed25519', + options?: ED25519KeyPairKeyObjectOptions, + ): Promise; + + function __promisify__( + type: 'ed448', + options: ED448KeyPairOptions<'pem', 'pem'>, + ): Promise<{ publicKey: string; privateKey: string }>; + function __promisify__( + type: 'ed448', + options: ED448KeyPairOptions<'pem', 'der'>, + ): Promise<{ publicKey: string; privateKey: Buffer }>; + function __promisify__( + type: 'ed448', + options: ED448KeyPairOptions<'der', 'pem'>, + ): Promise<{ publicKey: Buffer; privateKey: string }>; + function __promisify__( + type: 'ed448', + options: ED448KeyPairOptions<'der', 'der'>, + ): Promise<{ publicKey: Buffer; privateKey: Buffer }>; + function __promisify__(type: 'ed448', options?: ED448KeyPairKeyObjectOptions): Promise; + + function __promisify__( + type: 'x25519', + options: X25519KeyPairOptions<'pem', 'pem'>, + ): Promise<{ publicKey: string; privateKey: string }>; + function __promisify__( + type: 'x25519', + options: X25519KeyPairOptions<'pem', 'der'>, + ): Promise<{ publicKey: string; privateKey: Buffer }>; + function __promisify__( + type: 'x25519', + options: X25519KeyPairOptions<'der', 'pem'>, + ): Promise<{ publicKey: Buffer; privateKey: string }>; + function __promisify__( + type: 'x25519', + options: X25519KeyPairOptions<'der', 'der'>, + ): Promise<{ publicKey: Buffer; privateKey: Buffer }>; + function __promisify__( + type: 'x25519', + options?: X25519KeyPairKeyObjectOptions, + ): Promise; + + function __promisify__( + type: 'x448', + options: X448KeyPairOptions<'pem', 'pem'>, + ): Promise<{ publicKey: string; privateKey: string }>; + function __promisify__( + type: 'x448', + options: X448KeyPairOptions<'pem', 'der'>, + ): Promise<{ publicKey: string; privateKey: Buffer }>; + function __promisify__( + type: 'x448', + options: X448KeyPairOptions<'der', 'pem'>, + ): Promise<{ publicKey: Buffer; privateKey: string }>; + function __promisify__( + type: 'x448', + options: X448KeyPairOptions<'der', 'der'>, + ): Promise<{ publicKey: Buffer; privateKey: Buffer }>; + function __promisify__(type: 'x448', options?: X448KeyPairKeyObjectOptions): Promise; } /** @@ -597,10 +1142,11 @@ declare module "crypto" { * If `key` is not a [`KeyObject`][], this function behaves as if `key` had been * passed to [`crypto.createPrivateKey()`][]. */ - function sign(algorithm: string | null | undefined, data: NodeJS.ArrayBufferView, key: KeyLike | SignPrivateKeyInput): Buffer; - - interface VerifyKeyWithOptions extends KeyObject, SigningOptions { - } + function sign( + algorithm: string | null | undefined, + data: NodeJS.ArrayBufferView, + key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput, + ): Buffer; /** * Calculates and returns the signature for `data` using the given private key and @@ -610,5 +1156,17 @@ declare module "crypto" { * If `key` is not a [`KeyObject`][], this function behaves as if `key` had been * passed to [`crypto.createPublicKey()`][]. */ - function verify(algorithm: string | null | undefined, data: NodeJS.ArrayBufferView, key: KeyLike | VerifyKeyWithOptions, signature: NodeJS.ArrayBufferView): Buffer; + function verify( + algorithm: string | null | undefined, + data: NodeJS.ArrayBufferView, + key: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput, + signature: NodeJS.ArrayBufferView, + ): boolean; + + /** + * Computes the Diffie-Hellman secret based on a privateKey and a publicKey. + * Both keys must have the same asymmetricKeyType, which must be one of + * 'dh' (for Diffie-Hellman), 'ec' (for ECDH), 'x448', or 'x25519' (for ECDH-ES). + */ + function diffieHellman(options: { privateKey: KeyObject; publicKey: KeyObject }): Buffer; } diff --git a/node_modules/@types/node/dgram.d.ts b/node_modules/@types/node/dgram.d.ts index f04e9a2..73f2aa7 100644 --- a/node_modules/@types/node/dgram.d.ts +++ b/node_modules/@types/node/dgram.d.ts @@ -50,9 +50,9 @@ declare module "dgram" { getSendBufferSize(): number; ref(): this; remoteAddress(): AddressInfo; - send(msg: string | Uint8Array | any[], port?: number, address?: string, callback?: (error: Error | null, bytes: number) => void): void; - send(msg: string | Uint8Array | any[], port?: number, callback?: (error: Error | null, bytes: number) => void): void; - send(msg: string | Uint8Array | any[], callback?: (error: Error | null, bytes: number) => void): void; + send(msg: string | Uint8Array | ReadonlyArray, port?: number, address?: string, callback?: (error: Error | null, bytes: number) => void): void; + send(msg: string | Uint8Array | ReadonlyArray, port?: number, callback?: (error: Error | null, bytes: number) => void): void; + send(msg: string | Uint8Array | ReadonlyArray, callback?: (error: Error | null, bytes: number) => void): void; send(msg: string | Uint8Array, offset: number, length: number, port?: number, address?: string, callback?: (error: Error | null, bytes: number) => void): void; send(msg: string | Uint8Array, offset: number, length: number, port?: number, callback?: (error: Error | null, bytes: number) => void): void; send(msg: string | Uint8Array, offset: number, length: number, callback?: (error: Error | null, bytes: number) => void): void; @@ -64,6 +64,29 @@ declare module "dgram" { setSendBufferSize(size: number): void; setTTL(ttl: number): void; unref(): this; + /** + * Tells the kernel to join a source-specific multicast channel at the given + * `sourceAddress` and `groupAddress`, using the `multicastInterface` with the + * `IP_ADD_SOURCE_MEMBERSHIP` socket option. + * If the `multicastInterface` argument + * is not specified, the operating system will choose one interface and will add + * membership to it. + * To add membership to every available interface, call + * `socket.addSourceSpecificMembership()` multiple times, once per interface. + */ + addSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string): void; + + /** + * Instructs the kernel to leave a source-specific multicast channel at the given + * `sourceAddress` and `groupAddress` using the `IP_DROP_SOURCE_MEMBERSHIP` + * socket option. This method is automatically called by the kernel when the + * socket is closed or the process terminates, so most apps will never have + * reason to call this. + * + * If `multicastInterface` is not specified, the operating system will attempt to + * drop membership on all valid interfaces. + */ + dropSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string): void; /** * events.EventEmitter diff --git a/node_modules/@types/node/dns.d.ts b/node_modules/@types/node/dns.d.ts index d2b0505..edb721f 100644 --- a/node_modules/@types/node/dns.d.ts +++ b/node_modules/@types/node/dns.d.ts @@ -2,6 +2,11 @@ declare module "dns" { // Supported getaddrinfo flags. const ADDRCONFIG: number; const V4MAPPED: number; + /** + * If `dns.V4MAPPED` is specified, return resolved IPv6 addresses as + * well as IPv4 mapped IPv6 addresses. + */ + const ALL: number; interface LookupOptions { family?: number; @@ -55,7 +60,7 @@ declare module "dns" { ttl: number; } - /** @deprecated Use AnyARecord or AnyAaaaRecord instead. */ + /** @deprecated Use `AnyARecord` or `AnyAaaaRecord` instead. */ type AnyRecordWithTtl = AnyARecord | AnyAaaaRecord; interface AnyARecord extends RecordWithTtl { @@ -272,8 +277,8 @@ declare module "dns" { const CANCELLED: string; class Resolver { + cancel(): void; getServers: typeof getServers; - setServers: typeof setServers; resolve: typeof resolve; resolve4: typeof resolve4; resolve6: typeof resolve6; @@ -287,7 +292,8 @@ declare module "dns" { resolveSrv: typeof resolveSrv; resolveTxt: typeof resolveTxt; reverse: typeof reverse; - cancel(): void; + setLocalAddress(ipv4?: string, ipv6?: string): void; + setServers: typeof setServers; } namespace promises { @@ -346,6 +352,7 @@ declare module "dns" { function setServers(servers: ReadonlyArray): void; class Resolver { + cancel(): void; getServers: typeof getServers; resolve: typeof resolve; resolve4: typeof resolve4; @@ -360,6 +367,7 @@ declare module "dns" { resolveSrv: typeof resolveSrv; resolveTxt: typeof resolveTxt; reverse: typeof reverse; + setLocalAddress(ipv4?: string, ipv6?: string): void; setServers: typeof setServers; } } diff --git a/node_modules/@types/node/domain.d.ts b/node_modules/@types/node/domain.d.ts index 45e388c..6423ebf 100644 --- a/node_modules/@types/node/domain.d.ts +++ b/node_modules/@types/node/domain.d.ts @@ -1,13 +1,21 @@ -declare module "domain" { - import * as events from "events"; +declare module 'domain' { + import EventEmitter = require('events'); - class Domain extends events.EventEmitter implements NodeJS.Domain { - run(fn: (...args: any[]) => T, ...args: any[]): T; - add(emitter: events.EventEmitter | NodeJS.Timer): void; - remove(emitter: events.EventEmitter | NodeJS.Timer): void; - bind(cb: T): T; - intercept(cb: T): T; - members: Array; + global { + namespace NodeJS { + interface Domain extends EventEmitter { + run(fn: (...args: any[]) => T, ...args: any[]): T; + add(emitter: EventEmitter | Timer): void; + remove(emitter: EventEmitter | Timer): void; + bind(cb: T): T; + intercept(cb: T): T; + } + } + } + + interface Domain extends NodeJS.Domain {} + class Domain extends EventEmitter { + members: Array; enter(): void; exit(): void; } diff --git a/node_modules/@types/node/events.d.ts b/node_modules/@types/node/events.d.ts index 03f5b90..04f9a2f 100644 --- a/node_modules/@types/node/events.d.ts +++ b/node_modules/@types/node/events.d.ts @@ -1,5 +1,10 @@ -declare module "events" { - class internal extends NodeJS.EventEmitter { } +declare module 'events' { + interface EventEmitterOptions { + /** + * Enables automatic capturing of promise rejection. + */ + captureRejections?: boolean; + } interface NodeEventTarget { once(event: string | symbol, listener: (...args: any[]) => void): this; @@ -9,31 +14,65 @@ declare module "events" { addEventListener(event: string, listener: (...args: any[]) => void, opts?: { once: boolean }): any; } - namespace internal { - function once(emitter: NodeEventTarget, event: string | symbol): Promise; - function once(emitter: DOMEventTarget, event: string): Promise; - class EventEmitter extends internal { - /** @deprecated since v4.0.0 */ - static listenerCount(emitter: EventEmitter, event: string | symbol): number; - static defaultMaxListeners: number; + interface EventEmitter extends NodeJS.EventEmitter {} + class EventEmitter { + constructor(options?: EventEmitterOptions); - addListener(event: string | symbol, listener: (...args: any[]) => void): this; - on(event: string | symbol, listener: (...args: any[]) => void): this; - once(event: string | symbol, listener: (...args: any[]) => void): this; - prependListener(event: string | symbol, listener: (...args: any[]) => void): this; - prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; - removeListener(event: string | symbol, listener: (...args: any[]) => void): this; - off(event: string | symbol, listener: (...args: any[]) => void): this; - removeAllListeners(event?: string | symbol): this; - setMaxListeners(n: number): this; - getMaxListeners(): number; - listeners(event: string | symbol): Function[]; - rawListeners(event: string | symbol): Function[]; - emit(event: string | symbol, ...args: any[]): boolean; - eventNames(): Array; - listenerCount(type: string | symbol): number; + static once(emitter: NodeEventTarget, event: string | symbol): Promise; + static once(emitter: DOMEventTarget, event: string): Promise; + static on(emitter: NodeJS.EventEmitter, event: string): AsyncIterableIterator; + + /** @deprecated since v4.0.0 */ + static listenerCount(emitter: NodeJS.EventEmitter, event: string | symbol): number; + + /** + * This symbol shall be used to install a listener for only monitoring `'error'` + * events. Listeners installed using this symbol are called before the regular + * `'error'` listeners are called. + * + * Installing a listener using this symbol does not change the behavior once an + * `'error'` event is emitted, therefore the process will still crash if no + * regular `'error'` listener is installed. + */ + static readonly errorMonitor: unique symbol; + static readonly captureRejectionSymbol: unique symbol; + + /** + * Sets or gets the default captureRejection value for all emitters. + */ + // TODO: These should be described using static getter/setter pairs: + static captureRejections: boolean; + static defaultMaxListeners: number; + } + + import internal = require('events'); + namespace EventEmitter { + // Should just be `export { EventEmitter }`, but that doesn't work in TypeScript 3.4 + export { internal as EventEmitter }; + } + + global { + namespace NodeJS { + interface EventEmitter { + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + removeListener(event: string | symbol, listener: (...args: any[]) => void): this; + off(event: string | symbol, listener: (...args: any[]) => void): this; + removeAllListeners(event?: string | symbol): this; + setMaxListeners(n: number): this; + getMaxListeners(): number; + listeners(event: string | symbol): Function[]; + rawListeners(event: string | symbol): Function[]; + emit(event: string | symbol, ...args: any[]): boolean; + listenerCount(event: string | symbol): number; + // Added in Node 6... + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + eventNames(): Array; + } } } - export = internal; + export = EventEmitter; } diff --git a/node_modules/@types/node/fs.d.ts b/node_modules/@types/node/fs.d.ts index 8c57f0c..617312f 100644 --- a/node_modules/@types/node/fs.d.ts +++ b/node_modules/@types/node/fs.d.ts @@ -2,15 +2,27 @@ declare module "fs" { import * as stream from "stream"; import * as events from "events"; import { URL } from "url"; + import * as promises from 'fs/promises'; + export { promises }; /** * Valid types for path values in "fs". */ - type PathLike = string | Buffer | URL; + export type PathLike = string | Buffer | URL; - type NoParamCallback = (err: NodeJS.ErrnoException | null) => void; + export type NoParamCallback = (err: NodeJS.ErrnoException | null) => void; - interface StatsBase { + export type BufferEncodingOption = 'buffer' | { encoding: 'buffer' }; + + export interface BaseEncodingOptions { + encoding?: BufferEncoding | null; + } + + export type OpenMode = number | string; + + export type Mode = number | string; + + export interface StatsBase { isFile(): boolean; isDirectory(): boolean; isBlockDevice(): boolean; @@ -19,33 +31,33 @@ declare module "fs" { isFIFO(): boolean; isSocket(): boolean; - dev: number; - ino: number; - mode: number; - nlink: number; - uid: number; - gid: number; - rdev: number; - size: number; - blksize: number; - blocks: number; - atimeMs: number; - mtimeMs: number; - ctimeMs: number; - birthtimeMs: number; + dev: T; + ino: T; + mode: T; + nlink: T; + uid: T; + gid: T; + rdev: T; + size: T; + blksize: T; + blocks: T; + atimeMs: T; + mtimeMs: T; + ctimeMs: T; + birthtimeMs: T; atime: Date; mtime: Date; ctime: Date; birthtime: Date; } - interface Stats extends StatsBase { + export interface Stats extends StatsBase { } - class Stats { + export class Stats { } - class Dirent { + export class Dirent { isFile(): boolean; isDirectory(): boolean; isBlockDevice(): boolean; @@ -59,7 +71,7 @@ declare module "fs" { /** * A class representing a directory stream. */ - class Dir { + export class Dir { readonly path: string; /** @@ -93,10 +105,10 @@ declare module "fs" { * If there are no more directory entries to read, null will be returned. * Directory entries returned by this function are in no particular order as provided by the operating system's underlying directory mechanisms. */ - readSync(): Dirent; + readSync(): Dirent | null; } - interface FSWatcher extends events.EventEmitter { + export interface FSWatcher extends events.EventEmitter { close(): void; /** @@ -107,84 +119,158 @@ declare module "fs" { addListener(event: string, listener: (...args: any[]) => void): this; addListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; addListener(event: "error", listener: (error: Error) => void): this; + addListener(event: "close", listener: () => void): this; on(event: string, listener: (...args: any[]) => void): this; on(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; on(event: "error", listener: (error: Error) => void): this; + on(event: "close", listener: () => void): this; once(event: string, listener: (...args: any[]) => void): this; once(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; once(event: "error", listener: (error: Error) => void): this; + once(event: "close", listener: () => void): this; prependListener(event: string, listener: (...args: any[]) => void): this; prependListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; prependListener(event: "error", listener: (error: Error) => void): this; + prependListener(event: "close", listener: () => void): this; prependOnceListener(event: string, listener: (...args: any[]) => void): this; prependOnceListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; prependOnceListener(event: "error", listener: (error: Error) => void): this; + prependOnceListener(event: "close", listener: () => void): this; } - class ReadStream extends stream.Readable { + export class ReadStream extends stream.Readable { close(): void; bytesRead: number; path: string | Buffer; + pending: boolean; /** * events.EventEmitter * 1. open * 2. close + * 3. ready */ - addListener(event: string, listener: (...args: any[]) => void): this; - addListener(event: "open", listener: (fd: number) => void): this; addListener(event: "close", listener: () => void): this; + addListener(event: "data", listener: (chunk: Buffer | string) => void): this; + addListener(event: "end", listener: () => void): this; + addListener(event: "error", listener: (err: Error) => void): this; + addListener(event: "open", listener: (fd: number) => void): this; + addListener(event: "pause", listener: () => void): this; + addListener(event: "readable", listener: () => void): this; + addListener(event: "ready", listener: () => void): this; + addListener(event: "resume", listener: () => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; - on(event: string, listener: (...args: any[]) => void): this; - on(event: "open", listener: (fd: number) => void): this; on(event: "close", listener: () => void): this; + on(event: "data", listener: (chunk: Buffer | string) => void): this; + on(event: "end", listener: () => void): this; + on(event: "error", listener: (err: Error) => void): this; + on(event: "open", listener: (fd: number) => void): this; + on(event: "pause", listener: () => void): this; + on(event: "readable", listener: () => void): this; + on(event: "ready", listener: () => void): this; + on(event: "resume", listener: () => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; - once(event: string, listener: (...args: any[]) => void): this; - once(event: "open", listener: (fd: number) => void): this; once(event: "close", listener: () => void): this; + once(event: "data", listener: (chunk: Buffer | string) => void): this; + once(event: "end", listener: () => void): this; + once(event: "error", listener: (err: Error) => void): this; + once(event: "open", listener: (fd: number) => void): this; + once(event: "pause", listener: () => void): this; + once(event: "readable", listener: () => void): this; + once(event: "ready", listener: () => void): this; + once(event: "resume", listener: () => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; - prependListener(event: string, listener: (...args: any[]) => void): this; - prependListener(event: "open", listener: (fd: number) => void): this; prependListener(event: "close", listener: () => void): this; + prependListener(event: "data", listener: (chunk: Buffer | string) => void): this; + prependListener(event: "end", listener: () => void): this; + prependListener(event: "error", listener: (err: Error) => void): this; + prependListener(event: "open", listener: (fd: number) => void): this; + prependListener(event: "pause", listener: () => void): this; + prependListener(event: "readable", listener: () => void): this; + prependListener(event: "ready", listener: () => void): this; + prependListener(event: "resume", listener: () => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; - prependOnceListener(event: string, listener: (...args: any[]) => void): this; - prependOnceListener(event: "open", listener: (fd: number) => void): this; prependOnceListener(event: "close", listener: () => void): this; + prependOnceListener(event: "data", listener: (chunk: Buffer | string) => void): this; + prependOnceListener(event: "end", listener: () => void): this; + prependOnceListener(event: "error", listener: (err: Error) => void): this; + prependOnceListener(event: "open", listener: (fd: number) => void): this; + prependOnceListener(event: "pause", listener: () => void): this; + prependOnceListener(event: "readable", listener: () => void): this; + prependOnceListener(event: "ready", listener: () => void): this; + prependOnceListener(event: "resume", listener: () => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; } - class WriteStream extends stream.Writable { + export class WriteStream extends stream.Writable { close(): void; bytesWritten: number; path: string | Buffer; + pending: boolean; /** * events.EventEmitter * 1. open * 2. close + * 3. ready */ - addListener(event: string, listener: (...args: any[]) => void): this; - addListener(event: "open", listener: (fd: number) => void): this; addListener(event: "close", listener: () => void): this; + addListener(event: "drain", listener: () => void): this; + addListener(event: "error", listener: (err: Error) => void): this; + addListener(event: "finish", listener: () => void): this; + addListener(event: "open", listener: (fd: number) => void): this; + addListener(event: "pipe", listener: (src: stream.Readable) => void): this; + addListener(event: "ready", listener: () => void): this; + addListener(event: "unpipe", listener: (src: stream.Readable) => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; - on(event: string, listener: (...args: any[]) => void): this; - on(event: "open", listener: (fd: number) => void): this; on(event: "close", listener: () => void): this; + on(event: "drain", listener: () => void): this; + on(event: "error", listener: (err: Error) => void): this; + on(event: "finish", listener: () => void): this; + on(event: "open", listener: (fd: number) => void): this; + on(event: "pipe", listener: (src: stream.Readable) => void): this; + on(event: "ready", listener: () => void): this; + on(event: "unpipe", listener: (src: stream.Readable) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; - once(event: string, listener: (...args: any[]) => void): this; - once(event: "open", listener: (fd: number) => void): this; once(event: "close", listener: () => void): this; + once(event: "drain", listener: () => void): this; + once(event: "error", listener: (err: Error) => void): this; + once(event: "finish", listener: () => void): this; + once(event: "open", listener: (fd: number) => void): this; + once(event: "pipe", listener: (src: stream.Readable) => void): this; + once(event: "ready", listener: () => void): this; + once(event: "unpipe", listener: (src: stream.Readable) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; - prependListener(event: string, listener: (...args: any[]) => void): this; - prependListener(event: "open", listener: (fd: number) => void): this; prependListener(event: "close", listener: () => void): this; + prependListener(event: "drain", listener: () => void): this; + prependListener(event: "error", listener: (err: Error) => void): this; + prependListener(event: "finish", listener: () => void): this; + prependListener(event: "open", listener: (fd: number) => void): this; + prependListener(event: "pipe", listener: (src: stream.Readable) => void): this; + prependListener(event: "ready", listener: () => void): this; + prependListener(event: "unpipe", listener: (src: stream.Readable) => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; - prependOnceListener(event: string, listener: (...args: any[]) => void): this; - prependOnceListener(event: "open", listener: (fd: number) => void): this; prependOnceListener(event: "close", listener: () => void): this; + prependOnceListener(event: "drain", listener: () => void): this; + prependOnceListener(event: "error", listener: (err: Error) => void): this; + prependOnceListener(event: "finish", listener: () => void): this; + prependOnceListener(event: "open", listener: (fd: number) => void): this; + prependOnceListener(event: "pipe", listener: (src: stream.Readable) => void): this; + prependOnceListener(event: "ready", listener: () => void): this; + prependOnceListener(event: "unpipe", listener: (src: stream.Readable) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; } /** @@ -194,10 +280,10 @@ declare module "fs" { * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function rename(oldPath: PathLike, newPath: PathLike, callback: NoParamCallback): void; + export function rename(oldPath: PathLike, newPath: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace rename { + export namespace rename { /** * Asynchronous rename(2) - Change the name or location of a file or directory. * @param oldPath A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -215,24 +301,24 @@ declare module "fs" { * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function renameSync(oldPath: PathLike, newPath: PathLike): void; + export function renameSync(oldPath: PathLike, newPath: PathLike): void; /** * Asynchronous truncate(2) - Truncate a file to a specified length. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param len If not specified, defaults to `0`. */ - function truncate(path: PathLike, len: number | undefined | null, callback: NoParamCallback): void; + export function truncate(path: PathLike, len: number | undefined | null, callback: NoParamCallback): void; /** * Asynchronous truncate(2) - Truncate a file to a specified length. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function truncate(path: PathLike, callback: NoParamCallback): void; + export function truncate(path: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace truncate { + export namespace truncate { /** * Asynchronous truncate(2) - Truncate a file to a specified length. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -246,23 +332,23 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param len If not specified, defaults to `0`. */ - function truncateSync(path: PathLike, len?: number | null): void; + export function truncateSync(path: PathLike, len?: number | null): void; /** * Asynchronous ftruncate(2) - Truncate a file to a specified length. * @param fd A file descriptor. * @param len If not specified, defaults to `0`. */ - function ftruncate(fd: number, len: number | undefined | null, callback: NoParamCallback): void; + export function ftruncate(fd: number, len: number | undefined | null, callback: NoParamCallback): void; /** * Asynchronous ftruncate(2) - Truncate a file to a specified length. * @param fd A file descriptor. */ - function ftruncate(fd: number, callback: NoParamCallback): void; + export function ftruncate(fd: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace ftruncate { + export namespace ftruncate { /** * Asynchronous ftruncate(2) - Truncate a file to a specified length. * @param fd A file descriptor. @@ -276,16 +362,16 @@ declare module "fs" { * @param fd A file descriptor. * @param len If not specified, defaults to `0`. */ - function ftruncateSync(fd: number, len?: number | null): void; + export function ftruncateSync(fd: number, len?: number | null): void; /** * Asynchronous chown(2) - Change ownership of a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function chown(path: PathLike, uid: number, gid: number, callback: NoParamCallback): void; + export function chown(path: PathLike, uid: number, gid: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace chown { + export namespace chown { /** * Asynchronous chown(2) - Change ownership of a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -297,16 +383,16 @@ declare module "fs" { * Synchronous chown(2) - Change ownership of a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function chownSync(path: PathLike, uid: number, gid: number): void; + export function chownSync(path: PathLike, uid: number, gid: number): void; /** * Asynchronous fchown(2) - Change ownership of a file. * @param fd A file descriptor. */ - function fchown(fd: number, uid: number, gid: number, callback: NoParamCallback): void; + export function fchown(fd: number, uid: number, gid: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace fchown { + export namespace fchown { /** * Asynchronous fchown(2) - Change ownership of a file. * @param fd A file descriptor. @@ -318,16 +404,16 @@ declare module "fs" { * Synchronous fchown(2) - Change ownership of a file. * @param fd A file descriptor. */ - function fchownSync(fd: number, uid: number, gid: number): void; + export function fchownSync(fd: number, uid: number, gid: number): void; /** * Asynchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function lchown(path: PathLike, uid: number, gid: number, callback: NoParamCallback): void; + export function lchown(path: PathLike, uid: number, gid: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace lchown { + export namespace lchown { /** * Asynchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -339,23 +425,56 @@ declare module "fs" { * Synchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function lchownSync(path: PathLike, uid: number, gid: number): void; + export function lchownSync(path: PathLike, uid: number, gid: number): void; + + /** + * Changes the access and modification times of a file in the same way as `fs.utimes()`, + * with the difference that if the path refers to a symbolic link, then the link is not + * dereferenced: instead, the timestamps of the symbolic link itself are changed. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + export function lutimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date, callback: NoParamCallback): void; + + // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. + export namespace lutimes { + /** + * Changes the access and modification times of a file in the same way as `fsPromises.utimes()`, + * with the difference that if the path refers to a symbolic link, then the link is not + * dereferenced: instead, the timestamps of the symbolic link itself are changed. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + function __promisify__(path: PathLike, atime: string | number | Date, mtime: string | number | Date): Promise; + } + + /** + * Change the file system timestamps of the symbolic link referenced by `path`. Returns `undefined`, + * or throws an exception when parameters are incorrect or the operation fails. + * This is the synchronous version of `fs.lutimes()`. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + export function lutimesSync(path: PathLike, atime: string | number | Date, mtime: string | number | Date): void; /** * Asynchronous chmod(2) - Change permissions of a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function chmod(path: PathLike, mode: string | number, callback: NoParamCallback): void; + export function chmod(path: PathLike, mode: Mode, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace chmod { + export namespace chmod { /** * Asynchronous chmod(2) - Change permissions of a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function __promisify__(path: PathLike, mode: string | number): Promise; + function __promisify__(path: PathLike, mode: Mode): Promise; } /** @@ -363,23 +482,23 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function chmodSync(path: PathLike, mode: string | number): void; + export function chmodSync(path: PathLike, mode: Mode): void; /** * Asynchronous fchmod(2) - Change permissions of a file. * @param fd A file descriptor. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function fchmod(fd: number, mode: string | number, callback: NoParamCallback): void; + export function fchmod(fd: number, mode: Mode, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace fchmod { + export namespace fchmod { /** * Asynchronous fchmod(2) - Change permissions of a file. * @param fd A file descriptor. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function __promisify__(fd: number, mode: string | number): Promise; + function __promisify__(fd: number, mode: Mode): Promise; } /** @@ -387,23 +506,23 @@ declare module "fs" { * @param fd A file descriptor. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function fchmodSync(fd: number, mode: string | number): void; + export function fchmodSync(fd: number, mode: Mode): void; /** * Asynchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function lchmod(path: PathLike, mode: string | number, callback: NoParamCallback): void; + export function lchmod(path: PathLike, mode: Mode, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace lchmod { + export namespace lchmod { /** * Asynchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function __promisify__(path: PathLike, mode: string | number): Promise; + function __promisify__(path: PathLike, mode: Mode): Promise; } /** @@ -411,20 +530,24 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ - function lchmodSync(path: PathLike, mode: string | number): void; + export function lchmodSync(path: PathLike, mode: Mode): void; /** * Asynchronous stat(2) - Get file status. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function stat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; + export function stat(path: PathLike, options: BigIntOptions, callback: (err: NodeJS.ErrnoException | null, stats: BigIntStats) => void): void; + export function stat(path: PathLike, options: StatOptions, callback: (err: NodeJS.ErrnoException | null, stats: Stats | BigIntStats) => void): void; + export function stat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace stat { + export namespace stat { /** * Asynchronous stat(2) - Get file status. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ + function __promisify__(path: PathLike, options: BigIntOptions): Promise; + function __promisify__(path: PathLike, options: StatOptions): Promise; function __promisify__(path: PathLike): Promise; } @@ -432,16 +555,18 @@ declare module "fs" { * Synchronous stat(2) - Get file status. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function statSync(path: PathLike): Stats; + export function statSync(path: PathLike, options: BigIntOptions): BigIntStats; + export function statSync(path: PathLike, options: StatOptions): Stats | BigIntStats; + export function statSync(path: PathLike): Stats; /** * Asynchronous fstat(2) - Get file status. * @param fd A file descriptor. */ - function fstat(fd: number, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; + export function fstat(fd: number, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace fstat { + export namespace fstat { /** * Asynchronous fstat(2) - Get file status. * @param fd A file descriptor. @@ -453,16 +578,16 @@ declare module "fs" { * Synchronous fstat(2) - Get file status. * @param fd A file descriptor. */ - function fstatSync(fd: number): Stats; + export function fstatSync(fd: number): Stats; /** * Asynchronous lstat(2) - Get file status. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function lstat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; + export function lstat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace lstat { + export namespace lstat { /** * Asynchronous lstat(2) - Get file status. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -474,17 +599,17 @@ declare module "fs" { * Synchronous lstat(2) - Get file status. Does not dereference symbolic links. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function lstatSync(path: PathLike): Stats; + export function lstatSync(path: PathLike): Stats; /** * Asynchronous link(2) - Create a new link (also known as a hard link) to an existing file. * @param existingPath A path to a file. If a URL is provided, it must use the `file:` protocol. * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function link(existingPath: PathLike, newPath: PathLike, callback: NoParamCallback): void; + export function link(existingPath: PathLike, newPath: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace link { + export namespace link { /** * Asynchronous link(2) - Create a new link (also known as a hard link) to an existing file. * @param existingPath A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -498,7 +623,7 @@ declare module "fs" { * @param existingPath A path to a file. If a URL is provided, it must use the `file:` protocol. * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function linkSync(existingPath: PathLike, newPath: PathLike): void; + export function linkSync(existingPath: PathLike, newPath: PathLike): void; /** * Asynchronous symlink(2) - Create a new symbolic link to an existing file. @@ -507,17 +632,17 @@ declare module "fs" { * @param type May be set to `'dir'`, `'file'`, or `'junction'` (default is `'file'`) and is only available on Windows (ignored on other platforms). * When using `'junction'`, the `target` argument will automatically be normalized to an absolute path. */ - function symlink(target: PathLike, path: PathLike, type: symlink.Type | undefined | null, callback: NoParamCallback): void; + export function symlink(target: PathLike, path: PathLike, type: symlink.Type | undefined | null, callback: NoParamCallback): void; /** * Asynchronous symlink(2) - Create a new symbolic link to an existing file. * @param target A path to an existing file. If a URL is provided, it must use the `file:` protocol. * @param path A path to the new symlink. If a URL is provided, it must use the `file:` protocol. */ - function symlink(target: PathLike, path: PathLike, callback: NoParamCallback): void; + export function symlink(target: PathLike, path: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace symlink { + export namespace symlink { /** * Asynchronous symlink(2) - Create a new symbolic link to an existing file. * @param target A path to an existing file. If a URL is provided, it must use the `file:` protocol. @@ -537,16 +662,16 @@ declare module "fs" { * @param type May be set to `'dir'`, `'file'`, or `'junction'` (default is `'file'`) and is only available on Windows (ignored on other platforms). * When using `'junction'`, the `target` argument will automatically be normalized to an absolute path. */ - function symlinkSync(target: PathLike, path: PathLike, type?: symlink.Type | null): void; + export function symlinkSync(target: PathLike, path: PathLike, type?: symlink.Type | null): void; /** * Asynchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readlink( + export function readlink( path: PathLike, - options: { encoding?: BufferEncoding | null } | BufferEncoding | undefined | null, + options: BaseEncodingOptions | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, linkString: string) => void ): void; @@ -555,43 +680,43 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readlink(path: PathLike, options: { encoding: "buffer" } | "buffer", callback: (err: NodeJS.ErrnoException | null, linkString: Buffer) => void): void; + export function readlink(path: PathLike, options: BufferEncodingOption, callback: (err: NodeJS.ErrnoException | null, linkString: Buffer) => void): void; /** * Asynchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readlink(path: PathLike, options: { encoding?: string | null } | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, linkString: string | Buffer) => void): void; + export function readlink(path: PathLike, options: BaseEncodingOptions | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, linkString: string | Buffer) => void): void; /** * Asynchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function readlink(path: PathLike, callback: (err: NodeJS.ErrnoException | null, linkString: string) => void): void; + export function readlink(path: PathLike, callback: (err: NodeJS.ErrnoException | null, linkString: string) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace readlink { + export namespace readlink { /** * Asynchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): Promise; + function __promisify__(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): Promise; /** * Asynchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options: { encoding: "buffer" } | "buffer"): Promise; + function __promisify__(path: PathLike, options: BufferEncodingOption): Promise; /** * Asynchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options?: { encoding?: string | null } | string | null): Promise; + function __promisify__(path: PathLike, options?: BaseEncodingOptions | string | null): Promise; } /** @@ -599,30 +724,30 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readlinkSync(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): string; + export function readlinkSync(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): string; /** * Synchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readlinkSync(path: PathLike, options: { encoding: "buffer" } | "buffer"): Buffer; + export function readlinkSync(path: PathLike, options: BufferEncodingOption): Buffer; /** * Synchronous readlink(2) - read value of a symbolic link. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readlinkSync(path: PathLike, options?: { encoding?: string | null } | string | null): string | Buffer; + export function readlinkSync(path: PathLike, options?: BaseEncodingOptions | string | null): string | Buffer; /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function realpath( + export function realpath( path: PathLike, - options: { encoding?: BufferEncoding | null } | BufferEncoding | undefined | null, + options: BaseEncodingOptions | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void ): void; @@ -631,51 +756,51 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function realpath(path: PathLike, options: { encoding: "buffer" } | "buffer", callback: (err: NodeJS.ErrnoException | null, resolvedPath: Buffer) => void): void; + export function realpath(path: PathLike, options: BufferEncodingOption, callback: (err: NodeJS.ErrnoException | null, resolvedPath: Buffer) => void): void; /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function realpath(path: PathLike, options: { encoding?: string | null } | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string | Buffer) => void): void; + export function realpath(path: PathLike, options: BaseEncodingOptions | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string | Buffer) => void): void; /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function realpath(path: PathLike, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void): void; + export function realpath(path: PathLike, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace realpath { + export namespace realpath { /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): Promise; + function __promisify__(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): Promise; /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options: { encoding: "buffer" } | "buffer"): Promise; + function __promisify__(path: PathLike, options: BufferEncodingOption): Promise; /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options?: { encoding?: string | null } | string | null): Promise; + function __promisify__(path: PathLike, options?: BaseEncodingOptions | string | null): Promise; function native( path: PathLike, - options: { encoding?: BufferEncoding | null } | BufferEncoding | undefined | null, + options: BaseEncodingOptions | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void ): void; - function native(path: PathLike, options: { encoding: "buffer" } | "buffer", callback: (err: NodeJS.ErrnoException | null, resolvedPath: Buffer) => void): void; - function native(path: PathLike, options: { encoding?: string | null } | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string | Buffer) => void): void; + function native(path: PathLike, options: BufferEncodingOption, callback: (err: NodeJS.ErrnoException | null, resolvedPath: Buffer) => void): void; + function native(path: PathLike, options: BaseEncodingOptions | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string | Buffer) => void): void; function native(path: PathLike, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void): void; } @@ -684,36 +809,36 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function realpathSync(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): string; + export function realpathSync(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): string; /** * Synchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function realpathSync(path: PathLike, options: { encoding: "buffer" } | "buffer"): Buffer; + export function realpathSync(path: PathLike, options: BufferEncodingOption): Buffer; /** * Synchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function realpathSync(path: PathLike, options?: { encoding?: string | null } | string | null): string | Buffer; + export function realpathSync(path: PathLike, options?: BaseEncodingOptions | string | null): string | Buffer; - namespace realpathSync { - function native(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): string; - function native(path: PathLike, options: { encoding: "buffer" } | "buffer"): Buffer; - function native(path: PathLike, options?: { encoding?: string | null } | string | null): string | Buffer; + export namespace realpathSync { + function native(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): string; + function native(path: PathLike, options: BufferEncodingOption): Buffer; + function native(path: PathLike, options?: BaseEncodingOptions | string | null): string | Buffer; } /** * Asynchronous unlink(2) - delete a name and possibly the file it refers to. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function unlink(path: PathLike, callback: NoParamCallback): void; + export function unlink(path: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace unlink { + export namespace unlink { /** * Asynchronous unlink(2) - delete a name and possibly the file it refers to. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -725,71 +850,121 @@ declare module "fs" { * Synchronous unlink(2) - delete a name and possibly the file it refers to. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function unlinkSync(path: PathLike): void; + export function unlinkSync(path: PathLike): void; - interface RmDirOptions { + export interface RmDirOptions { /** + * If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or + * `EPERM` error is encountered, Node.js will retry the operation with a linear + * backoff wait of `retryDelay` ms longer on each try. This option represents the + * number of retries. This option is ignored if the `recursive` option is not + * `true`. + * @default 0 + */ + maxRetries?: number; + /** + * @deprecated since v14.14.0 In future versions of Node.js, + * `fs.rmdir(path, { recursive: true })` will throw on nonexistent + * paths, or when given a file as a target. + * Use `fs.rm(path, { recursive: true, force: true })` instead. + * * If `true`, perform a recursive directory removal. In * recursive mode, errors are not reported if `path` does not exist, and * operations are retried on failure. - * @experimental * @default false */ recursive?: boolean; - } - - interface RmDirAsyncOptions extends RmDirOptions { /** - * If an `EMFILE` error is encountered, Node.js will - * retry the operation with a linear backoff of 1ms longer on each try until the - * timeout duration passes this limit. This option is ignored if the `recursive` - * option is not `true`. - * @default 1000 + * The amount of time in milliseconds to wait between retries. + * This option is ignored if the `recursive` option is not `true`. + * @default 100 */ - emfileWait?: number; - /** - * If an `EBUSY`, `ENOTEMPTY`, or `EPERM` error is - * encountered, Node.js will retry the operation with a linear backoff wait of - * 100ms longer on each try. This option represents the number of retries. This - * option is ignored if the `recursive` option is not `true`. - * @default 3 - */ - maxBusyTries?: number; + retryDelay?: number; } /** * Asynchronous rmdir(2) - delete a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function rmdir(path: PathLike, callback: NoParamCallback): void; - function rmdir(path: PathLike, options: RmDirAsyncOptions, callback: NoParamCallback): void; + export function rmdir(path: PathLike, callback: NoParamCallback): void; + export function rmdir(path: PathLike, options: RmDirOptions, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace rmdir { + export namespace rmdir { /** * Asynchronous rmdir(2) - delete a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function __promisify__(path: PathLike, options?: RmDirAsyncOptions): Promise; + function __promisify__(path: PathLike, options?: RmDirOptions): Promise; } /** * Synchronous rmdir(2) - delete a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function rmdirSync(path: PathLike, options?: RmDirOptions): void; + export function rmdirSync(path: PathLike, options?: RmDirOptions): void; - interface MakeDirectoryOptions { + export interface RmOptions { + /** + * When `true`, exceptions will be ignored if `path` does not exist. + * @default false + */ + force?: boolean; + /** + * If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or + * `EPERM` error is encountered, Node.js will retry the operation with a linear + * backoff wait of `retryDelay` ms longer on each try. This option represents the + * number of retries. This option is ignored if the `recursive` option is not + * `true`. + * @default 0 + */ + maxRetries?: number; + /** + * If `true`, perform a recursive directory removal. In + * recursive mode, errors are not reported if `path` does not exist, and + * operations are retried on failure. + * @default false + */ + recursive?: boolean; + /** + * The amount of time in milliseconds to wait between retries. + * This option is ignored if the `recursive` option is not `true`. + * @default 100 + */ + retryDelay?: number; + } + + /** + * Asynchronously removes files and directories (modeled on the standard POSIX `rm` utility). + */ + export function rm(path: PathLike, callback: NoParamCallback): void; + export function rm(path: PathLike, options: RmOptions, callback: NoParamCallback): void; + + // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. + export namespace rm { + /** + * Asynchronously removes files and directories (modeled on the standard POSIX `rm` utility). + */ + function __promisify__(path: PathLike, options?: RmOptions): Promise; + } + + /** + * Synchronously removes files and directories (modeled on the standard POSIX `rm` utility). + */ + export function rmSync(path: PathLike, options?: RmOptions): void; + + export interface MakeDirectoryOptions { /** * Indicates whether parent folders should be created. + * If a folder was created, the path to the first created folder will be returned. * @default false */ recursive?: boolean; /** * A file mode. If a string is passed, it is parsed as an octal integer. If not specified - * @default 0o777. + * @default 0o777 */ - mode?: number; + mode?: Mode; } /** @@ -798,23 +973,55 @@ declare module "fs" { * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. */ - function mkdir(path: PathLike, options: number | string | MakeDirectoryOptions | undefined | null, callback: NoParamCallback): void; + export function mkdir(path: PathLike, options: MakeDirectoryOptions & { recursive: true }, callback: (err: NodeJS.ErrnoException | null, path: string) => void): void; + + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + export function mkdir(path: PathLike, options: Mode | (MakeDirectoryOptions & { recursive?: false; }) | null | undefined, callback: NoParamCallback): void; + + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + export function mkdir(path: PathLike, options: Mode | MakeDirectoryOptions | null | undefined, callback: (err: NodeJS.ErrnoException | null, path: string | undefined) => void): void; /** * Asynchronous mkdir(2) - create a directory with a mode of `0o777`. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function mkdir(path: PathLike, callback: NoParamCallback): void; + export function mkdir(path: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace mkdir { + export namespace mkdir { /** * Asynchronous mkdir(2) - create a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. */ - function __promisify__(path: PathLike, options?: number | string | MakeDirectoryOptions | null): Promise; + function __promisify__(path: PathLike, options: MakeDirectoryOptions & { recursive: true; }): Promise; + + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + function __promisify__(path: PathLike, options?: Mode | (MakeDirectoryOptions & { recursive?: false; }) | null): Promise; + + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + function __promisify__(path: PathLike, options?: Mode | MakeDirectoryOptions | null): Promise; } /** @@ -823,57 +1030,73 @@ declare module "fs" { * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. */ - function mkdirSync(path: PathLike, options?: number | string | MakeDirectoryOptions | null): void; + export function mkdirSync(path: PathLike, options: MakeDirectoryOptions & { recursive: true; }): string; + + /** + * Synchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + export function mkdirSync(path: PathLike, options?: Mode | (MakeDirectoryOptions & { recursive?: false; }) | null): void; + + /** + * Synchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + export function mkdirSync(path: PathLike, options?: Mode | MakeDirectoryOptions | null): string | undefined; /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function mkdtemp(prefix: string, options: { encoding?: BufferEncoding | null } | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, folder: string) => void): void; + export function mkdtemp(prefix: string, options: BaseEncodingOptions | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, folder: string) => void): void; /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function mkdtemp(prefix: string, options: "buffer" | { encoding: "buffer" }, callback: (err: NodeJS.ErrnoException | null, folder: Buffer) => void): void; + export function mkdtemp(prefix: string, options: "buffer" | { encoding: "buffer" }, callback: (err: NodeJS.ErrnoException | null, folder: Buffer) => void): void; /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function mkdtemp(prefix: string, options: { encoding?: string | null } | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, folder: string | Buffer) => void): void; + export function mkdtemp(prefix: string, options: BaseEncodingOptions | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, folder: string | Buffer) => void): void; /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. */ - function mkdtemp(prefix: string, callback: (err: NodeJS.ErrnoException | null, folder: string) => void): void; + export function mkdtemp(prefix: string, callback: (err: NodeJS.ErrnoException | null, folder: string) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace mkdtemp { + export namespace mkdtemp { /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(prefix: string, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): Promise; + function __promisify__(prefix: string, options?: BaseEncodingOptions | BufferEncoding | null): Promise; /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(prefix: string, options: { encoding: "buffer" } | "buffer"): Promise; + function __promisify__(prefix: string, options: BufferEncodingOption): Promise; /** * Asynchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(prefix: string, options?: { encoding?: string | null } | string | null): Promise; + function __promisify__(prefix: string, options?: BaseEncodingOptions | string | null): Promise; } /** @@ -881,28 +1104,28 @@ declare module "fs" { * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function mkdtempSync(prefix: string, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): string; + export function mkdtempSync(prefix: string, options?: BaseEncodingOptions | BufferEncoding | null): string; /** * Synchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function mkdtempSync(prefix: string, options: { encoding: "buffer" } | "buffer"): Buffer; + export function mkdtempSync(prefix: string, options: BufferEncodingOption): Buffer; /** * Synchronously creates a unique temporary directory. * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function mkdtempSync(prefix: string, options?: { encoding?: string | null } | string | null): string | Buffer; + export function mkdtempSync(prefix: string, options?: BaseEncodingOptions | string | null): string | Buffer; /** * Asynchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readdir( + export function readdir( path: PathLike, options: { encoding: BufferEncoding | null; withFileTypes?: false } | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, files: string[]) => void, @@ -913,16 +1136,16 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readdir(path: PathLike, options: { encoding: "buffer"; withFileTypes?: false } | "buffer", callback: (err: NodeJS.ErrnoException | null, files: Buffer[]) => void): void; + export function readdir(path: PathLike, options: { encoding: "buffer"; withFileTypes?: false } | "buffer", callback: (err: NodeJS.ErrnoException | null, files: Buffer[]) => void): void; /** * Asynchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readdir( + export function readdir( path: PathLike, - options: { encoding?: string | null; withFileTypes?: false } | string | undefined | null, + options: BaseEncodingOptions & { withFileTypes?: false } | BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, files: string[] | Buffer[]) => void, ): void; @@ -930,17 +1153,17 @@ declare module "fs" { * Asynchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function readdir(path: PathLike, callback: (err: NodeJS.ErrnoException | null, files: string[]) => void): void; + export function readdir(path: PathLike, callback: (err: NodeJS.ErrnoException | null, files: string[]) => void): void; /** * Asynchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options If called with `withFileTypes: true` the result data will be an array of Dirent. */ - function readdir(path: PathLike, options: { encoding?: string | null; withFileTypes: true }, callback: (err: NodeJS.ErrnoException | null, files: Dirent[]) => void): void; + export function readdir(path: PathLike, options: BaseEncodingOptions & { withFileTypes: true }, callback: (err: NodeJS.ErrnoException | null, files: Dirent[]) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace readdir { + export namespace readdir { /** * Asynchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -960,14 +1183,14 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function __promisify__(path: PathLike, options?: { encoding?: string | null; withFileTypes?: false } | string | null): Promise; + function __promisify__(path: PathLike, options?: BaseEncodingOptions & { withFileTypes?: false } | BufferEncoding | null): Promise; /** * Asynchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options If called with `withFileTypes: true` the result data will be an array of Dirent */ - function __promisify__(path: PathLike, options: { encoding?: string | null; withFileTypes: true }): Promise; + function __promisify__(path: PathLike, options: BaseEncodingOptions & { withFileTypes: true }): Promise; } /** @@ -975,37 +1198,37 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readdirSync(path: PathLike, options?: { encoding: BufferEncoding | null; withFileTypes?: false } | BufferEncoding | null): string[]; + export function readdirSync(path: PathLike, options?: { encoding: BufferEncoding | null; withFileTypes?: false } | BufferEncoding | null): string[]; /** * Synchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readdirSync(path: PathLike, options: { encoding: "buffer"; withFileTypes?: false } | "buffer"): Buffer[]; + export function readdirSync(path: PathLike, options: { encoding: "buffer"; withFileTypes?: false } | "buffer"): Buffer[]; /** * Synchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. */ - function readdirSync(path: PathLike, options?: { encoding?: string | null; withFileTypes?: false } | string | null): string[] | Buffer[]; + export function readdirSync(path: PathLike, options?: BaseEncodingOptions & { withFileTypes?: false } | BufferEncoding | null): string[] | Buffer[]; /** * Synchronous readdir(3) - read a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options If called with `withFileTypes: true` the result data will be an array of Dirent. */ - function readdirSync(path: PathLike, options: { encoding?: string | null; withFileTypes: true }): Dirent[]; + export function readdirSync(path: PathLike, options: BaseEncodingOptions & { withFileTypes: true }): Dirent[]; /** * Asynchronous close(2) - close a file descriptor. * @param fd A file descriptor. */ - function close(fd: number, callback: NoParamCallback): void; + export function close(fd: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace close { + export namespace close { /** * Asynchronous close(2) - close a file descriptor. * @param fd A file descriptor. @@ -1017,29 +1240,29 @@ declare module "fs" { * Synchronous close(2) - close a file descriptor. * @param fd A file descriptor. */ - function closeSync(fd: number): void; + export function closeSync(fd: number): void; /** * Asynchronous open(2) - open and possibly create a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. If not supplied, defaults to `0o666`. */ - function open(path: PathLike, flags: string | number, mode: string | number | undefined | null, callback: (err: NodeJS.ErrnoException | null, fd: number) => void): void; + export function open(path: PathLike, flags: OpenMode, mode: Mode | undefined | null, callback: (err: NodeJS.ErrnoException | null, fd: number) => void): void; /** * Asynchronous open(2) - open and possibly create a file. If the file is created, its mode will be `0o666`. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. */ - function open(path: PathLike, flags: string | number, callback: (err: NodeJS.ErrnoException | null, fd: number) => void): void; + export function open(path: PathLike, flags: OpenMode, callback: (err: NodeJS.ErrnoException | null, fd: number) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace open { + export namespace open { /** * Asynchronous open(2) - open and possibly create a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. If not supplied, defaults to `0o666`. */ - function __promisify__(path: PathLike, flags: string | number, mode?: string | number | null): Promise; + function __promisify__(path: PathLike, flags: OpenMode, mode?: Mode | null): Promise; } /** @@ -1047,7 +1270,7 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. If not supplied, defaults to `0o666`. */ - function openSync(path: PathLike, flags: string | number, mode?: string | number | null): number; + export function openSync(path: PathLike, flags: OpenMode, mode?: Mode | null): number; /** * Asynchronously change file timestamps of the file referenced by the supplied path. @@ -1055,10 +1278,10 @@ declare module "fs" { * @param atime The last access time. If a string is provided, it will be coerced to number. * @param mtime The last modified time. If a string is provided, it will be coerced to number. */ - function utimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date, callback: NoParamCallback): void; + export function utimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace utimes { + export namespace utimes { /** * Asynchronously change file timestamps of the file referenced by the supplied path. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -1074,7 +1297,7 @@ declare module "fs" { * @param atime The last access time. If a string is provided, it will be coerced to number. * @param mtime The last modified time. If a string is provided, it will be coerced to number. */ - function utimesSync(path: PathLike, atime: string | number | Date, mtime: string | number | Date): void; + export function utimesSync(path: PathLike, atime: string | number | Date, mtime: string | number | Date): void; /** * Asynchronously change file timestamps of the file referenced by the supplied file descriptor. @@ -1082,10 +1305,10 @@ declare module "fs" { * @param atime The last access time. If a string is provided, it will be coerced to number. * @param mtime The last modified time. If a string is provided, it will be coerced to number. */ - function futimes(fd: number, atime: string | number | Date, mtime: string | number | Date, callback: NoParamCallback): void; + export function futimes(fd: number, atime: string | number | Date, mtime: string | number | Date, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace futimes { + export namespace futimes { /** * Asynchronously change file timestamps of the file referenced by the supplied file descriptor. * @param fd A file descriptor. @@ -1101,16 +1324,16 @@ declare module "fs" { * @param atime The last access time. If a string is provided, it will be coerced to number. * @param mtime The last modified time. If a string is provided, it will be coerced to number. */ - function futimesSync(fd: number, atime: string | number | Date, mtime: string | number | Date): void; + export function futimesSync(fd: number, atime: string | number | Date, mtime: string | number | Date): void; /** * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. * @param fd A file descriptor. */ - function fsync(fd: number, callback: NoParamCallback): void; + export function fsync(fd: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace fsync { + export namespace fsync { /** * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. * @param fd A file descriptor. @@ -1122,7 +1345,7 @@ declare module "fs" { * Synchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. * @param fd A file descriptor. */ - function fsyncSync(fd: number): void; + export function fsyncSync(fd: number): void; /** * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor. @@ -1131,7 +1354,7 @@ declare module "fs" { * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. */ - function write( + export function write( fd: number, buffer: TBuffer, offset: number | undefined | null, @@ -1146,7 +1369,7 @@ declare module "fs" { * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. */ - function write( + export function write( fd: number, buffer: TBuffer, offset: number | undefined | null, @@ -1159,7 +1382,7 @@ declare module "fs" { * @param fd A file descriptor. * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. */ - function write( + export function write( fd: number, buffer: TBuffer, offset: number | undefined | null, @@ -1170,40 +1393,40 @@ declare module "fs" { * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor. * @param fd A file descriptor. */ - function write(fd: number, buffer: TBuffer, callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void): void; + export function write(fd: number, buffer: TBuffer, callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void): void; /** * Asynchronously writes `string` to the file referenced by the supplied file descriptor. * @param fd A file descriptor. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. + * @param string A string to write. * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. * @param encoding The expected string encoding. */ - function write( + export function write( fd: number, - string: any, + string: string, position: number | undefined | null, - encoding: string | undefined | null, + encoding: BufferEncoding | undefined | null, callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void, ): void; /** * Asynchronously writes `string` to the file referenced by the supplied file descriptor. * @param fd A file descriptor. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. + * @param string A string to write. * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. */ - function write(fd: number, string: any, position: number | undefined | null, callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void): void; + export function write(fd: number, string: string, position: number | undefined | null, callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void): void; /** * Asynchronously writes `string` to the file referenced by the supplied file descriptor. * @param fd A file descriptor. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. + * @param string A string to write. */ - function write(fd: number, string: any, callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void): void; + export function write(fd: number, string: string, callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace write { + export namespace write { /** * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor. * @param fd A file descriptor. @@ -1222,11 +1445,11 @@ declare module "fs" { /** * Asynchronously writes `string` to the file referenced by the supplied file descriptor. * @param fd A file descriptor. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. + * @param string A string to write. * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. * @param encoding The expected string encoding. */ - function __promisify__(fd: number, string: any, position?: number | null, encoding?: string | null): Promise<{ bytesWritten: number, buffer: string }>; + function __promisify__(fd: number, string: string, position?: number | null, encoding?: BufferEncoding | null): Promise<{ bytesWritten: number, buffer: string }>; } /** @@ -1236,16 +1459,16 @@ declare module "fs" { * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. */ - function writeSync(fd: number, buffer: NodeJS.ArrayBufferView, offset?: number | null, length?: number | null, position?: number | null): number; + export function writeSync(fd: number, buffer: NodeJS.ArrayBufferView, offset?: number | null, length?: number | null, position?: number | null): number; /** * Synchronously writes `string` to the file referenced by the supplied file descriptor, returning the number of bytes written. * @param fd A file descriptor. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. + * @param string A string to write. * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. * @param encoding The expected string encoding. */ - function writeSync(fd: number, string: any, position?: number | null, encoding?: string | null): number; + export function writeSync(fd: number, string: string, position?: number | null, encoding?: BufferEncoding | null): number; /** * Asynchronously reads data from the file referenced by the supplied file descriptor. @@ -1255,7 +1478,7 @@ declare module "fs" { * @param length The number of bytes to read. * @param position The offset from the beginning of the file from which data should be read. If `null`, data will be read from the current position. */ - function read( + export function read( fd: number, buffer: TBuffer, offset: number, @@ -1265,7 +1488,7 @@ declare module "fs" { ): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace read { + export namespace read { /** * @param fd A file descriptor. * @param buffer The buffer that the data will be written to. @@ -1282,6 +1505,21 @@ declare module "fs" { ): Promise<{ bytesRead: number, buffer: TBuffer }>; } + export interface ReadSyncOptions { + /** + * @default 0 + */ + offset?: number; + /** + * @default `length of buffer` + */ + length?: number; + /** + * @default null + */ + position?: number | null; + } + /** * Synchronously reads data from the file referenced by the supplied file descriptor, returning the number of bytes read. * @param fd A file descriptor. @@ -1290,7 +1528,13 @@ declare module "fs" { * @param length The number of bytes to read. * @param position The offset from the beginning of the file from which data should be read. If `null`, data will be read from the current position. */ - function readSync(fd: number, buffer: NodeJS.ArrayBufferView, offset: number, length: number, position: number | null): number; + export function readSync(fd: number, buffer: NodeJS.ArrayBufferView, offset: number, length: number, position: number | null): number; + + /** + * Similar to the above `fs.readSync` function, this version takes an optional `options` object. + * If no `options` object is specified, it will default with the above values. + */ + export function readSync(fd: number, buffer: NodeJS.ArrayBufferView, opts?: ReadSyncOptions): number; /** * Asynchronously reads the entire contents of a file. @@ -1299,7 +1543,7 @@ declare module "fs" { * @param options An object that may contain an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function readFile(path: PathLike | number, options: { encoding?: null; flag?: string; } | undefined | null, callback: (err: NodeJS.ErrnoException | null, data: Buffer) => void): void; + export function readFile(path: PathLike | number, options: { encoding?: null; flag?: string; } | undefined | null, callback: (err: NodeJS.ErrnoException | null, data: Buffer) => void): void; /** * Asynchronously reads the entire contents of a file. @@ -1309,7 +1553,7 @@ declare module "fs" { * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function readFile(path: PathLike | number, options: { encoding: string; flag?: string; } | string, callback: (err: NodeJS.ErrnoException | null, data: string) => void): void; + export function readFile(path: PathLike | number, options: { encoding: BufferEncoding; flag?: string; } | string, callback: (err: NodeJS.ErrnoException | null, data: string) => void): void; /** * Asynchronously reads the entire contents of a file. @@ -1319,9 +1563,9 @@ declare module "fs" { * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function readFile( + export function readFile( path: PathLike | number, - options: { encoding?: string | null; flag?: string; } | string | undefined | null, + options: BaseEncodingOptions & { flag?: string; } | string | undefined | null, callback: (err: NodeJS.ErrnoException | null, data: string | Buffer) => void, ): void; @@ -1330,10 +1574,10 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * If a file descriptor is provided, the underlying file will _not_ be closed automatically. */ - function readFile(path: PathLike | number, callback: (err: NodeJS.ErrnoException | null, data: Buffer) => void): void; + export function readFile(path: PathLike | number, callback: (err: NodeJS.ErrnoException | null, data: Buffer) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace readFile { + export namespace readFile { /** * Asynchronously reads the entire contents of a file. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -1351,7 +1595,7 @@ declare module "fs" { * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function __promisify__(path: PathLike | number, options: { encoding: string; flag?: string; } | string): Promise; + function __promisify__(path: PathLike | number, options: { encoding: BufferEncoding; flag?: string; } | string): Promise; /** * Asynchronously reads the entire contents of a file. @@ -1361,7 +1605,7 @@ declare module "fs" { * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function __promisify__(path: PathLike | number, options?: { encoding?: string | null; flag?: string; } | string | null): Promise; + function __promisify__(path: PathLike | number, options?: BaseEncodingOptions & { flag?: string; } | string | null): Promise; } /** @@ -1371,7 +1615,7 @@ declare module "fs" { * If a file descriptor is provided, the underlying file will _not_ be closed automatically. * @param options An object that may contain an optional flag. If a flag is not provided, it defaults to `'r'`. */ - function readFileSync(path: PathLike | number, options?: { encoding?: null; flag?: string; } | null): Buffer; + export function readFileSync(path: PathLike | number, options?: { encoding?: null; flag?: string; } | null): Buffer; /** * Synchronously reads the entire contents of a file. @@ -1381,7 +1625,7 @@ declare module "fs" { * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function readFileSync(path: PathLike | number, options: { encoding: string; flag?: string; } | string): string; + export function readFileSync(path: PathLike | number, options: { encoding: BufferEncoding; flag?: string; } | BufferEncoding): string; /** * Synchronously reads the entire contents of a file. @@ -1391,9 +1635,9 @@ declare module "fs" { * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. * If a flag is not provided, it defaults to `'r'`. */ - function readFileSync(path: PathLike | number, options?: { encoding?: string | null; flag?: string; } | string | null): string | Buffer; + export function readFileSync(path: PathLike | number, options?: BaseEncodingOptions & { flag?: string; } | BufferEncoding | null): string | Buffer; - type WriteFileOptions = { encoding?: string | null; mode?: number | string; flag?: string; } | string | null; + export type WriteFileOptions = BaseEncodingOptions & { mode?: Mode; flag?: string; } | string | null; /** * Asynchronously writes data to a file, replacing the file if it already exists. @@ -1407,7 +1651,7 @@ declare module "fs" { * If `mode` is a string, it is parsed as an octal integer. * If `flag` is not supplied, the default of `'w'` is used. */ - function writeFile(path: PathLike | number, data: any, options: WriteFileOptions, callback: NoParamCallback): void; + export function writeFile(path: PathLike | number, data: string | NodeJS.ArrayBufferView, options: WriteFileOptions, callback: NoParamCallback): void; /** * Asynchronously writes data to a file, replacing the file if it already exists. @@ -1416,10 +1660,10 @@ declare module "fs" { * If a file descriptor is provided, the underlying file will _not_ be closed automatically. * @param data The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string. */ - function writeFile(path: PathLike | number, data: any, callback: NoParamCallback): void; + export function writeFile(path: PathLike | number, data: string | NodeJS.ArrayBufferView, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace writeFile { + export namespace writeFile { /** * Asynchronously writes data to a file, replacing the file if it already exists. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -1432,7 +1676,7 @@ declare module "fs" { * If `mode` is a string, it is parsed as an octal integer. * If `flag` is not supplied, the default of `'w'` is used. */ - function __promisify__(path: PathLike | number, data: any, options?: WriteFileOptions): Promise; + function __promisify__(path: PathLike | number, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions): Promise; } /** @@ -1447,7 +1691,7 @@ declare module "fs" { * If `mode` is a string, it is parsed as an octal integer. * If `flag` is not supplied, the default of `'w'` is used. */ - function writeFileSync(path: PathLike | number, data: any, options?: WriteFileOptions): void; + export function writeFileSync(path: PathLike | number, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions): void; /** * Asynchronously append data to a file, creating the file if it does not exist. @@ -1461,7 +1705,7 @@ declare module "fs" { * If `mode` is a string, it is parsed as an octal integer. * If `flag` is not supplied, the default of `'a'` is used. */ - function appendFile(file: PathLike | number, data: any, options: WriteFileOptions, callback: NoParamCallback): void; + export function appendFile(file: PathLike | number, data: string | Uint8Array, options: WriteFileOptions, callback: NoParamCallback): void; /** * Asynchronously append data to a file, creating the file if it does not exist. @@ -1470,10 +1714,10 @@ declare module "fs" { * If a file descriptor is provided, the underlying file will _not_ be closed automatically. * @param data The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string. */ - function appendFile(file: PathLike | number, data: any, callback: NoParamCallback): void; + export function appendFile(file: PathLike | number, data: string | Uint8Array, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace appendFile { + export namespace appendFile { /** * Asynchronously append data to a file, creating the file if it does not exist. * @param file A path to a file. If a URL is provided, it must use the `file:` protocol. @@ -1486,7 +1730,7 @@ declare module "fs" { * If `mode` is a string, it is parsed as an octal integer. * If `flag` is not supplied, the default of `'a'` is used. */ - function __promisify__(file: PathLike | number, data: any, options?: WriteFileOptions): Promise; + function __promisify__(file: PathLike | number, data: string | Uint8Array, options?: WriteFileOptions): Promise; } /** @@ -1501,26 +1745,26 @@ declare module "fs" { * If `mode` is a string, it is parsed as an octal integer. * If `flag` is not supplied, the default of `'a'` is used. */ - function appendFileSync(file: PathLike | number, data: any, options?: WriteFileOptions): void; + export function appendFileSync(file: PathLike | number, data: string | Uint8Array, options?: WriteFileOptions): void; /** * Watch for changes on `filename`. The callback `listener` will be called each time the file is accessed. */ - function watchFile(filename: PathLike, options: { persistent?: boolean; interval?: number; } | undefined, listener: (curr: Stats, prev: Stats) => void): void; + export function watchFile(filename: PathLike, options: { persistent?: boolean; interval?: number; } | undefined, listener: (curr: Stats, prev: Stats) => void): void; /** * Watch for changes on `filename`. The callback `listener` will be called each time the file is accessed. * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function watchFile(filename: PathLike, listener: (curr: Stats, prev: Stats) => void): void; + export function watchFile(filename: PathLike, listener: (curr: Stats, prev: Stats) => void): void; /** * Stop watching for changes on `filename`. * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function unwatchFile(filename: PathLike, listener?: (curr: Stats, prev: Stats) => void): void; + export function unwatchFile(filename: PathLike, listener?: (curr: Stats, prev: Stats) => void): void; /** * Watch for changes on `filename`, where `filename` is either a file or a directory, returning an `FSWatcher`. @@ -1531,7 +1775,7 @@ declare module "fs" { * If `persistent` is not supplied, the default of `true` is used. * If `recursive` is not supplied, the default of `false` is used. */ - function watch( + export function watch( filename: PathLike, options: { encoding?: BufferEncoding | null, persistent?: boolean, recursive?: boolean } | BufferEncoding | undefined | null, listener?: (event: string, filename: string) => void, @@ -1546,7 +1790,7 @@ declare module "fs" { * If `persistent` is not supplied, the default of `true` is used. * If `recursive` is not supplied, the default of `false` is used. */ - function watch(filename: PathLike, options: { encoding: "buffer", persistent?: boolean, recursive?: boolean } | "buffer", listener?: (event: string, filename: Buffer) => void): FSWatcher; + export function watch(filename: PathLike, options: { encoding: "buffer", persistent?: boolean, recursive?: boolean } | "buffer", listener?: (event: string, filename: Buffer) => void): FSWatcher; /** * Watch for changes on `filename`, where `filename` is either a file or a directory, returning an `FSWatcher`. @@ -1557,9 +1801,9 @@ declare module "fs" { * If `persistent` is not supplied, the default of `true` is used. * If `recursive` is not supplied, the default of `false` is used. */ - function watch( + export function watch( filename: PathLike, - options: { encoding?: string | null, persistent?: boolean, recursive?: boolean } | string | null, + options: { encoding?: BufferEncoding | null, persistent?: boolean, recursive?: boolean } | string | null, listener?: (event: string, filename: string | Buffer) => void, ): FSWatcher; @@ -1568,18 +1812,18 @@ declare module "fs" { * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function watch(filename: PathLike, listener?: (event: string, filename: string) => any): FSWatcher; + export function watch(filename: PathLike, listener?: (event: string, filename: string) => any): FSWatcher; /** * Asynchronously tests whether or not the given path exists by checking with the file system. - * @deprecated + * @deprecated since v1.0.0 Use `fs.stat()` or `fs.access()` instead * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function exists(path: PathLike, callback: (exists: boolean) => void): void; + export function exists(path: PathLike, callback: (exists: boolean) => void): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace exists { + export namespace exists { /** * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. @@ -1592,9 +1836,9 @@ declare module "fs" { * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function existsSync(path: PathLike): boolean; + export function existsSync(path: PathLike): boolean; - namespace constants { + export namespace constants { // File Access Constants /** Constant for fs.access(). File is visible to the calling process. */ @@ -1762,17 +2006,17 @@ declare module "fs" { * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function access(path: PathLike, mode: number | undefined, callback: NoParamCallback): void; + export function access(path: PathLike, mode: number | undefined, callback: NoParamCallback): void; /** * Asynchronously tests a user's permissions for the file specified by path. * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function access(path: PathLike, callback: NoParamCallback): void; + export function access(path: PathLike, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace access { + export namespace access { /** * Asynchronously tests a user's permissions for the file specified by path. * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. @@ -1786,16 +2030,16 @@ declare module "fs" { * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function accessSync(path: PathLike, mode?: number): void; + export function accessSync(path: PathLike, mode?: number): void; /** * Returns a new `ReadStream` object. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function createReadStream(path: PathLike, options?: string | { + export function createReadStream(path: PathLike, options?: string | { flags?: string; - encoding?: string; + encoding?: BufferEncoding; fd?: number; mode?: number; autoClose?: boolean; @@ -1813,12 +2057,13 @@ declare module "fs" { * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * URL support is _experimental_. */ - function createWriteStream(path: PathLike, options?: string | { + export function createWriteStream(path: PathLike, options?: string | { flags?: string; - encoding?: string; + encoding?: BufferEncoding; fd?: number; mode?: number; autoClose?: boolean; + emitClose?: boolean; start?: number; highWaterMark?: number; }): WriteStream; @@ -1827,10 +2072,10 @@ declare module "fs" { * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. * @param fd A file descriptor. */ - function fdatasync(fd: number, callback: NoParamCallback): void; + export function fdatasync(fd: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace fdatasync { + export namespace fdatasync { /** * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. * @param fd A file descriptor. @@ -1842,7 +2087,7 @@ declare module "fs" { * Synchronous fdatasync(2) - synchronize a file's in-core state with storage device. * @param fd A file descriptor. */ - function fdatasyncSync(fd: number): void; + export function fdatasyncSync(fd: number): void; /** * Asynchronously copies src to dest. By default, dest is overwritten if it already exists. @@ -1853,7 +2098,7 @@ declare module "fs" { * @param src A path to the source file. * @param dest A path to the destination file. */ - function copyFile(src: PathLike, dest: PathLike, callback: NoParamCallback): void; + export function copyFile(src: PathLike, dest: PathLike, callback: NoParamCallback): void; /** * Asynchronously copies src to dest. By default, dest is overwritten if it already exists. * No arguments other than a possible exception are given to the callback function. @@ -1864,10 +2109,10 @@ declare module "fs" { * @param dest A path to the destination file. * @param flags An integer that specifies the behavior of the copy operation. The only supported flag is fs.constants.COPYFILE_EXCL, which causes the copy operation to fail if dest already exists. */ - function copyFile(src: PathLike, dest: PathLike, flags: number, callback: NoParamCallback): void; + export function copyFile(src: PathLike, dest: PathLike, flags: number, callback: NoParamCallback): void; // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. - namespace copyFile { + export namespace copyFile { /** * Asynchronously copies src to dest. By default, dest is overwritten if it already exists. * No arguments other than a possible exception are given to the callback function. @@ -1893,7 +2138,7 @@ declare module "fs" { * @param flags An optional integer that specifies the behavior of the copy operation. * The only supported flag is fs.constants.COPYFILE_EXCL, which causes the copy operation to fail if dest already exists. */ - function copyFileSync(src: PathLike, dest: PathLike, flags?: number): void; + export function copyFileSync(src: PathLike, dest: PathLike, flags?: number): void; /** * Write an array of ArrayBufferViews to the file specified by fd using writev(). @@ -1902,545 +2147,93 @@ declare module "fs" { * On Linux, positional writes don't work when the file is opened in append mode. * The kernel ignores the position argument and always appends the data to the end of the file. */ - function writev( + export function writev( fd: number, - buffers: NodeJS.ArrayBufferView[], + buffers: ReadonlyArray, cb: (err: NodeJS.ErrnoException | null, bytesWritten: number, buffers: NodeJS.ArrayBufferView[]) => void ): void; - function writev( + export function writev( fd: number, - buffers: NodeJS.ArrayBufferView[], + buffers: ReadonlyArray, position: number, cb: (err: NodeJS.ErrnoException | null, bytesWritten: number, buffers: NodeJS.ArrayBufferView[]) => void ): void; - interface WriteVResult { + export interface WriteVResult { bytesWritten: number; buffers: NodeJS.ArrayBufferView[]; } - namespace writev { - function __promisify__(fd: number, buffers: NodeJS.ArrayBufferView[], position?: number): Promise; + export namespace writev { + function __promisify__(fd: number, buffers: ReadonlyArray, position?: number): Promise; } /** * See `writev`. */ - function writevSync(fd: number, buffers: NodeJS.ArrayBufferView[], position?: number): number; + export function writevSync(fd: number, buffers: ReadonlyArray, position?: number): number; - interface OpenDirOptions { - encoding?: BufferEncoding; + export function readv( + fd: number, + buffers: ReadonlyArray, + cb: (err: NodeJS.ErrnoException | null, bytesRead: number, buffers: NodeJS.ArrayBufferView[]) => void + ): void; + export function readv( + fd: number, + buffers: ReadonlyArray, + position: number, + cb: (err: NodeJS.ErrnoException | null, bytesRead: number, buffers: NodeJS.ArrayBufferView[]) => void + ): void; + + export interface ReadVResult { + bytesRead: number; + buffers: NodeJS.ArrayBufferView[]; } - function opendirSync(path: string, options?: OpenDirOptions): Dir; + export namespace readv { + function __promisify__(fd: number, buffers: ReadonlyArray, position?: number): Promise; + } - function opendir(path: string, cb: (err: NodeJS.ErrnoException | null, dir: Dir) => void): void; - function opendir(path: string, options: OpenDirOptions, cb: (err: NodeJS.ErrnoException | null, dir: Dir) => void): void; + /** + * See `readv`. + */ + export function readvSync(fd: number, buffers: ReadonlyArray, position?: number): number; - namespace opendir { + export interface OpenDirOptions { + encoding?: BufferEncoding; + /** + * Number of directory entries that are buffered + * internally when reading from the directory. Higher values lead to better + * performance but higher memory usage. + * @default 32 + */ + bufferSize?: number; + } + + export function opendirSync(path: string, options?: OpenDirOptions): Dir; + + export function opendir(path: string, cb: (err: NodeJS.ErrnoException | null, dir: Dir) => void): void; + export function opendir(path: string, options: OpenDirOptions, cb: (err: NodeJS.ErrnoException | null, dir: Dir) => void): void; + + export namespace opendir { function __promisify__(path: string, options?: OpenDirOptions): Promise

; } - namespace promises { - interface FileHandle { - /** - * Gets the file descriptor for this file handle. - */ - readonly fd: number; + export interface BigIntStats extends StatsBase { + } - /** - * Asynchronously append data to a file, creating the file if it does not exist. The underlying file will _not_ be closed automatically. - * The `FileHandle` must have been opened for appending. - * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. - * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. - * If `encoding` is not supplied, the default of `'utf8'` is used. - * If `mode` is not supplied, the default of `0o666` is used. - * If `mode` is a string, it is parsed as an octal integer. - * If `flag` is not supplied, the default of `'a'` is used. - */ - appendFile(data: any, options?: { encoding?: string | null, mode?: string | number, flag?: string | number } | string | null): Promise; + export class BigIntStats { + atimeNs: bigint; + mtimeNs: bigint; + ctimeNs: bigint; + birthtimeNs: bigint; + } - /** - * Asynchronous fchown(2) - Change ownership of a file. - */ - chown(uid: number, gid: number): Promise; + export interface BigIntOptions { + bigint: true; + } - /** - * Asynchronous fchmod(2) - Change permissions of a file. - * @param mode A file mode. If a string is passed, it is parsed as an octal integer. - */ - chmod(mode: string | number): Promise; - - /** - * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. - */ - datasync(): Promise; - - /** - * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. - */ - sync(): Promise; - - /** - * Asynchronously reads data from the file. - * The `FileHandle` must have been opened for reading. - * @param buffer The buffer that the data will be written to. - * @param offset The offset in the buffer at which to start writing. - * @param length The number of bytes to read. - * @param position The offset from the beginning of the file from which data should be read. If `null`, data will be read from the current position. - */ - read(buffer: TBuffer, offset?: number | null, length?: number | null, position?: number | null): Promise<{ bytesRead: number, buffer: TBuffer }>; - - /** - * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. - * The `FileHandle` must have been opened for reading. - * @param options An object that may contain an optional flag. - * If a flag is not provided, it defaults to `'r'`. - */ - readFile(options?: { encoding?: null, flag?: string | number } | null): Promise; - - /** - * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. - * The `FileHandle` must have been opened for reading. - * @param options An object that may contain an optional flag. - * If a flag is not provided, it defaults to `'r'`. - */ - readFile(options: { encoding: BufferEncoding, flag?: string | number } | BufferEncoding): Promise; - - /** - * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. - * The `FileHandle` must have been opened for reading. - * @param options An object that may contain an optional flag. - * If a flag is not provided, it defaults to `'r'`. - */ - readFile(options?: { encoding?: string | null, flag?: string | number } | string | null): Promise; - - /** - * Asynchronous fstat(2) - Get file status. - */ - stat(): Promise; - - /** - * Asynchronous ftruncate(2) - Truncate a file to a specified length. - * @param len If not specified, defaults to `0`. - */ - truncate(len?: number): Promise; - - /** - * Asynchronously change file timestamps of the file. - * @param atime The last access time. If a string is provided, it will be coerced to number. - * @param mtime The last modified time. If a string is provided, it will be coerced to number. - */ - utimes(atime: string | number | Date, mtime: string | number | Date): Promise; - - /** - * Asynchronously writes `buffer` to the file. - * The `FileHandle` must have been opened for writing. - * @param buffer The buffer that the data will be written to. - * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. - * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. - * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. - */ - write(buffer: TBuffer, offset?: number | null, length?: number | null, position?: number | null): Promise<{ bytesWritten: number, buffer: TBuffer }>; - - /** - * Asynchronously writes `string` to the file. - * The `FileHandle` must have been opened for writing. - * It is unsafe to call `write()` multiple times on the same file without waiting for the `Promise` - * to be resolved (or rejected). For this scenario, `fs.createWriteStream` is strongly recommended. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. - * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. - * @param encoding The expected string encoding. - */ - write(data: any, position?: number | null, encoding?: string | null): Promise<{ bytesWritten: number, buffer: string }>; - - /** - * Asynchronously writes data to a file, replacing the file if it already exists. The underlying file will _not_ be closed automatically. - * The `FileHandle` must have been opened for writing. - * It is unsafe to call `writeFile()` multiple times on the same file without waiting for the `Promise` to be resolved (or rejected). - * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. - * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. - * If `encoding` is not supplied, the default of `'utf8'` is used. - * If `mode` is not supplied, the default of `0o666` is used. - * If `mode` is a string, it is parsed as an octal integer. - * If `flag` is not supplied, the default of `'w'` is used. - */ - writeFile(data: any, options?: { encoding?: string | null, mode?: string | number, flag?: string | number } | string | null): Promise; - - /** - * See `fs.writev` promisified version. - */ - writev(buffers: NodeJS.ArrayBufferView[], position?: number): Promise; - - /** - * Asynchronous close(2) - close a `FileHandle`. - */ - close(): Promise; - } - - /** - * Asynchronously tests a user's permissions for the file specified by path. - * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. - * URL support is _experimental_. - */ - function access(path: PathLike, mode?: number): Promise; - - /** - * Asynchronously copies `src` to `dest`. By default, `dest` is overwritten if it already exists. - * Node.js makes no guarantees about the atomicity of the copy operation. - * If an error occurs after the destination file has been opened for writing, Node.js will attempt - * to remove the destination. - * @param src A path to the source file. - * @param dest A path to the destination file. - * @param flags An optional integer that specifies the behavior of the copy operation. The only - * supported flag is `fs.constants.COPYFILE_EXCL`, which causes the copy operation to fail if - * `dest` already exists. - */ - function copyFile(src: PathLike, dest: PathLike, flags?: number): Promise; - - /** - * Asynchronous open(2) - open and possibly create a file. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param mode A file mode. If a string is passed, it is parsed as an octal integer. If not - * supplied, defaults to `0o666`. - */ - function open(path: PathLike, flags: string | number, mode?: string | number): Promise; - - /** - * Asynchronously reads data from the file referenced by the supplied `FileHandle`. - * @param handle A `FileHandle`. - * @param buffer The buffer that the data will be written to. - * @param offset The offset in the buffer at which to start writing. - * @param length The number of bytes to read. - * @param position The offset from the beginning of the file from which data should be read. If - * `null`, data will be read from the current position. - */ - function read( - handle: FileHandle, - buffer: TBuffer, - offset?: number | null, - length?: number | null, - position?: number | null, - ): Promise<{ bytesRead: number, buffer: TBuffer }>; - - /** - * Asynchronously writes `buffer` to the file referenced by the supplied `FileHandle`. - * It is unsafe to call `fsPromises.write()` multiple times on the same file without waiting for the `Promise` - * to be resolved (or rejected). For this scenario, `fs.createWriteStream` is strongly recommended. - * @param handle A `FileHandle`. - * @param buffer The buffer that the data will be written to. - * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. - * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. - * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. - */ - function write( - handle: FileHandle, - buffer: TBuffer, - offset?: number | null, - length?: number | null, position?: number | null): Promise<{ bytesWritten: number, buffer: TBuffer }>; - - /** - * Asynchronously writes `string` to the file referenced by the supplied `FileHandle`. - * It is unsafe to call `fsPromises.write()` multiple times on the same file without waiting for the `Promise` - * to be resolved (or rejected). For this scenario, `fs.createWriteStream` is strongly recommended. - * @param handle A `FileHandle`. - * @param string A string to write. If something other than a string is supplied it will be coerced to a string. - * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. - * @param encoding The expected string encoding. - */ - function write(handle: FileHandle, string: any, position?: number | null, encoding?: string | null): Promise<{ bytesWritten: number, buffer: string }>; - - /** - * Asynchronous rename(2) - Change the name or location of a file or directory. - * @param oldPath A path to a file. If a URL is provided, it must use the `file:` protocol. - * URL support is _experimental_. - * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. - * URL support is _experimental_. - */ - function rename(oldPath: PathLike, newPath: PathLike): Promise; - - /** - * Asynchronous truncate(2) - Truncate a file to a specified length. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param len If not specified, defaults to `0`. - */ - function truncate(path: PathLike, len?: number): Promise; - - /** - * Asynchronous ftruncate(2) - Truncate a file to a specified length. - * @param handle A `FileHandle`. - * @param len If not specified, defaults to `0`. - */ - function ftruncate(handle: FileHandle, len?: number): Promise; - - /** - * Asynchronous rmdir(2) - delete a directory. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function rmdir(path: PathLike, options?: RmDirAsyncOptions): Promise; - - /** - * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. - * @param handle A `FileHandle`. - */ - function fdatasync(handle: FileHandle): Promise; - - /** - * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. - * @param handle A `FileHandle`. - */ - function fsync(handle: FileHandle): Promise; - - /** - * Asynchronous mkdir(2) - create a directory. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders - * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. - */ - function mkdir(path: PathLike, options?: number | string | MakeDirectoryOptions | null): Promise; - - /** - * Asynchronous readdir(3) - read a directory. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function readdir(path: PathLike, options?: { encoding?: BufferEncoding | null; withFileTypes?: false } | BufferEncoding | null): Promise; - - /** - * Asynchronous readdir(3) - read a directory. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function readdir(path: PathLike, options: { encoding: "buffer"; withFileTypes?: false } | "buffer"): Promise; - - /** - * Asynchronous readdir(3) - read a directory. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function readdir(path: PathLike, options?: { encoding?: string | null; withFileTypes?: false } | string | null): Promise; - - /** - * Asynchronous readdir(3) - read a directory. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options If called with `withFileTypes: true` the result data will be an array of Dirent. - */ - function readdir(path: PathLike, options: { encoding?: string | null; withFileTypes: true }): Promise; - - /** - * Asynchronous readlink(2) - read value of a symbolic link. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function readlink(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): Promise; - - /** - * Asynchronous readlink(2) - read value of a symbolic link. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function readlink(path: PathLike, options: { encoding: "buffer" } | "buffer"): Promise; - - /** - * Asynchronous readlink(2) - read value of a symbolic link. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function readlink(path: PathLike, options?: { encoding?: string | null } | string | null): Promise; - - /** - * Asynchronous symlink(2) - Create a new symbolic link to an existing file. - * @param target A path to an existing file. If a URL is provided, it must use the `file:` protocol. - * @param path A path to the new symlink. If a URL is provided, it must use the `file:` protocol. - * @param type May be set to `'dir'`, `'file'`, or `'junction'` (default is `'file'`) and is only available on Windows (ignored on other platforms). - * When using `'junction'`, the `target` argument will automatically be normalized to an absolute path. - */ - function symlink(target: PathLike, path: PathLike, type?: string | null): Promise; - - /** - * Asynchronous fstat(2) - Get file status. - * @param handle A `FileHandle`. - */ - function fstat(handle: FileHandle): Promise; - - /** - * Asynchronous lstat(2) - Get file status. Does not dereference symbolic links. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function lstat(path: PathLike): Promise; - - /** - * Asynchronous stat(2) - Get file status. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function stat(path: PathLike): Promise; - - /** - * Asynchronous link(2) - Create a new link (also known as a hard link) to an existing file. - * @param existingPath A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function link(existingPath: PathLike, newPath: PathLike): Promise; - - /** - * Asynchronous unlink(2) - delete a name and possibly the file it refers to. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function unlink(path: PathLike): Promise; - - /** - * Asynchronous fchmod(2) - Change permissions of a file. - * @param handle A `FileHandle`. - * @param mode A file mode. If a string is passed, it is parsed as an octal integer. - */ - function fchmod(handle: FileHandle, mode: string | number): Promise; - - /** - * Asynchronous chmod(2) - Change permissions of a file. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param mode A file mode. If a string is passed, it is parsed as an octal integer. - */ - function chmod(path: PathLike, mode: string | number): Promise; - - /** - * Asynchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param mode A file mode. If a string is passed, it is parsed as an octal integer. - */ - function lchmod(path: PathLike, mode: string | number): Promise; - - /** - * Asynchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function lchown(path: PathLike, uid: number, gid: number): Promise; - - /** - * Asynchronous fchown(2) - Change ownership of a file. - * @param handle A `FileHandle`. - */ - function fchown(handle: FileHandle, uid: number, gid: number): Promise; - - /** - * Asynchronous chown(2) - Change ownership of a file. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - */ - function chown(path: PathLike, uid: number, gid: number): Promise; - - /** - * Asynchronously change file timestamps of the file referenced by the supplied path. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param atime The last access time. If a string is provided, it will be coerced to number. - * @param mtime The last modified time. If a string is provided, it will be coerced to number. - */ - function utimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date): Promise; - - /** - * Asynchronously change file timestamps of the file referenced by the supplied `FileHandle`. - * @param handle A `FileHandle`. - * @param atime The last access time. If a string is provided, it will be coerced to number. - * @param mtime The last modified time. If a string is provided, it will be coerced to number. - */ - function futimes(handle: FileHandle, atime: string | number | Date, mtime: string | number | Date): Promise; - - /** - * Asynchronous realpath(3) - return the canonicalized absolute pathname. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function realpath(path: PathLike, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): Promise; - - /** - * Asynchronous realpath(3) - return the canonicalized absolute pathname. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function realpath(path: PathLike, options: { encoding: "buffer" } | "buffer"): Promise; - - /** - * Asynchronous realpath(3) - return the canonicalized absolute pathname. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function realpath(path: PathLike, options?: { encoding?: string | null } | string | null): Promise; - - /** - * Asynchronously creates a unique temporary directory. - * Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function mkdtemp(prefix: string, options?: { encoding?: BufferEncoding | null } | BufferEncoding | null): Promise; - - /** - * Asynchronously creates a unique temporary directory. - * Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function mkdtemp(prefix: string, options: { encoding: "buffer" } | "buffer"): Promise; - - /** - * Asynchronously creates a unique temporary directory. - * Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. - * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. - */ - function mkdtemp(prefix: string, options?: { encoding?: string | null } | string | null): Promise; - - /** - * Asynchronously writes data to a file, replacing the file if it already exists. - * It is unsafe to call `fsPromises.writeFile()` multiple times on the same file without waiting for the `Promise` to be resolved (or rejected). - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * URL support is _experimental_. - * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. - * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. - * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. - * If `encoding` is not supplied, the default of `'utf8'` is used. - * If `mode` is not supplied, the default of `0o666` is used. - * If `mode` is a string, it is parsed as an octal integer. - * If `flag` is not supplied, the default of `'w'` is used. - */ - function writeFile(path: PathLike | FileHandle, data: any, options?: { encoding?: string | null, mode?: string | number, flag?: string | number } | string | null): Promise; - - /** - * Asynchronously append data to a file, creating the file if it does not exist. - * @param file A path to a file. If a URL is provided, it must use the `file:` protocol. - * URL support is _experimental_. - * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. - * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. - * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. - * If `encoding` is not supplied, the default of `'utf8'` is used. - * If `mode` is not supplied, the default of `0o666` is used. - * If `mode` is a string, it is parsed as an octal integer. - * If `flag` is not supplied, the default of `'a'` is used. - */ - function appendFile(path: PathLike | FileHandle, data: any, options?: { encoding?: string | null, mode?: string | number, flag?: string | number } | string | null): Promise; - - /** - * Asynchronously reads the entire contents of a file. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. - * @param options An object that may contain an optional flag. - * If a flag is not provided, it defaults to `'r'`. - */ - function readFile(path: PathLike | FileHandle, options?: { encoding?: null, flag?: string | number } | null): Promise; - - /** - * Asynchronously reads the entire contents of a file. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. - * @param options An object that may contain an optional flag. - * If a flag is not provided, it defaults to `'r'`. - */ - function readFile(path: PathLike | FileHandle, options: { encoding: BufferEncoding, flag?: string | number } | BufferEncoding): Promise; - - /** - * Asynchronously reads the entire contents of a file. - * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. - * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. - * @param options An object that may contain an optional flag. - * If a flag is not provided, it defaults to `'r'`. - */ - function readFile(path: PathLike | FileHandle, options?: { encoding?: string | null, flag?: string | number } | string | null): Promise; - - function opendir(path: string, options?: OpenDirOptions): Promise; + export interface StatOptions { + bigint: boolean; } } diff --git a/node_modules/@types/node/fs/promises.d.ts b/node_modules/@types/node/fs/promises.d.ts new file mode 100644 index 0000000..1753c86 --- /dev/null +++ b/node_modules/@types/node/fs/promises.d.ts @@ -0,0 +1,555 @@ +declare module 'fs/promises' { + import { + Stats, + WriteVResult, + ReadVResult, + PathLike, + RmDirOptions, + RmOptions, + MakeDirectoryOptions, + Dirent, + OpenDirOptions, + Dir, + BaseEncodingOptions, + BufferEncodingOption, + OpenMode, + Mode, + } from 'fs'; + + interface FileHandle { + /** + * Gets the file descriptor for this file handle. + */ + readonly fd: number; + + /** + * Asynchronously append data to a file, creating the file if it does not exist. The underlying file will _not_ be closed automatically. + * The `FileHandle` must have been opened for appending. + * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. + * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. + * If `encoding` is not supplied, the default of `'utf8'` is used. + * If `mode` is not supplied, the default of `0o666` is used. + * If `mode` is a string, it is parsed as an octal integer. + * If `flag` is not supplied, the default of `'a'` is used. + */ + appendFile(data: string | Uint8Array, options?: BaseEncodingOptions & { mode?: Mode, flag?: OpenMode } | BufferEncoding | null): Promise; + + /** + * Asynchronous fchown(2) - Change ownership of a file. + */ + chown(uid: number, gid: number): Promise; + + /** + * Asynchronous fchmod(2) - Change permissions of a file. + * @param mode A file mode. If a string is passed, it is parsed as an octal integer. + */ + chmod(mode: Mode): Promise; + + /** + * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. + */ + datasync(): Promise; + + /** + * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. + */ + sync(): Promise; + + /** + * Asynchronously reads data from the file. + * The `FileHandle` must have been opened for reading. + * @param buffer The buffer that the data will be written to. + * @param offset The offset in the buffer at which to start writing. + * @param length The number of bytes to read. + * @param position The offset from the beginning of the file from which data should be read. If `null`, data will be read from the current position. + */ + read(buffer: TBuffer, offset?: number | null, length?: number | null, position?: number | null): Promise<{ bytesRead: number, buffer: TBuffer }>; + + /** + * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. + * The `FileHandle` must have been opened for reading. + * @param options An object that may contain an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + readFile(options?: { encoding?: null, flag?: OpenMode } | null): Promise; + + /** + * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. + * The `FileHandle` must have been opened for reading. + * @param options An object that may contain an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + readFile(options: { encoding: BufferEncoding, flag?: OpenMode } | BufferEncoding): Promise; + + /** + * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. + * The `FileHandle` must have been opened for reading. + * @param options An object that may contain an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + readFile(options?: BaseEncodingOptions & { flag?: OpenMode } | BufferEncoding | null): Promise; + + /** + * Asynchronous fstat(2) - Get file status. + */ + stat(): Promise; + + /** + * Asynchronous ftruncate(2) - Truncate a file to a specified length. + * @param len If not specified, defaults to `0`. + */ + truncate(len?: number): Promise; + + /** + * Asynchronously change file timestamps of the file. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + utimes(atime: string | number | Date, mtime: string | number | Date): Promise; + + /** + * Asynchronously writes `buffer` to the file. + * The `FileHandle` must have been opened for writing. + * @param buffer The buffer that the data will be written to. + * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. + * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. + * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. + */ + write(buffer: TBuffer, offset?: number | null, length?: number | null, position?: number | null): Promise<{ bytesWritten: number, buffer: TBuffer }>; + + /** + * Asynchronously writes `string` to the file. + * The `FileHandle` must have been opened for writing. + * It is unsafe to call `write()` multiple times on the same file without waiting for the `Promise` + * to be resolved (or rejected). For this scenario, `fs.createWriteStream` is strongly recommended. + * @param string A string to write. + * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. + * @param encoding The expected string encoding. + */ + write(data: string | Uint8Array, position?: number | null, encoding?: BufferEncoding | null): Promise<{ bytesWritten: number, buffer: string }>; + + /** + * Asynchronously writes data to a file, replacing the file if it already exists. The underlying file will _not_ be closed automatically. + * The `FileHandle` must have been opened for writing. + * It is unsafe to call `writeFile()` multiple times on the same file without waiting for the `Promise` to be resolved (or rejected). + * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. + * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. + * If `encoding` is not supplied, the default of `'utf8'` is used. + * If `mode` is not supplied, the default of `0o666` is used. + * If `mode` is a string, it is parsed as an octal integer. + * If `flag` is not supplied, the default of `'w'` is used. + */ + writeFile(data: string | Uint8Array, options?: BaseEncodingOptions & { mode?: Mode, flag?: OpenMode } | BufferEncoding | null): Promise; + + /** + * See `fs.writev` promisified version. + */ + writev(buffers: ReadonlyArray, position?: number): Promise; + + /** + * See `fs.readv` promisified version. + */ + readv(buffers: ReadonlyArray, position?: number): Promise; + + /** + * Asynchronous close(2) - close a `FileHandle`. + */ + close(): Promise; + } + + /** + * Asynchronously tests a user's permissions for the file specified by path. + * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + */ + function access(path: PathLike, mode?: number): Promise; + + /** + * Asynchronously copies `src` to `dest`. By default, `dest` is overwritten if it already exists. + * Node.js makes no guarantees about the atomicity of the copy operation. + * If an error occurs after the destination file has been opened for writing, Node.js will attempt + * to remove the destination. + * @param src A path to the source file. + * @param dest A path to the destination file. + * @param flags An optional integer that specifies the behavior of the copy operation. The only + * supported flag is `fs.constants.COPYFILE_EXCL`, which causes the copy operation to fail if + * `dest` already exists. + */ + function copyFile(src: PathLike, dest: PathLike, flags?: number): Promise; + + /** + * Asynchronous open(2) - open and possibly create a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param mode A file mode. If a string is passed, it is parsed as an octal integer. If not + * supplied, defaults to `0o666`. + */ + function open(path: PathLike, flags: string | number, mode?: Mode): Promise; + + /** + * Asynchronously reads data from the file referenced by the supplied `FileHandle`. + * @param handle A `FileHandle`. + * @param buffer The buffer that the data will be written to. + * @param offset The offset in the buffer at which to start writing. + * @param length The number of bytes to read. + * @param position The offset from the beginning of the file from which data should be read. If + * `null`, data will be read from the current position. + */ + function read( + handle: FileHandle, + buffer: TBuffer, + offset?: number | null, + length?: number | null, + position?: number | null, + ): Promise<{ bytesRead: number, buffer: TBuffer }>; + + /** + * Asynchronously writes `buffer` to the file referenced by the supplied `FileHandle`. + * It is unsafe to call `fsPromises.write()` multiple times on the same file without waiting for the `Promise` + * to be resolved (or rejected). For this scenario, `fs.createWriteStream` is strongly recommended. + * @param handle A `FileHandle`. + * @param buffer The buffer that the data will be written to. + * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. + * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. + * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. + */ + function write( + handle: FileHandle, + buffer: TBuffer, + offset?: number | null, + length?: number | null, position?: number | null): Promise<{ bytesWritten: number, buffer: TBuffer }>; + + /** + * Asynchronously writes `string` to the file referenced by the supplied `FileHandle`. + * It is unsafe to call `fsPromises.write()` multiple times on the same file without waiting for the `Promise` + * to be resolved (or rejected). For this scenario, `fs.createWriteStream` is strongly recommended. + * @param handle A `FileHandle`. + * @param string A string to write. + * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. + * @param encoding The expected string encoding. + */ + function write(handle: FileHandle, string: string, position?: number | null, encoding?: BufferEncoding | null): Promise<{ bytesWritten: number, buffer: string }>; + + /** + * Asynchronous rename(2) - Change the name or location of a file or directory. + * @param oldPath A path to a file. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + */ + function rename(oldPath: PathLike, newPath: PathLike): Promise; + + /** + * Asynchronous truncate(2) - Truncate a file to a specified length. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param len If not specified, defaults to `0`. + */ + function truncate(path: PathLike, len?: number): Promise; + + /** + * Asynchronous ftruncate(2) - Truncate a file to a specified length. + * @param handle A `FileHandle`. + * @param len If not specified, defaults to `0`. + */ + function ftruncate(handle: FileHandle, len?: number): Promise; + + /** + * Asynchronous rmdir(2) - delete a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function rmdir(path: PathLike, options?: RmDirOptions): Promise; + + /** + * Asynchronously removes files and directories (modeled on the standard POSIX `rm` utility). + */ + function rm(path: PathLike, options?: RmOptions): Promise; + + /** + * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. + * @param handle A `FileHandle`. + */ + function fdatasync(handle: FileHandle): Promise; + + /** + * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. + * @param handle A `FileHandle`. + */ + function fsync(handle: FileHandle): Promise; + + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + function mkdir(path: PathLike, options: MakeDirectoryOptions & { recursive: true; }): Promise; + + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + function mkdir(path: PathLike, options?: Mode | (MakeDirectoryOptions & { recursive?: false; }) | null): Promise; + + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + function mkdir(path: PathLike, options?: Mode | MakeDirectoryOptions | null): Promise; + + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function readdir(path: PathLike, options?: BaseEncodingOptions & { withFileTypes?: false } | BufferEncoding | null): Promise; + + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function readdir(path: PathLike, options: { encoding: "buffer"; withFileTypes?: false } | "buffer"): Promise; + + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function readdir(path: PathLike, options?: BaseEncodingOptions & { withFileTypes?: false } | BufferEncoding | null): Promise; + + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options If called with `withFileTypes: true` the result data will be an array of Dirent. + */ + function readdir(path: PathLike, options: BaseEncodingOptions & { withFileTypes: true }): Promise; + + /** + * Asynchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function readlink(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): Promise; + + /** + * Asynchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function readlink(path: PathLike, options: BufferEncodingOption): Promise; + + /** + * Asynchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function readlink(path: PathLike, options?: BaseEncodingOptions | string | null): Promise; + + /** + * Asynchronous symlink(2) - Create a new symbolic link to an existing file. + * @param target A path to an existing file. If a URL is provided, it must use the `file:` protocol. + * @param path A path to the new symlink. If a URL is provided, it must use the `file:` protocol. + * @param type May be set to `'dir'`, `'file'`, or `'junction'` (default is `'file'`) and is only available on Windows (ignored on other platforms). + * When using `'junction'`, the `target` argument will automatically be normalized to an absolute path. + */ + function symlink(target: PathLike, path: PathLike, type?: string | null): Promise; + + /** + * Asynchronous fstat(2) - Get file status. + * @param handle A `FileHandle`. + */ + function fstat(handle: FileHandle): Promise; + + /** + * Asynchronous lstat(2) - Get file status. Does not dereference symbolic links. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function lstat(path: PathLike): Promise; + + /** + * Asynchronous stat(2) - Get file status. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function stat(path: PathLike): Promise; + + /** + * Asynchronous link(2) - Create a new link (also known as a hard link) to an existing file. + * @param existingPath A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function link(existingPath: PathLike, newPath: PathLike): Promise; + + /** + * Asynchronous unlink(2) - delete a name and possibly the file it refers to. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function unlink(path: PathLike): Promise; + + /** + * Asynchronous fchmod(2) - Change permissions of a file. + * @param handle A `FileHandle`. + * @param mode A file mode. If a string is passed, it is parsed as an octal integer. + */ + function fchmod(handle: FileHandle, mode: Mode): Promise; + + /** + * Asynchronous chmod(2) - Change permissions of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param mode A file mode. If a string is passed, it is parsed as an octal integer. + */ + function chmod(path: PathLike, mode: Mode): Promise; + + /** + * Asynchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param mode A file mode. If a string is passed, it is parsed as an octal integer. + */ + function lchmod(path: PathLike, mode: Mode): Promise; + + /** + * Asynchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function lchown(path: PathLike, uid: number, gid: number): Promise; + + /** + * Changes the access and modification times of a file in the same way as `fsPromises.utimes()`, + * with the difference that if the path refers to a symbolic link, then the link is not + * dereferenced: instead, the timestamps of the symbolic link itself are changed. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + function lutimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date): Promise; + + /** + * Asynchronous fchown(2) - Change ownership of a file. + * @param handle A `FileHandle`. + */ + function fchown(handle: FileHandle, uid: number, gid: number): Promise; + + /** + * Asynchronous chown(2) - Change ownership of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function chown(path: PathLike, uid: number, gid: number): Promise; + + /** + * Asynchronously change file timestamps of the file referenced by the supplied path. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + function utimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date): Promise; + + /** + * Asynchronously change file timestamps of the file referenced by the supplied `FileHandle`. + * @param handle A `FileHandle`. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + function futimes(handle: FileHandle, atime: string | number | Date, mtime: string | number | Date): Promise; + + /** + * Asynchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function realpath(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): Promise; + + /** + * Asynchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function realpath(path: PathLike, options: BufferEncodingOption): Promise; + + /** + * Asynchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function realpath(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): Promise; + + /** + * Asynchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function mkdtemp(prefix: string, options?: BaseEncodingOptions | BufferEncoding | null): Promise; + + /** + * Asynchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function mkdtemp(prefix: string, options: BufferEncodingOption): Promise; + + /** + * Asynchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function mkdtemp(prefix: string, options?: BaseEncodingOptions | BufferEncoding | null): Promise; + + /** + * Asynchronously writes data to a file, replacing the file if it already exists. + * It is unsafe to call `fsPromises.writeFile()` multiple times on the same file without waiting for the `Promise` to be resolved (or rejected). + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. + * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. + * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. + * If `encoding` is not supplied, the default of `'utf8'` is used. + * If `mode` is not supplied, the default of `0o666` is used. + * If `mode` is a string, it is parsed as an octal integer. + * If `flag` is not supplied, the default of `'w'` is used. + */ + function writeFile(path: PathLike | FileHandle, data: string | Uint8Array, options?: BaseEncodingOptions & { mode?: Mode, flag?: OpenMode } | BufferEncoding | null): Promise; + + /** + * Asynchronously append data to a file, creating the file if it does not exist. + * @param file A path to a file. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. + * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. + * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. + * If `encoding` is not supplied, the default of `'utf8'` is used. + * If `mode` is not supplied, the default of `0o666` is used. + * If `mode` is a string, it is parsed as an octal integer. + * If `flag` is not supplied, the default of `'a'` is used. + */ + function appendFile(path: PathLike | FileHandle, data: string | Uint8Array, options?: BaseEncodingOptions & { mode?: Mode, flag?: OpenMode } | BufferEncoding | null): Promise; + + /** + * Asynchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. + * @param options An object that may contain an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + function readFile(path: PathLike | FileHandle, options?: { encoding?: null, flag?: OpenMode } | null): Promise; + + /** + * Asynchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. + * @param options An object that may contain an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + function readFile(path: PathLike | FileHandle, options: { encoding: BufferEncoding, flag?: OpenMode } | BufferEncoding): Promise; + + /** + * Asynchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. + * @param options An object that may contain an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + function readFile(path: PathLike | FileHandle, options?: BaseEncodingOptions & { flag?: OpenMode } | BufferEncoding | null): Promise; + + function opendir(path: string, options?: OpenDirOptions): Promise; +} diff --git a/node_modules/@types/node/globals.d.ts b/node_modules/@types/node/globals.d.ts index d9505f1..844f22e 100644 --- a/node_modules/@types/node/globals.d.ts +++ b/node_modules/@types/node/globals.d.ts @@ -1,136 +1,7 @@ -// This needs to be global to avoid TS2403 in case lib.dom.d.ts is present in the same build -interface Console { - Console: NodeJS.ConsoleConstructor; - /** - * A simple assertion test that verifies whether `value` is truthy. - * If it is not, an `AssertionError` is thrown. - * If provided, the error `message` is formatted using `util.format()` and used as the error message. - */ - assert(value: any, message?: string, ...optionalParams: any[]): void; - /** - * When `stdout` is a TTY, calling `console.clear()` will attempt to clear the TTY. - * When `stdout` is not a TTY, this method does nothing. - */ - clear(): void; - /** - * Maintains an internal counter specific to `label` and outputs to `stdout` the number of times `console.count()` has been called with the given `label`. - */ - count(label?: string): void; - /** - * Resets the internal counter specific to `label`. - */ - countReset(label?: string): void; - /** - * The `console.debug()` function is an alias for {@link console.log()}. - */ - debug(message?: any, ...optionalParams: any[]): void; - /** - * Uses {@link util.inspect()} on `obj` and prints the resulting string to `stdout`. - * This function bypasses any custom `inspect()` function defined on `obj`. - */ - dir(obj: any, options?: NodeJS.InspectOptions): void; - /** - * This method calls {@link console.log()} passing it the arguments received. Please note that this method does not produce any XML formatting - */ - dirxml(...data: any[]): void; - /** - * Prints to `stderr` with newline. - */ - error(message?: any, ...optionalParams: any[]): void; - /** - * Increases indentation of subsequent lines by two spaces. - * If one or more `label`s are provided, those are printed first without the additional indentation. - */ - group(...label: any[]): void; - /** - * The `console.groupCollapsed()` function is an alias for {@link console.group()}. - */ - groupCollapsed(...label: any[]): void; - /** - * Decreases indentation of subsequent lines by two spaces. - */ - groupEnd(): void; - /** - * The {@link console.info()} function is an alias for {@link console.log()}. - */ - info(message?: any, ...optionalParams: any[]): void; - /** - * Prints to `stdout` with newline. - */ - log(message?: any, ...optionalParams: any[]): void; - /** - * This method does not display anything unless used in the inspector. - * Prints to `stdout` the array `array` formatted as a table. - */ - table(tabularData: any, properties?: string[]): void; - /** - * Starts a timer that can be used to compute the duration of an operation. Timers are identified by a unique `label`. - */ - time(label?: string): void; - /** - * Stops a timer that was previously started by calling {@link console.time()} and prints the result to `stdout`. - */ - timeEnd(label?: string): void; - /** - * For a timer that was previously started by calling {@link console.time()}, prints the elapsed time and other `data` arguments to `stdout`. - */ - timeLog(label?: string, ...data: any[]): void; - /** - * Prints to `stderr` the string 'Trace :', followed by the {@link util.format()} formatted message and stack trace to the current position in the code. - */ - trace(message?: any, ...optionalParams: any[]): void; - /** - * The {@link console.warn()} function is an alias for {@link console.error()}. - */ - warn(message?: any, ...optionalParams: any[]): void; - - // --- Inspector mode only --- - /** - * This method does not display anything unless used in the inspector. - * The console.markTimeline() method is the deprecated form of console.timeStamp(). - * - * @deprecated Use console.timeStamp() instead. - */ - markTimeline(label?: string): void; - /** - * This method does not display anything unless used in the inspector. - * Starts a JavaScript CPU profile with an optional label. - */ - profile(label?: string): void; - /** - * This method does not display anything unless used in the inspector. - * Stops the current JavaScript CPU profiling session if one has been started and prints the report to the Profiles panel of the inspector. - */ - profileEnd(label?: string): void; - /** - * This method does not display anything unless used in the inspector. - * Adds an event with the label `label` to the Timeline panel of the inspector. - */ - timeStamp(label?: string): void; - /** - * This method does not display anything unless used in the inspector. - * The console.timeline() method is the deprecated form of console.time(). - * - * @deprecated Use console.time() instead. - */ - timeline(label?: string): void; - /** - * This method does not display anything unless used in the inspector. - * The console.timelineEnd() method is the deprecated form of console.timeEnd(). - * - * @deprecated Use console.timeEnd() instead. - */ - timelineEnd(label?: string): void; -} - -interface Error { - stack?: string; -} - // Declare "static" methods in Error interface ErrorConstructor { /** Create .stack property on a target object */ - captureStackTrace(targetObject: Object, constructorOpt?: Function): void; + captureStackTrace(targetObject: object, constructorOpt?: Function): void; /** * Optional override for formatting stack traces @@ -142,16 +13,17 @@ interface ErrorConstructor { stackTraceLimit: number; } -interface SymbolConstructor { - readonly observable: symbol; -} - // Node.js ESNEXT support interface String { /** Removes whitespace from the left end of a string. */ trimLeft(): string; /** Removes whitespace from the right end of a string. */ trimRight(): string; + + /** Returns a copy with leading whitespace removed. */ + trimStart(): string; + /** Returns a copy with trailing whitespace removed. */ + trimEnd(): string; } interface ImportMeta { @@ -163,8 +35,13 @@ interface ImportMeta { * GLOBAL * * * ------------------------------------------------*/ + +// For backwards compability +interface NodeRequire extends NodeJS.Require {} +interface RequireResolve extends NodeJS.RequireResolve {} +interface NodeModule extends NodeJS.Module {} + declare var process: NodeJS.Process; -declare var global: NodeJS.Global; declare var console: Console; declare var __filename: string; @@ -187,51 +64,7 @@ declare function clearImmediate(immediateId: NodeJS.Immediate): void; declare function queueMicrotask(callback: () => void): void; -// TODO: change to `type NodeRequireFunction = (id: string) => any;` in next mayor version. -interface NodeRequireFunction { - /* tslint:disable-next-line:callable-types */ - (id: string): any; -} - -interface NodeRequireCache { - [path: string]: NodeModule; -} - -interface NodeRequire extends NodeRequireFunction { - resolve: RequireResolve; - cache: NodeRequireCache; - /** - * @deprecated - */ - extensions: NodeExtensions; - main: NodeModule | undefined; -} - -interface RequireResolve { - (id: string, options?: { paths?: string[]; }): string; - paths(request: string): string[] | null; -} - -interface NodeExtensions { - '.js': (m: NodeModule, filename: string) => any; - '.json': (m: NodeModule, filename: string) => any; - '.node': (m: NodeModule, filename: string) => any; - [ext: string]: (m: NodeModule, filename: string) => any; -} - declare var require: NodeRequire; - -interface NodeModule { - exports: any; - require: NodeRequireFunction; - id: string; - filename: string; - loaded: boolean; - parent: NodeModule | null; - children: NodeModule[]; - paths: string[]; -} - declare var module: NodeModule; // Same as module.exports @@ -240,9 +73,7 @@ declare var exports: any; // Buffer class type BufferEncoding = "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex"; -interface Buffer { - constructor: typeof Buffer; -} +type WithImplicitCoercion = T | { valueOf(): T }; /** * Raw data is stored in instances of the Buffer class. @@ -287,7 +118,7 @@ declare class Buffer extends Uint8Array { * @param array The octets to store. * @deprecated since v10.0.0 - Use `Buffer.from(array)` instead. */ - constructor(array: any[]); + constructor(array: ReadonlyArray); /** * Copies the passed {buffer} data onto a new {Buffer} instance. * @@ -303,19 +134,19 @@ declare class Buffer extends Uint8Array { * * @param arrayBuffer The .buffer property of any TypedArray or a new ArrayBuffer() */ - static from(arrayBuffer: ArrayBuffer | SharedArrayBuffer, byteOffset?: number, length?: number): Buffer; + static from(arrayBuffer: WithImplicitCoercion, byteOffset?: number, length?: number): Buffer; /** * Creates a new Buffer using the passed {data} * @param data data to create a new Buffer */ - static from(data: number[]): Buffer; - static from(data: Uint8Array): Buffer; + static from(data: Uint8Array | ReadonlyArray): Buffer; + static from(data: WithImplicitCoercion | string>): Buffer; /** * Creates a new Buffer containing the given JavaScript string {str}. * If provided, the {encoding} parameter identifies the character encoding. * If not provided, {encoding} defaults to 'utf8'. */ - static from(str: string, encoding?: BufferEncoding): Buffer; + static from(str: WithImplicitCoercion | { [Symbol.toPrimitive](hint: 'string'): string }, encoding?: BufferEncoding): Buffer; /** * Creates a new Buffer using the passed {data} * @param values to create a new Buffer @@ -356,7 +187,7 @@ declare class Buffer extends Uint8Array { * @param totalLength Total length of the buffers when concatenated. * If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly. */ - static concat(list: Uint8Array[], totalLength?: number): Buffer; + static concat(list: ReadonlyArray, totalLength?: number): Buffer; /** * The same as buf1.compare(buf2). */ @@ -392,7 +223,7 @@ declare class Buffer extends Uint8Array { write(string: string, encoding?: BufferEncoding): number; write(string: string, offset: number, encoding?: BufferEncoding): number; write(string: string, offset: number, length: number, encoding?: BufferEncoding): number; - toString(encoding?: string, start?: number, end?: number): string; + toString(encoding?: BufferEncoding, start?: number, end?: number): string; toJSON(): { type: 'Buffer'; data: number[] }; equals(otherBuffer: Uint8Array): boolean; compare( @@ -421,46 +252,54 @@ declare class Buffer extends Uint8Array { * @param end Where the new `Buffer` will end (not inclusive). Default: `buf.length`. */ subarray(begin?: number, end?: number): Buffer; + writeBigInt64BE(value: bigint, offset?: number): number; + writeBigInt64LE(value: bigint, offset?: number): number; + writeBigUInt64BE(value: bigint, offset?: number): number; + writeBigUInt64LE(value: bigint, offset?: number): number; writeUIntLE(value: number, offset: number, byteLength: number): number; writeUIntBE(value: number, offset: number, byteLength: number): number; writeIntLE(value: number, offset: number, byteLength: number): number; writeIntBE(value: number, offset: number, byteLength: number): number; + readBigUInt64BE(offset?: number): bigint; + readBigUInt64LE(offset?: number): bigint; + readBigInt64BE(offset?: number): bigint; + readBigInt64LE(offset?: number): bigint; readUIntLE(offset: number, byteLength: number): number; readUIntBE(offset: number, byteLength: number): number; readIntLE(offset: number, byteLength: number): number; readIntBE(offset: number, byteLength: number): number; - readUInt8(offset: number): number; - readUInt16LE(offset: number): number; - readUInt16BE(offset: number): number; - readUInt32LE(offset: number): number; - readUInt32BE(offset: number): number; - readInt8(offset: number): number; - readInt16LE(offset: number): number; - readInt16BE(offset: number): number; - readInt32LE(offset: number): number; - readInt32BE(offset: number): number; - readFloatLE(offset: number): number; - readFloatBE(offset: number): number; - readDoubleLE(offset: number): number; - readDoubleBE(offset: number): number; + readUInt8(offset?: number): number; + readUInt16LE(offset?: number): number; + readUInt16BE(offset?: number): number; + readUInt32LE(offset?: number): number; + readUInt32BE(offset?: number): number; + readInt8(offset?: number): number; + readInt16LE(offset?: number): number; + readInt16BE(offset?: number): number; + readInt32LE(offset?: number): number; + readInt32BE(offset?: number): number; + readFloatLE(offset?: number): number; + readFloatBE(offset?: number): number; + readDoubleLE(offset?: number): number; + readDoubleBE(offset?: number): number; reverse(): this; swap16(): Buffer; swap32(): Buffer; swap64(): Buffer; - writeUInt8(value: number, offset: number): number; - writeUInt16LE(value: number, offset: number): number; - writeUInt16BE(value: number, offset: number): number; - writeUInt32LE(value: number, offset: number): number; - writeUInt32BE(value: number, offset: number): number; - writeInt8(value: number, offset: number): number; - writeInt16LE(value: number, offset: number): number; - writeInt16BE(value: number, offset: number): number; - writeInt32LE(value: number, offset: number): number; - writeInt32BE(value: number, offset: number): number; - writeFloatLE(value: number, offset: number): number; - writeFloatBE(value: number, offset: number): number; - writeDoubleLE(value: number, offset: number): number; - writeDoubleBE(value: number, offset: number): number; + writeUInt8(value: number, offset?: number): number; + writeUInt16LE(value: number, offset?: number): number; + writeUInt16BE(value: number, offset?: number): number; + writeUInt32LE(value: number, offset?: number): number; + writeUInt32BE(value: number, offset?: number): number; + writeInt8(value: number, offset?: number): number; + writeInt16LE(value: number, offset?: number): number; + writeInt16BE(value: number, offset?: number): number; + writeInt32LE(value: number, offset?: number): number; + writeInt32BE(value: number, offset?: number): number; + writeFloatLE(value: number, offset?: number): number; + writeFloatBE(value: number, offset?: number): number; + writeDoubleLE(value: number, offset?: number): number; + writeDoubleBE(value: number, offset?: number): number; fill(value: string | Uint8Array | number, offset?: number, end?: number, encoding?: BufferEncoding): this; @@ -497,6 +336,13 @@ declare namespace NodeJS { customInspect?: boolean; showProxy?: boolean; maxArrayLength?: number | null; + /** + * Specifies the maximum number of characters to + * include when formatting. Set to `null` or `Infinity` to show all elements. + * Set to `0` or negative to show no characters. + * @default Infinity + */ + maxStringLength?: number | null; breakLength?: number; /** * Setting this to `false` causes each object key @@ -512,20 +358,6 @@ declare namespace NodeJS { sorted?: boolean | ((a: string, b: string) => number); } - interface ConsoleConstructorOptions { - stdout: WritableStream; - stderr?: WritableStream; - ignoreErrors?: boolean; - colorMode?: boolean | 'auto'; - inspectOptions?: InspectOptions; - } - - interface ConsoleConstructor { - prototype: Console; - new(stdout: WritableStream, stderr?: WritableStream, ignoreErrors?: boolean): Console; - new(options: ConsoleConstructorOptions): Console; - } - interface CallSite { /** * Value of "this" @@ -608,29 +440,10 @@ declare namespace NodeJS { stack?: string; } - class EventEmitter { - addListener(event: string | symbol, listener: (...args: any[]) => void): this; - on(event: string | symbol, listener: (...args: any[]) => void): this; - once(event: string | symbol, listener: (...args: any[]) => void): this; - removeListener(event: string | symbol, listener: (...args: any[]) => void): this; - off(event: string | symbol, listener: (...args: any[]) => void): this; - removeAllListeners(event?: string | symbol): this; - setMaxListeners(n: number): this; - getMaxListeners(): number; - listeners(event: string | symbol): Function[]; - rawListeners(event: string | symbol): Function[]; - emit(event: string | symbol, ...args: any[]): boolean; - listenerCount(type: string | symbol): number; - // Added in Node 6... - prependListener(event: string | symbol, listener: (...args: any[]) => void): this; - prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; - eventNames(): Array; - } - interface ReadableStream extends EventEmitter { readable: boolean; read(size?: number): string | Buffer; - setEncoding(encoding: string): this; + setEncoding(encoding: BufferEncoding): this; pause(): this; resume(): this; isPaused(): boolean; @@ -644,404 +457,14 @@ declare namespace NodeJS { interface WritableStream extends EventEmitter { writable: boolean; write(buffer: Uint8Array | string, cb?: (err?: Error | null) => void): boolean; - write(str: string, encoding?: string, cb?: (err?: Error | null) => void): boolean; + write(str: string, encoding?: BufferEncoding, cb?: (err?: Error | null) => void): boolean; end(cb?: () => void): void; end(data: string | Uint8Array, cb?: () => void): void; - end(str: string, encoding?: string, cb?: () => void): void; + end(str: string, encoding?: BufferEncoding, cb?: () => void): void; } interface ReadWriteStream extends ReadableStream, WritableStream { } - interface Domain extends EventEmitter { - run(fn: (...args: any[]) => T, ...args: any[]): T; - add(emitter: EventEmitter | Timer): void; - remove(emitter: EventEmitter | Timer): void; - bind(cb: T): T; - intercept(cb: T): T; - - addListener(event: string, listener: (...args: any[]) => void): this; - on(event: string, listener: (...args: any[]) => void): this; - once(event: string, listener: (...args: any[]) => void): this; - removeListener(event: string, listener: (...args: any[]) => void): this; - removeAllListeners(event?: string): this; - } - - interface MemoryUsage { - rss: number; - heapTotal: number; - heapUsed: number; - external: number; - } - - interface CpuUsage { - user: number; - system: number; - } - - interface ProcessRelease { - name: string; - sourceUrl?: string; - headersUrl?: string; - libUrl?: string; - lts?: string; - } - - interface ProcessVersions { - http_parser: string; - node: string; - v8: string; - ares: string; - uv: string; - zlib: string; - modules: string; - openssl: string; - } - - type Platform = 'aix' - | 'android' - | 'darwin' - | 'freebsd' - | 'linux' - | 'openbsd' - | 'sunos' - | 'win32' - | 'cygwin' - | 'netbsd'; - - type Signals = - "SIGABRT" | "SIGALRM" | "SIGBUS" | "SIGCHLD" | "SIGCONT" | "SIGFPE" | "SIGHUP" | "SIGILL" | "SIGINT" | "SIGIO" | - "SIGIOT" | "SIGKILL" | "SIGPIPE" | "SIGPOLL" | "SIGPROF" | "SIGPWR" | "SIGQUIT" | "SIGSEGV" | "SIGSTKFLT" | - "SIGSTOP" | "SIGSYS" | "SIGTERM" | "SIGTRAP" | "SIGTSTP" | "SIGTTIN" | "SIGTTOU" | "SIGUNUSED" | "SIGURG" | - "SIGUSR1" | "SIGUSR2" | "SIGVTALRM" | "SIGWINCH" | "SIGXCPU" | "SIGXFSZ" | "SIGBREAK" | "SIGLOST" | "SIGINFO"; - - type MultipleResolveType = 'resolve' | 'reject'; - - type BeforeExitListener = (code: number) => void; - type DisconnectListener = () => void; - type ExitListener = (code: number) => void; - type RejectionHandledListener = (promise: Promise) => void; - type UncaughtExceptionListener = (error: Error) => void; - type UnhandledRejectionListener = (reason: {} | null | undefined, promise: Promise) => void; - type WarningListener = (warning: Error) => void; - type MessageListener = (message: any, sendHandle: any) => void; - type SignalsListener = (signal: Signals) => void; - type NewListenerListener = (type: string | symbol, listener: (...args: any[]) => void) => void; - type RemoveListenerListener = (type: string | symbol, listener: (...args: any[]) => void) => void; - type MultipleResolveListener = (type: MultipleResolveType, promise: Promise, value: any) => void; - - interface Socket extends ReadWriteStream { - isTTY?: true; - } - - interface ProcessEnv { - [key: string]: string | undefined; - } - - interface HRTime { - (time?: [number, number]): [number, number]; - } - - interface ProcessReport { - /** - * Directory where the report is written. - * working directory of the Node.js process. - * @default '' indicating that reports are written to the current - */ - directory: string; - - /** - * Filename where the report is written. - * The default value is the empty string. - * @default '' the output filename will be comprised of a timestamp, - * PID, and sequence number. - */ - filename: string; - - /** - * Returns a JSON-formatted diagnostic report for the running process. - * The report's JavaScript stack trace is taken from err, if present. - */ - getReport(err?: Error): string; - - /** - * If true, a diagnostic report is generated on fatal errors, - * such as out of memory errors or failed C++ assertions. - * @default false - */ - reportOnFatalError: boolean; - - /** - * If true, a diagnostic report is generated when the process - * receives the signal specified by process.report.signal. - * @defaul false - */ - reportOnSignal: boolean; - - /** - * If true, a diagnostic report is generated on uncaught exception. - * @default false - */ - reportOnUncaughtException: boolean; - - /** - * The signal used to trigger the creation of a diagnostic report. - * @default 'SIGUSR2' - */ - signal: Signals; - - /** - * Writes a diagnostic report to a file. If filename is not provided, the default filename - * includes the date, time, PID, and a sequence number. - * The report's JavaScript stack trace is taken from err, if present. - * - * @param fileName Name of the file where the report is written. - * This should be a relative path, that will be appended to the directory specified in - * `process.report.directory`, or the current working directory of the Node.js process, - * if unspecified. - * @param error A custom error used for reporting the JavaScript stack. - * @return Filename of the generated report. - */ - writeReport(fileName?: string): string; - writeReport(error?: Error): string; - writeReport(fileName?: string, err?: Error): string; - } - - interface ResourceUsage { - fsRead: number; - fsWrite: number; - involuntaryContextSwitches: number; - ipcReceived: number; - ipcSent: number; - majorPageFault: number; - maxRSS: number; - minorPageFault: number; - sharedMemorySize: number; - signalsCount: number; - swappedOut: number; - systemCPUTime: number; - unsharedDataSize: number; - unsharedStackSize: number; - userCPUTime: number; - voluntaryContextSwitches: number; - } - - interface Process extends EventEmitter { - /** - * Can also be a tty.WriteStream, not typed due to limitation.s - */ - stdout: WriteStream; - /** - * Can also be a tty.WriteStream, not typed due to limitation.s - */ - stderr: WriteStream; - stdin: ReadStream; - openStdin(): Socket; - argv: string[]; - argv0: string; - execArgv: string[]; - execPath: string; - abort(): void; - chdir(directory: string): void; - cwd(): string; - debugPort: number; - emitWarning(warning: string | Error, name?: string, ctor?: Function): void; - env: ProcessEnv; - exit(code?: number): never; - exitCode?: number; - getgid(): number; - setgid(id: number | string): void; - getuid(): number; - setuid(id: number | string): void; - geteuid(): number; - seteuid(id: number | string): void; - getegid(): number; - setegid(id: number | string): void; - getgroups(): number[]; - setgroups(groups: Array): void; - setUncaughtExceptionCaptureCallback(cb: ((err: Error) => void) | null): void; - hasUncaughtExceptionCaptureCallback(): boolean; - version: string; - versions: ProcessVersions; - config: { - target_defaults: { - cflags: any[]; - default_configuration: string; - defines: string[]; - include_dirs: string[]; - libraries: string[]; - }; - variables: { - clang: number; - host_arch: string; - node_install_npm: boolean; - node_install_waf: boolean; - node_prefix: string; - node_shared_openssl: boolean; - node_shared_v8: boolean; - node_shared_zlib: boolean; - node_use_dtrace: boolean; - node_use_etw: boolean; - node_use_openssl: boolean; - target_arch: string; - v8_no_strict_aliasing: number; - v8_use_snapshot: boolean; - visibility: string; - }; - }; - kill(pid: number, signal?: string | number): void; - pid: number; - ppid: number; - title: string; - arch: string; - platform: Platform; - mainModule?: NodeModule; - memoryUsage(): MemoryUsage; - cpuUsage(previousValue?: CpuUsage): CpuUsage; - nextTick(callback: Function, ...args: any[]): void; - release: ProcessRelease; - features: { - inspector: boolean; - debug: boolean; - uv: boolean; - ipv6: boolean; - tls_alpn: boolean; - tls_sni: boolean; - tls_ocsp: boolean; - tls: boolean; - }; - /** - * Can only be set if not in worker thread. - */ - umask(mask?: number): number; - uptime(): number; - hrtime: HRTime; - domain: Domain; - - // Worker - send?(message: any, sendHandle?: any, options?: { swallowErrors?: boolean}, callback?: (error: Error | null) => void): boolean; - disconnect(): void; - connected: boolean; - - /** - * The `process.allowedNodeEnvironmentFlags` property is a special, - * read-only `Set` of flags allowable within the [`NODE_OPTIONS`][] - * environment variable. - */ - allowedNodeEnvironmentFlags: ReadonlySet; - - /** - * Only available with `--experimental-report` - */ - report?: ProcessReport; - - resourceUsage(): ResourceUsage; - - /** - * EventEmitter - * 1. beforeExit - * 2. disconnect - * 3. exit - * 4. message - * 5. rejectionHandled - * 6. uncaughtException - * 7. unhandledRejection - * 8. warning - * 9. message - * 10. - * 11. newListener/removeListener inherited from EventEmitter - */ - addListener(event: "beforeExit", listener: BeforeExitListener): this; - addListener(event: "disconnect", listener: DisconnectListener): this; - addListener(event: "exit", listener: ExitListener): this; - addListener(event: "rejectionHandled", listener: RejectionHandledListener): this; - addListener(event: "uncaughtException", listener: UncaughtExceptionListener): this; - addListener(event: "unhandledRejection", listener: UnhandledRejectionListener): this; - addListener(event: "warning", listener: WarningListener): this; - addListener(event: "message", listener: MessageListener): this; - addListener(event: Signals, listener: SignalsListener): this; - addListener(event: "newListener", listener: NewListenerListener): this; - addListener(event: "removeListener", listener: RemoveListenerListener): this; - addListener(event: "multipleResolves", listener: MultipleResolveListener): this; - - emit(event: "beforeExit", code: number): boolean; - emit(event: "disconnect"): boolean; - emit(event: "exit", code: number): boolean; - emit(event: "rejectionHandled", promise: Promise): boolean; - emit(event: "uncaughtException", error: Error): boolean; - emit(event: "unhandledRejection", reason: any, promise: Promise): boolean; - emit(event: "warning", warning: Error): boolean; - emit(event: "message", message: any, sendHandle: any): this; - emit(event: Signals, signal: Signals): boolean; - emit(event: "newListener", eventName: string | symbol, listener: (...args: any[]) => void): this; - emit(event: "removeListener", eventName: string, listener: (...args: any[]) => void): this; - emit(event: "multipleResolves", listener: MultipleResolveListener): this; - - on(event: "beforeExit", listener: BeforeExitListener): this; - on(event: "disconnect", listener: DisconnectListener): this; - on(event: "exit", listener: ExitListener): this; - on(event: "rejectionHandled", listener: RejectionHandledListener): this; - on(event: "uncaughtException", listener: UncaughtExceptionListener): this; - on(event: "unhandledRejection", listener: UnhandledRejectionListener): this; - on(event: "warning", listener: WarningListener): this; - on(event: "message", listener: MessageListener): this; - on(event: Signals, listener: SignalsListener): this; - on(event: "newListener", listener: NewListenerListener): this; - on(event: "removeListener", listener: RemoveListenerListener): this; - on(event: "multipleResolves", listener: MultipleResolveListener): this; - - once(event: "beforeExit", listener: BeforeExitListener): this; - once(event: "disconnect", listener: DisconnectListener): this; - once(event: "exit", listener: ExitListener): this; - once(event: "rejectionHandled", listener: RejectionHandledListener): this; - once(event: "uncaughtException", listener: UncaughtExceptionListener): this; - once(event: "unhandledRejection", listener: UnhandledRejectionListener): this; - once(event: "warning", listener: WarningListener): this; - once(event: "message", listener: MessageListener): this; - once(event: Signals, listener: SignalsListener): this; - once(event: "newListener", listener: NewListenerListener): this; - once(event: "removeListener", listener: RemoveListenerListener): this; - once(event: "multipleResolves", listener: MultipleResolveListener): this; - - prependListener(event: "beforeExit", listener: BeforeExitListener): this; - prependListener(event: "disconnect", listener: DisconnectListener): this; - prependListener(event: "exit", listener: ExitListener): this; - prependListener(event: "rejectionHandled", listener: RejectionHandledListener): this; - prependListener(event: "uncaughtException", listener: UncaughtExceptionListener): this; - prependListener(event: "unhandledRejection", listener: UnhandledRejectionListener): this; - prependListener(event: "warning", listener: WarningListener): this; - prependListener(event: "message", listener: MessageListener): this; - prependListener(event: Signals, listener: SignalsListener): this; - prependListener(event: "newListener", listener: NewListenerListener): this; - prependListener(event: "removeListener", listener: RemoveListenerListener): this; - prependListener(event: "multipleResolves", listener: MultipleResolveListener): this; - - prependOnceListener(event: "beforeExit", listener: BeforeExitListener): this; - prependOnceListener(event: "disconnect", listener: DisconnectListener): this; - prependOnceListener(event: "exit", listener: ExitListener): this; - prependOnceListener(event: "rejectionHandled", listener: RejectionHandledListener): this; - prependOnceListener(event: "uncaughtException", listener: UncaughtExceptionListener): this; - prependOnceListener(event: "unhandledRejection", listener: UnhandledRejectionListener): this; - prependOnceListener(event: "warning", listener: WarningListener): this; - prependOnceListener(event: "message", listener: MessageListener): this; - prependOnceListener(event: Signals, listener: SignalsListener): this; - prependOnceListener(event: "newListener", listener: NewListenerListener): this; - prependOnceListener(event: "removeListener", listener: RemoveListenerListener): this; - prependOnceListener(event: "multipleResolves", listener: MultipleResolveListener): this; - - listeners(event: "beforeExit"): BeforeExitListener[]; - listeners(event: "disconnect"): DisconnectListener[]; - listeners(event: "exit"): ExitListener[]; - listeners(event: "rejectionHandled"): RejectionHandledListener[]; - listeners(event: "uncaughtException"): UncaughtExceptionListener[]; - listeners(event: "unhandledRejection"): UnhandledRejectionListener[]; - listeners(event: "warning"): WarningListener[]; - listeners(event: "message"): MessageListener[]; - listeners(event: Signals): SignalsListener[]; - listeners(event: "newListener"): NewListenerListener[]; - listeners(event: "removeListener"): RemoveListenerListener[]; - listeners(event: "multipleResolves"): MultipleResolveListener[]; - } - interface Global { Array: typeof Array; ArrayBuffer: typeof ArrayBuffer; @@ -1054,7 +477,6 @@ declare namespace NodeJS { Float32Array: typeof Float32Array; Float64Array: typeof Float64Array; Function: typeof Function; - GLOBAL: Global; Infinity: typeof Infinity; Int16Array: typeof Int16Array; Int32Array: typeof Int32Array; @@ -1066,7 +488,7 @@ declare namespace NodeJS { NaN: typeof NaN; Number: typeof Number; Object: typeof Object; - Promise: Function; + Promise: typeof Promise; RangeError: typeof RangeError; ReferenceError: typeof ReferenceError; RegExp: typeof RegExp; @@ -1079,13 +501,12 @@ declare namespace NodeJS { Uint16Array: typeof Uint16Array; Uint32Array: typeof Uint32Array; Uint8Array: typeof Uint8Array; - Uint8ClampedArray: Function; + Uint8ClampedArray: typeof Uint8ClampedArray; WeakMap: WeakMapConstructor; WeakSet: WeakSetConstructor; clearImmediate: (immediateId: Immediate) => void; clearInterval: (intervalId: Timeout) => void; clearTimeout: (timeoutId: Timeout) => void; - console: typeof console; decodeURI: typeof decodeURI; decodeURIComponent: typeof decodeURIComponent; encodeURI: typeof encodeURI; @@ -1097,8 +518,6 @@ declare namespace NodeJS { isNaN: typeof isNaN; parseFloat: typeof parseFloat; parseInt: typeof parseInt; - process: Process; - root: Global; setImmediate: (callback: (...args: any[]) => void, ...args: any[]) => Immediate; setInterval: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => Timeout; setTimeout: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => Timeout; @@ -1109,57 +528,87 @@ declare namespace NodeJS { v8debug?: any; } - // compatibility with older typings - interface Timer { - hasRef(): boolean; + interface RefCounted { ref(): this; - refresh(): this; unref(): this; } - class Immediate { + // compatibility with older typings + interface Timer extends RefCounted { + hasRef(): boolean; + refresh(): this; + [Symbol.toPrimitive](): number; + } + + interface Immediate extends RefCounted { hasRef(): boolean; - ref(): this; - unref(): this; _onImmediate: Function; // to distinguish it from the Timeout class } - class Timeout implements Timer { + interface Timeout extends Timer { hasRef(): boolean; - ref(): this; refresh(): this; - unref(): this; + [Symbol.toPrimitive](): number; } - class Module { - static runMain(): void; - static wrap(code: string): string; + type TypedArray = + | Uint8Array + | Uint8ClampedArray + | Uint16Array + | Uint32Array + | Int8Array + | Int16Array + | Int32Array + | BigUint64Array + | BigInt64Array + | Float32Array + | Float64Array; + type ArrayBufferView = TypedArray | DataView; + interface Require { + (id: string): any; + resolve: RequireResolve; + cache: Dict; /** - * @deprecated Deprecated since: v12.2.0. Please use createRequire() instead. + * @deprecated */ - static createRequireFromPath(path: string): NodeRequire; - static createRequire(path: string): NodeRequire; - static builtinModules: string[]; + extensions: RequireExtensions; + main: Module | undefined; + } - static Module: typeof Module; + interface RequireResolve { + (id: string, options?: { paths?: string[]; }): string; + paths(request: string): string[] | null; + } + interface RequireExtensions extends Dict<(m: Module, filename: string) => any> { + '.js': (m: Module, filename: string) => any; + '.json': (m: Module, filename: string) => any; + '.node': (m: Module, filename: string) => any; + } + interface Module { exports: any; - require: NodeRequireFunction; + require: Require; id: string; filename: string; loaded: boolean; - parent: Module | null; + /** @deprecated since 14.6.0 Please use `require.main` and `module.children` instead. */ + parent: Module | null | undefined; children: Module[]; + /** + * @since 11.14.0 + * + * The directory name of the module. This is usually the same as the path.dirname() of the module.id. + */ + path: string; paths: string[]; - - constructor(id: string, parent?: Module); } - type TypedArray = Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array; - type ArrayBufferView = TypedArray | DataView; + interface Dict { + [key: string]: T | undefined; + } - // The value type here is a "poor man's `unknown`". When these types support TypeScript - // 3.0+, we can replace this with `unknown`. - type PoorMansUnknown = {} | null | undefined; + interface ReadOnlyDict { + readonly [key: string]: T | undefined; + } } diff --git a/node_modules/@types/node/globals.global.d.ts b/node_modules/@types/node/globals.global.d.ts new file mode 100644 index 0000000..d66acba --- /dev/null +++ b/node_modules/@types/node/globals.global.d.ts @@ -0,0 +1 @@ +declare var global: NodeJS.Global & typeof globalThis; diff --git a/node_modules/@types/node/http.d.ts b/node_modules/@types/node/http.d.ts index 65ea677..4daa055 100644 --- a/node_modules/@types/node/http.d.ts +++ b/node_modules/@types/node/http.d.ts @@ -1,11 +1,10 @@ declare module "http" { - import * as events from "events"; import * as stream from "stream"; import { URL } from "url"; import { Socket, Server as NetServer } from "net"; // incoming headers will never contain number - interface IncomingHttpHeaders { + interface IncomingHttpHeaders extends NodeJS.Dict { 'accept'?: string; 'accept-language'?: string; 'accept-patch'?: string; @@ -16,6 +15,8 @@ declare module "http" { 'access-control-allow-origin'?: string; 'access-control-expose-headers'?: string; 'access-control-max-age'?: string; + 'access-control-request-headers'?: string; + 'access-control-request-method'?: string; 'age'?: string; 'allow'?: string; 'alt-svc'?: string; @@ -42,6 +43,7 @@ declare module "http" { 'if-unmodified-since'?: string; 'last-modified'?: string; 'location'?: string; + 'origin'?: string; 'pragma'?: string; 'proxy-authenticate'?: string; 'proxy-authorization'?: string; @@ -49,6 +51,11 @@ declare module "http" { 'range'?: string; 'referer'?: string; 'retry-after'?: string; + 'sec-websocket-accept'?: string; + 'sec-websocket-extensions'?: string; + 'sec-websocket-key'?: string; + 'sec-websocket-protocol'?: string; + 'sec-websocket-version'?: string; 'set-cookie'?: string[]; 'strict-transport-security'?: string; 'tk'?: string; @@ -60,12 +67,12 @@ declare module "http" { 'via'?: string; 'warning'?: string; 'www-authenticate'?: string; - [header: string]: string | string[] | undefined; } // outgoing headers allows numbers (as they are converted internally to strings) - interface OutgoingHttpHeaders { - [header: string]: number | string | string[] | undefined; + type OutgoingHttpHeader = number | string | string[]; + + interface OutgoingHttpHeaders extends NodeJS.Dict { } interface ClientRequestArgs { @@ -77,6 +84,10 @@ declare module "http" { defaultPort?: number | string; localAddress?: string; socketPath?: string; + /** + * @default 8192 + */ + maxHeaderSize?: number; method?: string; path?: string | null; headers?: OutgoingHttpHeaders; @@ -92,14 +103,25 @@ declare module "http" { interface ServerOptions { IncomingMessage?: typeof IncomingMessage; ServerResponse?: typeof ServerResponse; + /** + * Optionally overrides the value of + * [`--max-http-header-size`][] for requests received by this server, i.e. + * the maximum length of request headers in bytes. + * @default 8192 + */ + maxHeaderSize?: number; + /** + * Use an insecure HTTP parser that accepts invalid HTTP headers when true. + * Using the insecure parser should be avoided. + * See --insecure-http-parser for more information. + * @default false + */ + insecureHTTPParser?: boolean; } type RequestListener = (req: IncomingMessage, res: ServerResponse) => void; - class Server extends NetServer { - constructor(requestListener?: RequestListener); - constructor(options: ServerOptions, requestListener?: RequestListener); - + interface HttpBase { setTimeout(msecs?: number, callback?: () => void): this; setTimeout(callback: () => void): this; /** @@ -111,11 +133,23 @@ declare module "http" { timeout: number; /** * Limit the amount of time the parser will wait to receive the complete HTTP headers. - * @default 40000 + * @default 60000 * {@link https://nodejs.org/api/http.html#http_server_headerstimeout} */ headersTimeout: number; keepAliveTimeout: number; + /** + * Sets the timeout value in milliseconds for receiving the entire request from the client. + * @default 0 + * {@link https://nodejs.org/api/http.html#http_server_requesttimeout} + */ + requestTimeout: number; + } + + interface Server extends HttpBase {} + class Server extends NetServer { + constructor(requestListener?: RequestListener); + constructor(options: ServerOptions, requestListener?: RequestListener); } // https://github.com/nodejs/node/blob/master/lib/_http_outgoing.js @@ -125,20 +159,27 @@ declare module "http" { shouldKeepAlive: boolean; useChunkedEncodingByDefault: boolean; sendDate: boolean; + /** + * @deprecated Use `writableEnded` instead. + */ finished: boolean; headersSent: boolean; - connection: Socket; + /** + * @deprecate Use `socket` instead. + */ + connection: Socket | null; + socket: Socket | null; constructor(); setTimeout(msecs: number, callback?: () => void): this; - setHeader(name: string, value: number | string | string[]): void; + setHeader(name: string, value: number | string | ReadonlyArray): void; getHeader(name: string): number | string | string[] | undefined; getHeaders(): OutgoingHttpHeaders; getHeaderNames(): string[]; hasHeader(name: string): boolean; removeHeader(name: string): void; - addTrailers(headers: OutgoingHttpHeaders | Array<[string, string]>): void; + addTrailers(headers: OutgoingHttpHeaders | ReadonlyArray<[string, string]>): void; flushHeaders(): void; } @@ -146,7 +187,6 @@ declare module "http" { class ServerResponse extends OutgoingMessage { statusCode: number; statusMessage: string; - writableFinished: boolean; constructor(req: IncomingMessage); @@ -155,8 +195,9 @@ declare module "http" { // https://github.com/nodejs/node/blob/master/test/parallel/test-http-write-callbacks.js#L53 // no args in writeContinue callback writeContinue(callback?: () => void): void; - writeHead(statusCode: number, reasonPhrase?: string, headers?: OutgoingHttpHeaders): this; - writeHead(statusCode: number, headers?: OutgoingHttpHeaders): this; + writeHead(statusCode: number, reasonPhrase?: string, headers?: OutgoingHttpHeaders | OutgoingHttpHeader[]): this; + writeHead(statusCode: number, headers?: OutgoingHttpHeaders | OutgoingHttpHeader[]): this; + writeProcessing(): void; } interface InformationEvent { @@ -171,13 +212,15 @@ declare module "http" { // https://github.com/nodejs/node/blob/master/lib/_http_client.js#L77 class ClientRequest extends OutgoingMessage { - connection: Socket; - socket: Socket; - aborted: number; + aborted: boolean; + host: string; + protocol: string; constructor(url: string | URL | ClientRequestArgs, cb?: (res: IncomingMessage) => void); - readonly path: string; + method: string; + path: string; + /** @deprecated since v14.1.0 Use `request.destroy()` instead. */ abort(): void; onSocket(socket: Socket): void; setTimeout(timeout: number, callback?: () => void): this; @@ -268,14 +311,19 @@ declare module "http" { class IncomingMessage extends stream.Readable { constructor(socket: Socket); + aborted: boolean; httpVersion: string; httpVersionMajor: number; httpVersionMinor: number; complete: boolean; + /** + * @deprecated since v13.0.0 - Use `socket` instead. + */ connection: Socket; + socket: Socket; headers: IncomingHttpHeaders; rawHeaders: string[]; - trailers: { [key: string]: string | undefined }; + trailers: NodeJS.Dict; rawTrailers: string[]; setTimeout(msecs: number, callback?: () => void): this; /** @@ -294,7 +342,6 @@ declare module "http" { * Only valid for response obtained from http.ClientRequest. */ statusMessage?: string; - socket: Socket; destroy(error?: Error): void; } @@ -312,6 +359,10 @@ declare module "http" { * Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity */ maxSockets?: number; + /** + * Maximum number of sockets allowed for all hosts in total. Each request will use a new socket until the maximum is reached. Default: Infinity. + */ + maxTotalSockets?: number; /** * Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256. */ @@ -320,17 +371,19 @@ declare module "http" { * Socket timeout in milliseconds. This will set the timeout after the socket is connected. */ timeout?: number; + /** + * Scheduling strategy to apply when picking the next free socket to use. Default: 'fifo'. + */ + scheduling?: 'fifo' | 'lifo'; } class Agent { maxFreeSockets: number; maxSockets: number; - readonly sockets: { - readonly [key: string]: Socket[]; - }; - readonly requests: { - readonly [key: string]: IncomingMessage[]; - }; + maxTotalSockets: number; + readonly freeSockets: NodeJS.ReadOnlyDict; + readonly sockets: NodeJS.ReadOnlyDict; + readonly requests: NodeJS.ReadOnlyDict; constructor(opts?: AgentOptions); @@ -364,7 +417,7 @@ declare module "http" { /** * Read-only property specifying the maximum allowed size of HTTP headers in bytes. - * Defaults to 8KB. Configurable using the [`--max-http-header-size`][] CLI option. + * Defaults to 16KB. Configurable using the [`--max-http-header-size`][] CLI option. */ const maxHeaderSize: number; } diff --git a/node_modules/@types/node/http2.d.ts b/node_modules/@types/node/http2.d.ts index 8c16e10..c95c4f1 100644 --- a/node_modules/@types/node/http2.d.ts +++ b/node_modules/@types/node/http2.d.ts @@ -281,6 +281,7 @@ declare module "http2" { ping(callback: (err: Error | null, duration: number, payload: Buffer) => void): boolean; ping(payload: NodeJS.ArrayBufferView, callback: (err: Error | null, duration: number, payload: Buffer) => void): boolean; ref(): void; + setLocalWindowSize(windowSize: number): void; setTimeout(msecs: number, callback?: () => void): void; settings(settings: Settings): void; unref(): void; @@ -356,7 +357,7 @@ declare module "http2" { addListener(event: string | symbol, listener: (...args: any[]) => void): this; emit(event: "altsvc", alt: string, origin: string, stream: number): boolean; - emit(event: "origin", origins: string[]): boolean; + emit(event: "origin", origins: ReadonlyArray): boolean; emit(event: "connect", session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket): boolean; emit(event: "stream", stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number): boolean; emit(event: string | symbol, ...args: any[]): boolean; @@ -440,6 +441,7 @@ declare module "http2" { export interface ClientSessionOptions extends SessionOptions { maxReservedRemoteStreams?: number; createConnection?: (authority: url.URL, option: SessionOptions) => stream.Duplex; + protocol?: 'http:' | 'https:'; } export interface ServerSessionOptions extends SessionOptions { @@ -570,12 +572,16 @@ declare module "http2" { } export class Http2ServerRequest extends stream.Readable { - constructor(stream: ServerHttp2Stream, headers: IncomingHttpHeaders, options: stream.ReadableOptions, rawHeaders: string[]); + constructor(stream: ServerHttp2Stream, headers: IncomingHttpHeaders, options: stream.ReadableOptions, rawHeaders: ReadonlyArray); readonly aborted: boolean; readonly authority: string; + readonly connection: net.Socket | tls.TLSSocket; + readonly complete: boolean; readonly headers: IncomingHttpHeaders; readonly httpVersion: string; + readonly httpVersionMinor: number; + readonly httpVersionMajor: number; readonly method: string; readonly rawHeaders: string[]; readonly rawTrailers: string[]; @@ -651,16 +657,16 @@ declare module "http2" { addTrailers(trailers: OutgoingHttpHeaders): void; end(callback?: () => void): void; end(data: string | Uint8Array, callback?: () => void): void; - end(data: string | Uint8Array, encoding: string, callback?: () => void): void; + end(data: string | Uint8Array, encoding: BufferEncoding, callback?: () => void): void; getHeader(name: string): string; getHeaderNames(): string[]; getHeaders(): OutgoingHttpHeaders; hasHeader(name: string): boolean; removeHeader(name: string): void; - setHeader(name: string, value: number | string | string[]): void; + setHeader(name: string, value: number | string | ReadonlyArray): void; setTimeout(msecs: number, callback?: () => void): void; write(chunk: string | Uint8Array, callback?: (err: Error) => void): boolean; - write(chunk: string | Uint8Array, encoding: string, callback?: (err: Error) => void): boolean; + write(chunk: string | Uint8Array, encoding: BufferEncoding, callback?: (err: Error) => void): boolean; writeContinue(): void; writeHead(statusCode: number, headers?: OutgoingHttpHeaders): this; writeHead(statusCode: number, statusMessage: string, headers?: OutgoingHttpHeaders): this; diff --git a/node_modules/@types/node/https.d.ts b/node_modules/@types/node/https.d.ts index 6f33dbd..24326c9 100644 --- a/node_modules/@types/node/https.d.ts +++ b/node_modules/@types/node/https.d.ts @@ -21,26 +21,10 @@ declare module "https" { options: AgentOptions; } + interface Server extends http.HttpBase {} class Server extends tls.Server { constructor(requestListener?: http.RequestListener); constructor(options: ServerOptions, requestListener?: http.RequestListener); - - setTimeout(callback: () => void): this; - setTimeout(msecs?: number, callback?: () => void): this; - /** - * Limits maximum incoming headers count. If set to 0, no limit will be applied. - * @default 2000 - * {@link https://nodejs.org/api/http.html#http_server_maxheaderscount} - */ - maxHeadersCount: number | null; - timeout: number; - /** - * Limit the amount of time the parser will wait to receive the complete HTTP headers. - * @default 40000 - * {@link https://nodejs.org/api/http.html#http_server_headerstimeout} - */ - headersTimeout: number; - keepAliveTimeout: number; } function createServer(requestListener?: http.RequestListener): Server; diff --git a/node_modules/@types/node/index.d.ts b/node_modules/@types/node/index.d.ts index f4d3a9b..0021e58 100644 --- a/node_modules/@types/node/index.d.ts +++ b/node_modules/@types/node/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for non-npm package Node.js 12.12 +// Type definitions for non-npm package Node.js 14.14 // Project: http://nodejs.org/ // Definitions by: Microsoft TypeScript // DefinitelyTyped @@ -9,7 +9,6 @@ // Benjamin Toueg // Bruno Scheufler // Chigozirim C. -// Christian Vaagland Tellnes // David Junger // Deividas Bakanas // Eugene Y. Q. Shen @@ -23,7 +22,6 @@ // Mariusz Wiktorczyk // Mohsen Azimi // Nicolas Even -// Nicolas Voigt // Nikita Galkin // Parambir Singh // Sebastian Silbermann @@ -31,7 +29,6 @@ // Thomas den Hollander // Wilco Bakker // wwwy3y3 -// Zane Hannan AU // Samuel Ainsworth // Kyle Uehlein // Jordi Oliveras Rovira @@ -40,64 +37,26 @@ // Trivikram Kamat // Minh Son Nguyen // Junxiao Shi +// Ilia Baryshnikov +// ExE Boss +// Surasak Chaisurin +// Piotr Błażejewicz +// Anna Henningsen +// Jason Kwok +// Victor Perin +// Yongsheng Zhang // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// NOTE: These definitions support NodeJS and TypeScript 3.2. +// NOTE: These definitions support NodeJS and TypeScript 3.7. +// Typically type modifications should be made in base.d.ts instead of here + +/// // NOTE: TypeScript version-specific augmentations can be found in the following paths: // - ~/base.d.ts - Shared definitions common to all TypeScript versions -// - ~/index.d.ts - Definitions specific to TypeScript 2.1 -// - ~/ts3.2/index.d.ts - Definitions specific to TypeScript 3.2 +// - ~/index.d.ts - Definitions specific to TypeScript 2.8 +// - ~/ts3.5/index.d.ts - Definitions specific to TypeScript 3.5 -// NOTE: Augmentations for TypeScript 3.2 and later should use individual files for overrides -// within the respective ~/ts3.2 (or later) folder. However, this is disallowed for versions -// prior to TypeScript 3.2, so the older definitions will be found here. - -// Base definitions for all NodeJS modules that are not specific to any version of TypeScript: -/// - -// TypeScript 2.1-specific augmentations: - -// Forward-declarations for needed types from es2015 and later (in case users are using `--lib es5`) -// Empty interfaces are used here which merge fine with the real declarations in the lib XXX files -// just to ensure the names are known and node typings can be sued without importing these libs. -// if someone really needs these types the libs need to be added via --lib or in tsconfig.json -interface MapConstructor { } -interface WeakMapConstructor { } -interface SetConstructor { } -interface WeakSetConstructor { } -interface Set {} -interface Map {} -interface ReadonlySet {} -interface Iterable { } -interface IteratorResult { } -interface AsyncIterable { } -interface Iterator { - next(value?: any): IteratorResult; -} -interface IterableIterator { } -interface AsyncIterableIterator {} -interface SymbolConstructor { - readonly iterator: symbol; - readonly asyncIterator: symbol; -} -declare var Symbol: SymbolConstructor; -// even this is just a forward declaration some properties are added otherwise -// it would be allowed to pass anything to e.g. Buffer.from() -interface SharedArrayBuffer { - readonly byteLength: number; - slice(begin?: number, end?: number): SharedArrayBuffer; -} - -declare module "util" { - namespace inspect { - const custom: symbol; - } - namespace promisify { - const custom: symbol; - } - namespace types { - function isBigInt64Array(value: any): boolean; - function isBigUint64Array(value: any): boolean; - } -} +// NOTE: Augmentations for TypeScript 3.5 and later should use individual files for overrides +// within the respective ~/ts3.5 (or later) folder. However, this is disallowed for versions +// prior to TypeScript 3.5, so the older definitions will be found here. diff --git a/node_modules/@types/node/inspector.d.ts b/node_modules/@types/node/inspector.d.ts index b14aed2..1c57734 100644 --- a/node_modules/@types/node/inspector.d.ts +++ b/node_modules/@types/node/inspector.d.ts @@ -3031,4 +3031,11 @@ declare module "inspector" { * Return the URL of the active inspector, or `undefined` if there is none. */ function url(): string | undefined; + + /** + * Blocks until a client (existing or connected later) has sent + * `Runtime.runIfWaitingForDebugger` command. + * An exception will be thrown if there is no active inspector. + */ + function waitForDebugger(): void; } diff --git a/node_modules/@types/node/module.d.ts b/node_modules/@types/node/module.d.ts index f512be7..ffb4a6e 100644 --- a/node_modules/@types/node/module.d.ts +++ b/node_modules/@types/node/module.d.ts @@ -1,3 +1,52 @@ declare module "module" { - export = NodeJS.Module; + import { URL } from "url"; + namespace Module { + /** + * Updates all the live bindings for builtin ES Modules to match the properties of the CommonJS exports. + * It does not add or remove exported names from the ES Modules. + */ + function syncBuiltinESMExports(): void; + + function findSourceMap(path: string, error?: Error): SourceMap; + interface SourceMapPayload { + file: string; + version: number; + sources: string[]; + sourcesContent: string[]; + names: string[]; + mappings: string; + sourceRoot: string; + } + + interface SourceMapping { + generatedLine: number; + generatedColumn: number; + originalSource: string; + originalLine: number; + originalColumn: number; + } + + class SourceMap { + readonly payload: SourceMapPayload; + constructor(payload: SourceMapPayload); + findEntry(line: number, column: number): SourceMapping; + } + } + interface Module extends NodeModule {} + class Module { + static runMain(): void; + static wrap(code: string): string; + + /** + * @deprecated Deprecated since: v12.2.0. Please use createRequire() instead. + */ + static createRequireFromPath(path: string): NodeRequire; + static createRequire(path: string | URL): NodeRequire; + static builtinModules: string[]; + + static Module: typeof Module; + + constructor(id: string, parent?: Module); + } + export = Module; } diff --git a/node_modules/@types/node/net.d.ts b/node_modules/@types/node/net.d.ts index 1e4f971..8738171 100644 --- a/node_modules/@types/node/net.d.ts +++ b/node_modules/@types/node/net.d.ts @@ -58,23 +58,24 @@ declare module "net" { // Extended base methods write(buffer: Uint8Array | string, cb?: (err?: Error) => void): boolean; - write(str: Uint8Array | string, encoding?: string, cb?: (err?: Error) => void): boolean; + write(str: Uint8Array | string, encoding?: BufferEncoding, cb?: (err?: Error) => void): boolean; connect(options: SocketConnectOpts, connectionListener?: () => void): this; connect(port: number, host: string, connectionListener?: () => void): this; connect(port: number, connectionListener?: () => void): this; connect(path: string, connectionListener?: () => void): this; - setEncoding(encoding?: string): this; + setEncoding(encoding?: BufferEncoding): this; pause(): this; resume(): this; setTimeout(timeout: number, callback?: () => void): this; setNoDelay(noDelay?: boolean): this; setKeepAlive(enable?: boolean, initialDelay?: number): this; - address(): AddressInfo | string; - unref(): void; - ref(): void; + address(): AddressInfo | {}; + unref(): this; + ref(): this; + /** @deprecated since v14.6.0 - Use `writableLength` instead. */ readonly bufferSize: number; readonly bytesRead: number; readonly bytesWritten: number; @@ -89,7 +90,7 @@ declare module "net" { // Extended base methods end(cb?: () => void): void; end(buffer: Uint8Array | string, cb?: () => void): void; - end(str: Uint8Array | string, encoding?: string, cb?: () => void): void; + end(str: Uint8Array | string, encoding?: BufferEncoding, cb?: () => void): void; /** * events.EventEmitter diff --git a/node_modules/@types/node/os.d.ts b/node_modules/@types/node/os.d.ts index 37c45a9..1aadc68 100644 --- a/node_modules/@types/node/os.d.ts +++ b/node_modules/@types/node/os.d.ts @@ -46,201 +46,177 @@ declare module "os" { function cpus(): CpuInfo[]; function type(): string; function release(): string; - function networkInterfaces(): { [index: string]: NetworkInterfaceInfo[] }; + function networkInterfaces(): NodeJS.Dict; function homedir(): string; function userInfo(options: { encoding: 'buffer' }): UserInfo; - function userInfo(options?: { encoding: string }): UserInfo; - const constants: { - UV_UDP_REUSEADDR: number; - // signals: { [key in NodeJS.Signals]: number; }; @todo: change after migration to typescript 2.1 - signals: { - SIGHUP: number; - SIGINT: number; - SIGQUIT: number; - SIGILL: number; - SIGTRAP: number; - SIGABRT: number; - SIGIOT: number; - SIGBUS: number; - SIGFPE: number; - SIGKILL: number; - SIGUSR1: number; - SIGSEGV: number; - SIGUSR2: number; - SIGPIPE: number; - SIGALRM: number; - SIGTERM: number; - SIGCHLD: number; - SIGSTKFLT: number; - SIGCONT: number; - SIGSTOP: number; - SIGTSTP: number; - SIGBREAK: number; - SIGTTIN: number; - SIGTTOU: number; - SIGURG: number; - SIGXCPU: number; - SIGXFSZ: number; - SIGVTALRM: number; - SIGPROF: number; - SIGWINCH: number; - SIGIO: number; - SIGPOLL: number; - SIGLOST: number; - SIGPWR: number; - SIGINFO: number; - SIGSYS: number; - SIGUNUSED: number; - }; - errno: { - E2BIG: number; - EACCES: number; - EADDRINUSE: number; - EADDRNOTAVAIL: number; - EAFNOSUPPORT: number; - EAGAIN: number; - EALREADY: number; - EBADF: number; - EBADMSG: number; - EBUSY: number; - ECANCELED: number; - ECHILD: number; - ECONNABORTED: number; - ECONNREFUSED: number; - ECONNRESET: number; - EDEADLK: number; - EDESTADDRREQ: number; - EDOM: number; - EDQUOT: number; - EEXIST: number; - EFAULT: number; - EFBIG: number; - EHOSTUNREACH: number; - EIDRM: number; - EILSEQ: number; - EINPROGRESS: number; - EINTR: number; - EINVAL: number; - EIO: number; - EISCONN: number; - EISDIR: number; - ELOOP: number; - EMFILE: number; - EMLINK: number; - EMSGSIZE: number; - EMULTIHOP: number; - ENAMETOOLONG: number; - ENETDOWN: number; - ENETRESET: number; - ENETUNREACH: number; - ENFILE: number; - ENOBUFS: number; - ENODATA: number; - ENODEV: number; - ENOENT: number; - ENOEXEC: number; - ENOLCK: number; - ENOLINK: number; - ENOMEM: number; - ENOMSG: number; - ENOPROTOOPT: number; - ENOSPC: number; - ENOSR: number; - ENOSTR: number; - ENOSYS: number; - ENOTCONN: number; - ENOTDIR: number; - ENOTEMPTY: number; - ENOTSOCK: number; - ENOTSUP: number; - ENOTTY: number; - ENXIO: number; - EOPNOTSUPP: number; - EOVERFLOW: number; - EPERM: number; - EPIPE: number; - EPROTO: number; - EPROTONOSUPPORT: number; - EPROTOTYPE: number; - ERANGE: number; - EROFS: number; - ESPIPE: number; - ESRCH: number; - ESTALE: number; - ETIME: number; - ETIMEDOUT: number; - ETXTBSY: number; - EWOULDBLOCK: number; - EXDEV: number; - WSAEINTR: number; - WSAEBADF: number; - WSAEACCES: number; - WSAEFAULT: number; - WSAEINVAL: number; - WSAEMFILE: number; - WSAEWOULDBLOCK: number; - WSAEINPROGRESS: number; - WSAEALREADY: number; - WSAENOTSOCK: number; - WSAEDESTADDRREQ: number; - WSAEMSGSIZE: number; - WSAEPROTOTYPE: number; - WSAENOPROTOOPT: number; - WSAEPROTONOSUPPORT: number; - WSAESOCKTNOSUPPORT: number; - WSAEOPNOTSUPP: number; - WSAEPFNOSUPPORT: number; - WSAEAFNOSUPPORT: number; - WSAEADDRINUSE: number; - WSAEADDRNOTAVAIL: number; - WSAENETDOWN: number; - WSAENETUNREACH: number; - WSAENETRESET: number; - WSAECONNABORTED: number; - WSAECONNRESET: number; - WSAENOBUFS: number; - WSAEISCONN: number; - WSAENOTCONN: number; - WSAESHUTDOWN: number; - WSAETOOMANYREFS: number; - WSAETIMEDOUT: number; - WSAECONNREFUSED: number; - WSAELOOP: number; - WSAENAMETOOLONG: number; - WSAEHOSTDOWN: number; - WSAEHOSTUNREACH: number; - WSAENOTEMPTY: number; - WSAEPROCLIM: number; - WSAEUSERS: number; - WSAEDQUOT: number; - WSAESTALE: number; - WSAEREMOTE: number; - WSASYSNOTREADY: number; - WSAVERNOTSUPPORTED: number; - WSANOTINITIALISED: number; - WSAEDISCON: number; - WSAENOMORE: number; - WSAECANCELLED: number; - WSAEINVALIDPROCTABLE: number; - WSAEINVALIDPROVIDER: number; - WSAEPROVIDERFAILEDINIT: number; - WSASYSCALLFAILURE: number; - WSASERVICE_NOT_FOUND: number; - WSATYPE_NOT_FOUND: number; - WSA_E_NO_MORE: number; - WSA_E_CANCELLED: number; - WSAEREFUSED: number; - }; - priority: { - PRIORITY_LOW: number; - PRIORITY_BELOW_NORMAL: number; - PRIORITY_NORMAL: number; - PRIORITY_ABOVE_NORMAL: number; - PRIORITY_HIGH: number; - PRIORITY_HIGHEST: number; - } + function userInfo(options?: { encoding: BufferEncoding }): UserInfo; + + type SignalConstants = { + [key in NodeJS.Signals]: number; }; + + namespace constants { + const UV_UDP_REUSEADDR: number; + namespace signals {} + const signals: SignalConstants; + namespace errno { + const E2BIG: number; + const EACCES: number; + const EADDRINUSE: number; + const EADDRNOTAVAIL: number; + const EAFNOSUPPORT: number; + const EAGAIN: number; + const EALREADY: number; + const EBADF: number; + const EBADMSG: number; + const EBUSY: number; + const ECANCELED: number; + const ECHILD: number; + const ECONNABORTED: number; + const ECONNREFUSED: number; + const ECONNRESET: number; + const EDEADLK: number; + const EDESTADDRREQ: number; + const EDOM: number; + const EDQUOT: number; + const EEXIST: number; + const EFAULT: number; + const EFBIG: number; + const EHOSTUNREACH: number; + const EIDRM: number; + const EILSEQ: number; + const EINPROGRESS: number; + const EINTR: number; + const EINVAL: number; + const EIO: number; + const EISCONN: number; + const EISDIR: number; + const ELOOP: number; + const EMFILE: number; + const EMLINK: number; + const EMSGSIZE: number; + const EMULTIHOP: number; + const ENAMETOOLONG: number; + const ENETDOWN: number; + const ENETRESET: number; + const ENETUNREACH: number; + const ENFILE: number; + const ENOBUFS: number; + const ENODATA: number; + const ENODEV: number; + const ENOENT: number; + const ENOEXEC: number; + const ENOLCK: number; + const ENOLINK: number; + const ENOMEM: number; + const ENOMSG: number; + const ENOPROTOOPT: number; + const ENOSPC: number; + const ENOSR: number; + const ENOSTR: number; + const ENOSYS: number; + const ENOTCONN: number; + const ENOTDIR: number; + const ENOTEMPTY: number; + const ENOTSOCK: number; + const ENOTSUP: number; + const ENOTTY: number; + const ENXIO: number; + const EOPNOTSUPP: number; + const EOVERFLOW: number; + const EPERM: number; + const EPIPE: number; + const EPROTO: number; + const EPROTONOSUPPORT: number; + const EPROTOTYPE: number; + const ERANGE: number; + const EROFS: number; + const ESPIPE: number; + const ESRCH: number; + const ESTALE: number; + const ETIME: number; + const ETIMEDOUT: number; + const ETXTBSY: number; + const EWOULDBLOCK: number; + const EXDEV: number; + const WSAEINTR: number; + const WSAEBADF: number; + const WSAEACCES: number; + const WSAEFAULT: number; + const WSAEINVAL: number; + const WSAEMFILE: number; + const WSAEWOULDBLOCK: number; + const WSAEINPROGRESS: number; + const WSAEALREADY: number; + const WSAENOTSOCK: number; + const WSAEDESTADDRREQ: number; + const WSAEMSGSIZE: number; + const WSAEPROTOTYPE: number; + const WSAENOPROTOOPT: number; + const WSAEPROTONOSUPPORT: number; + const WSAESOCKTNOSUPPORT: number; + const WSAEOPNOTSUPP: number; + const WSAEPFNOSUPPORT: number; + const WSAEAFNOSUPPORT: number; + const WSAEADDRINUSE: number; + const WSAEADDRNOTAVAIL: number; + const WSAENETDOWN: number; + const WSAENETUNREACH: number; + const WSAENETRESET: number; + const WSAECONNABORTED: number; + const WSAECONNRESET: number; + const WSAENOBUFS: number; + const WSAEISCONN: number; + const WSAENOTCONN: number; + const WSAESHUTDOWN: number; + const WSAETOOMANYREFS: number; + const WSAETIMEDOUT: number; + const WSAECONNREFUSED: number; + const WSAELOOP: number; + const WSAENAMETOOLONG: number; + const WSAEHOSTDOWN: number; + const WSAEHOSTUNREACH: number; + const WSAENOTEMPTY: number; + const WSAEPROCLIM: number; + const WSAEUSERS: number; + const WSAEDQUOT: number; + const WSAESTALE: number; + const WSAEREMOTE: number; + const WSASYSNOTREADY: number; + const WSAVERNOTSUPPORTED: number; + const WSANOTINITIALISED: number; + const WSAEDISCON: number; + const WSAENOMORE: number; + const WSAECANCELLED: number; + const WSAEINVALIDPROCTABLE: number; + const WSAEINVALIDPROVIDER: number; + const WSAEPROVIDERFAILEDINIT: number; + const WSASYSCALLFAILURE: number; + const WSASERVICE_NOT_FOUND: number; + const WSATYPE_NOT_FOUND: number; + const WSA_E_NO_MORE: number; + const WSA_E_CANCELLED: number; + const WSAEREFUSED: number; + } + namespace priority { + const PRIORITY_LOW: number; + const PRIORITY_BELOW_NORMAL: number; + const PRIORITY_NORMAL: number; + const PRIORITY_ABOVE_NORMAL: number; + const PRIORITY_HIGH: number; + const PRIORITY_HIGHEST: number; + } + } + function arch(): string; + /** + * Returns a string identifying the kernel version. + * On POSIX systems, the operating system release is determined by calling + * [uname(3)][]. On Windows, `pRtlGetVersion` is used, and if it is not available, + * `GetVersionExW()` will be used. See + * https://en.wikipedia.org/wiki/Uname#Examples for more information. + */ + function version(): string; function platform(): NodeJS.Platform; function tmpdir(): string; const EOL: string; diff --git a/node_modules/@types/node/package.json b/node_modules/@types/node/package.json index 440f065..d8b6e99 100644 --- a/node_modules/@types/node/package.json +++ b/node_modules/@types/node/package.json @@ -1,34 +1,37 @@ { - "_from": "@types/node@12.12.11", - "_id": "@types/node@12.12.11", + "_args": [ + [ + "@types/node@14.14.22", + "." + ] + ], + "_from": "@types/node@14.14.22", + "_id": "@types/node@14.14.22", "_inBundle": false, - "_integrity": "sha512-O+x6uIpa6oMNTkPuHDa9MhMMehlxLAd5QcOvKRjAFsBVpeFWTOPnXbDvILvFgFFZfQ1xh1EZi1FbXxUix+zpsQ==", + "_integrity": "sha512-g+f/qj/cNcqKkc3tFqlXOYjrmZA+jNBiDzbP3kH+B+otKFqAdPgVTGP1IeKRdMml/aE69as5S4FqtxAbl+LaMw==", "_location": "/@types/node", "_phantomChildren": {}, "_requested": { "type": "version", "registry": true, - "raw": "@types/node@12.12.11", + "raw": "@types/node@14.14.22", "name": "@types/node", "escapedName": "@types%2fnode", "scope": "@types", - "rawSpec": "12.12.11", + "rawSpec": "14.14.22", "saveSpec": null, - "fetchSpec": "12.12.11" + "fetchSpec": "14.14.22" }, "_requiredBy": [ "#DEV:/", - "#USER", "/@octokit/types" ], - "_resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.11.tgz", - "_shasum": "bec2961975888d964196bf0016a2f984d793d3ce", - "_spec": "@types/node@12.12.11", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", + "_resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.22.tgz", + "_spec": "14.14.22", + "_where": ".", "bugs": { "url": "https://github.com/DefinitelyTyped/DefinitelyTyped/issues" }, - "bundleDependencies": false, "contributors": [ { "name": "Microsoft TypeScript", @@ -66,10 +69,6 @@ "name": "Chigozirim C.", "url": "https://github.com/smac89" }, - { - "name": "Christian Vaagland Tellnes", - "url": "https://github.com/tellnes" - }, { "name": "David Junger", "url": "https://github.com/touffy" @@ -122,10 +121,6 @@ "name": "Nicolas Even", "url": "https://github.com/n-e" }, - { - "name": "Nicolas Voigt", - "url": "https://github.com/octo-sniffle" - }, { "name": "Nikita Galkin", "url": "https://github.com/galkin" @@ -154,10 +149,6 @@ "name": "wwwy3y3", "url": "https://github.com/wwwy3y3" }, - { - "name": "Zane Hannan AU", - "url": "https://github.com/ZaneHannanAU" - }, { "name": "Samuel Ainsworth", "url": "https://github.com/samuela" @@ -189,10 +180,41 @@ { "name": "Junxiao Shi", "url": "https://github.com/yoursunny" + }, + { + "name": "Ilia Baryshnikov", + "url": "https://github.com/qwelias" + }, + { + "name": "ExE Boss", + "url": "https://github.com/ExE-Boss" + }, + { + "name": "Surasak Chaisurin", + "url": "https://github.com/Ryan-Willpower" + }, + { + "name": "Piotr Błażejewicz", + "url": "https://github.com/peterblazejewicz" + }, + { + "name": "Anna Henningsen", + "url": "https://github.com/addaleax" + }, + { + "name": "Jason Kwok", + "url": "https://github.com/JasonHK" + }, + { + "name": "Victor Perin", + "url": "https://github.com/victorperin" + }, + { + "name": "Yongsheng Zhang", + "url": "https://github.com/ZYSzys" } ], "dependencies": {}, - "deprecated": false, "description": "TypeScript definitions for Node.js", "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped#readme", "license": "MIT", @@ -204,15 +226,20 @@ "directory": "types/node" }, "scripts": {}, - "typeScriptVersion": "2.8", + "typeScriptVersion": "3.4", "types": "index.d.ts", - "typesPublisherContentHash": "db8a3e1fadc482615dd04e1c1d0d26eca954d792aed008eac14078e02f14e87b", + "typesPublisherContentHash": "1fca9b97600d43cbf3c9f3a1c57e994dbe5cd9aa768bd7accf34db05f7079716", "typesVersions": { - ">=3.2.0-0": { + "<=3.4": { "*": [ - "ts3.2/*" + "ts3.4/*" + ] + }, + "<=3.6": { + "*": [ + "ts3.6/*" ] } }, - "version": "12.12.11" + "version": "14.14.22" } diff --git a/node_modules/@types/node/path.d.ts b/node_modules/@types/node/path.d.ts index 2f4a549..0273d58 100644 --- a/node_modules/@types/node/path.d.ts +++ b/node_modules/@types/node/path.d.ts @@ -1,159 +1,153 @@ declare module "path" { - /** - * A parsed path object generated by path.parse() or consumed by path.format(). - */ - interface ParsedPath { + namespace path { /** - * The root of the path such as '/' or 'c:\' + * A parsed path object generated by path.parse() or consumed by path.format(). */ - root: string; - /** - * The full directory path such as '/home/user/dir' or 'c:\path\dir' - */ - dir: string; - /** - * The file name including extension (if any) such as 'index.html' - */ - base: string; - /** - * The file extension (if any) such as '.html' - */ - ext: string; - /** - * The file name without extension (if any) such as 'index' - */ - name: string; - } - interface FormatInputPathObject { - /** - * The root of the path such as '/' or 'c:\' - */ - root?: string; - /** - * The full directory path such as '/home/user/dir' or 'c:\path\dir' - */ - dir?: string; - /** - * The file name including extension (if any) such as 'index.html' - */ - base?: string; - /** - * The file extension (if any) such as '.html' - */ - ext?: string; - /** - * The file name without extension (if any) such as 'index' - */ - name?: string; - } + interface ParsedPath { + /** + * The root of the path such as '/' or 'c:\' + */ + root: string; + /** + * The full directory path such as '/home/user/dir' or 'c:\path\dir' + */ + dir: string; + /** + * The file name including extension (if any) such as 'index.html' + */ + base: string; + /** + * The file extension (if any) such as '.html' + */ + ext: string; + /** + * The file name without extension (if any) such as 'index' + */ + name: string; + } - /** - * Normalize a string path, reducing '..' and '.' parts. - * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. - * - * @param p string path to normalize. - */ - function normalize(p: string): string; - /** - * Join all arguments together and normalize the resulting path. - * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. - * - * @param paths paths to join. - */ - function join(...paths: string[]): string; - /** - * The right-most parameter is considered {to}. Other parameters are considered an array of {from}. - * - * Starting from leftmost {from} parameter, resolves {to} to an absolute path. - * - * If {to} isn't already absolute, {from} arguments are prepended in right to left order, - * until an absolute path is found. If after using all {from} paths still no absolute path is found, - * the current working directory is used as well. The resulting path is normalized, - * and trailing slashes are removed unless the path gets resolved to the root directory. - * - * @param pathSegments string paths to join. Non-string arguments are ignored. - */ - function resolve(...pathSegments: string[]): string; - /** - * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. - * - * @param path path to test. - */ - function isAbsolute(path: string): boolean; - /** - * Solve the relative path from {from} to {to}. - * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve. - */ - function relative(from: string, to: string): string; - /** - * Return the directory name of a path. Similar to the Unix dirname command. - * - * @param p the path to evaluate. - */ - function dirname(p: string): string; - /** - * Return the last portion of a path. Similar to the Unix basename command. - * Often used to extract the file name from a fully qualified path. - * - * @param p the path to evaluate. - * @param ext optionally, an extension to remove from the result. - */ - function basename(p: string, ext?: string): string; - /** - * Return the extension of the path, from the last '.' to end of string in the last portion of the path. - * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string - * - * @param p the path to evaluate. - */ - function extname(p: string): string; - /** - * The platform-specific file separator. '\\' or '/'. - */ - const sep: '\\' | '/'; - /** - * The platform-specific file delimiter. ';' or ':'. - */ - const delimiter: ';' | ':'; - /** - * Returns an object from a path string - the opposite of format(). - * - * @param pathString path to evaluate. - */ - function parse(pathString: string): ParsedPath; - /** - * Returns a path string from an object - the opposite of parse(). - * - * @param pathString path to evaluate. - */ - function format(pathObject: FormatInputPathObject): string; + interface FormatInputPathObject { + /** + * The root of the path such as '/' or 'c:\' + */ + root?: string; + /** + * The full directory path such as '/home/user/dir' or 'c:\path\dir' + */ + dir?: string; + /** + * The file name including extension (if any) such as 'index.html' + */ + base?: string; + /** + * The file extension (if any) such as '.html' + */ + ext?: string; + /** + * The file name without extension (if any) such as 'index' + */ + name?: string; + } - namespace posix { - function normalize(p: string): string; - function join(...paths: string[]): string; - function resolve(...pathSegments: string[]): string; - function isAbsolute(p: string): boolean; - function relative(from: string, to: string): string; - function dirname(p: string): string; - function basename(p: string, ext?: string): string; - function extname(p: string): string; - const sep: string; - const delimiter: string; - function parse(p: string): ParsedPath; - function format(pP: FormatInputPathObject): string; - } - - namespace win32 { - function normalize(p: string): string; - function join(...paths: string[]): string; - function resolve(...pathSegments: string[]): string; - function isAbsolute(p: string): boolean; - function relative(from: string, to: string): string; - function dirname(p: string): string; - function basename(p: string, ext?: string): string; - function extname(p: string): string; - const sep: string; - const delimiter: string; - function parse(p: string): ParsedPath; - function format(pP: FormatInputPathObject): string; + interface PlatformPath { + /** + * Normalize a string path, reducing '..' and '.' parts. + * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. + * + * @param p string path to normalize. + */ + normalize(p: string): string; + /** + * Join all arguments together and normalize the resulting path. + * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. + * + * @param paths paths to join. + */ + join(...paths: string[]): string; + /** + * The right-most parameter is considered {to}. Other parameters are considered an array of {from}. + * + * Starting from leftmost {from} parameter, resolves {to} to an absolute path. + * + * If {to} isn't already absolute, {from} arguments are prepended in right to left order, + * until an absolute path is found. If after using all {from} paths still no absolute path is found, + * the current working directory is used as well. The resulting path is normalized, + * and trailing slashes are removed unless the path gets resolved to the root directory. + * + * @param pathSegments string paths to join. Non-string arguments are ignored. + */ + resolve(...pathSegments: string[]): string; + /** + * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. + * + * @param path path to test. + */ + isAbsolute(p: string): boolean; + /** + * Solve the relative path from {from} to {to}. + * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve. + */ + relative(from: string, to: string): string; + /** + * Return the directory name of a path. Similar to the Unix dirname command. + * + * @param p the path to evaluate. + */ + dirname(p: string): string; + /** + * Return the last portion of a path. Similar to the Unix basename command. + * Often used to extract the file name from a fully qualified path. + * + * @param p the path to evaluate. + * @param ext optionally, an extension to remove from the result. + */ + basename(p: string, ext?: string): string; + /** + * Return the extension of the path, from the last '.' to end of string in the last portion of the path. + * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string + * + * @param p the path to evaluate. + */ + extname(p: string): string; + /** + * The platform-specific file separator. '\\' or '/'. + */ + readonly sep: string; + /** + * The platform-specific file delimiter. ';' or ':'. + */ + readonly delimiter: string; + /** + * Returns an object from a path string - the opposite of format(). + * + * @param pathString path to evaluate. + */ + parse(p: string): ParsedPath; + /** + * Returns a path string from an object - the opposite of parse(). + * + * @param pathString path to evaluate. + */ + format(pP: FormatInputPathObject): string; + /** + * On Windows systems only, returns an equivalent namespace-prefixed path for the given path. + * If path is not a string, path will be returned without modifications. + * This method is meaningful only on Windows system. + * On POSIX systems, the method is non-operational and always returns path without modifications. + */ + toNamespacedPath(path: string): string; + /** + * Posix specific pathing. + * Same as parent object on posix. + */ + readonly posix: PlatformPath; + /** + * Windows specific pathing. + * Same as parent object on windows + */ + readonly win32: PlatformPath; + } } + const path: path.PlatformPath; + export = path; } diff --git a/node_modules/@types/node/perf_hooks.d.ts b/node_modules/@types/node/perf_hooks.d.ts index bf44d44..bbea938 100644 --- a/node_modules/@types/node/perf_hooks.d.ts +++ b/node_modules/@types/node/perf_hooks.d.ts @@ -1,5 +1,7 @@ -declare module "perf_hooks" { - import { AsyncResource } from "async_hooks"; +declare module 'perf_hooks' { + import { AsyncResource } from 'async_hooks'; + + type EntryType = 'node' | 'mark' | 'measure' | 'gc' | 'function' | 'http2' | 'http'; interface PerformanceEntry { /** @@ -22,14 +24,21 @@ declare module "perf_hooks" { * The type of the performance entry. * Currently it may be one of: 'node', 'mark', 'measure', 'gc', or 'function'. */ - readonly entryType: string; + readonly entryType: EntryType; /** - * When performanceEntry.entryType is equal to 'gc', the performance.kind property identifies + * When `performanceEntry.entryType` is equal to 'gc', `the performance.kind` property identifies * the type of garbage collection operation that occurred. - * The value may be one of perf_hooks.constants. + * See perf_hooks.constants for valid values. */ readonly kind?: number; + + /** + * When `performanceEntry.entryType` is equal to 'gc', the `performance.flags` + * property contains additional information about garbage collection operation. + * See perf_hooks.constants for valid values. + */ + readonly flags?: number; } interface PerformanceNodeTiming extends PerformanceEntry { @@ -39,74 +48,43 @@ declare module "perf_hooks" { readonly bootstrapComplete: number; /** - * The high resolution millisecond timestamp at which cluster processing ended. + * The high resolution millisecond timestamp at which the Node.js process completed bootstrapping. + * If bootstrapping has not yet finished, the property has the value of -1. */ - readonly clusterSetupEnd: number; + readonly environment: number; /** - * The high resolution millisecond timestamp at which cluster processing started. + * The high resolution millisecond timestamp at which the Node.js environment was initialized. */ - readonly clusterSetupStart: number; + readonly idleTime: number; /** - * The high resolution millisecond timestamp at which the Node.js event loop exited. + * The high resolution millisecond timestamp of the amount of time the event loop has been idle + * within the event loop's event provider (e.g. `epoll_wait`). This does not take CPU usage + * into consideration. If the event loop has not yet started (e.g., in the first tick of the main script), + * the property has the value of 0. */ readonly loopExit: number; /** * The high resolution millisecond timestamp at which the Node.js event loop started. + * If the event loop has not yet started (e.g., in the first tick of the main script), the property has the value of -1. */ readonly loopStart: number; - /** - * The high resolution millisecond timestamp at which main module load ended. - */ - readonly moduleLoadEnd: number; - - /** - * The high resolution millisecond timestamp at which main module load started. - */ - readonly moduleLoadStart: number; - - /** - * The high resolution millisecond timestamp at which the Node.js process was initialized. - */ - readonly nodeStart: number; - - /** - * The high resolution millisecond timestamp at which preload module load ended. - */ - readonly preloadModuleLoadEnd: number; - - /** - * The high resolution millisecond timestamp at which preload module load started. - */ - readonly preloadModuleLoadStart: number; - - /** - * The high resolution millisecond timestamp at which third_party_main processing ended. - */ - readonly thirdPartyMainEnd: number; - - /** - * The high resolution millisecond timestamp at which third_party_main processing started. - */ - readonly thirdPartyMainStart: number; - /** * The high resolution millisecond timestamp at which the V8 platform was initialized. */ readonly v8Start: number; } - interface Performance { - /** - * If name is not provided, removes all PerformanceFunction objects from the Performance Timeline. - * If name is provided, removes entries with name. - * @param name - */ - clearFunctions(name?: string): void; + interface EventLoopUtilization { + idle: number; + active: number; + utilization: number; + } + interface Performance { /** * If name is not provided, removes all PerformanceMark objects from the Performance Timeline. * If name is provided, removes only the named mark. @@ -114,35 +92,6 @@ declare module "perf_hooks" { */ clearMarks(name?: string): void; - /** - * If name is not provided, removes all PerformanceMeasure objects from the Performance Timeline. - * If name is provided, removes only objects whose performanceEntry.name matches name. - */ - clearMeasures(name?: string): void; - - /** - * Returns a list of all PerformanceEntry objects in chronological order with respect to performanceEntry.startTime. - * @return list of all PerformanceEntry objects - */ - getEntries(): PerformanceEntry[]; - - /** - * Returns a list of all PerformanceEntry objects in chronological order with respect to performanceEntry.startTime - * whose performanceEntry.name is equal to name, and optionally, whose performanceEntry.entryType is equal to type. - * @param name - * @param type - * @return list of all PerformanceEntry objects - */ - getEntriesByName(name: string, type?: string): PerformanceEntry[]; - - /** - * Returns a list of all PerformanceEntry objects in chronological order with respect to performanceEntry.startTime - * whose performanceEntry.entryType is equal to type. - * @param type - * @return list of all PerformanceEntry objects - */ - getEntriesByType(type: string): PerformanceEntry[]; - /** * Creates a new PerformanceMark entry in the Performance Timeline. * A PerformanceMark is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'mark', @@ -190,6 +139,16 @@ declare module "perf_hooks" { * @param fn */ timerify any>(fn: T): T; + + /** + * eventLoopUtilization is similar to CPU utilization except that it is calculated using high precision wall-clock time. + * It represents the percentage of time the event loop has spent outside the event loop's event provider (e.g. epoll_wait). + * No other CPU idle time is taken into consideration. + * + * @param util1 The result of a previous call to eventLoopUtilization() + * @param util2 The result of a previous call to eventLoopUtilization() prior to util1 + */ + eventLoopUtilization(util1?: EventLoopUtilization, util2?: EventLoopUtilization): EventLoopUtilization; } interface PerformanceObserverEntryList { @@ -202,13 +161,13 @@ declare module "perf_hooks" { * @return a list of PerformanceEntry objects in chronological order with respect to performanceEntry.startTime * whose performanceEntry.name is equal to name, and optionally, whose performanceEntry.entryType is equal to type. */ - getEntriesByName(name: string, type?: string): PerformanceEntry[]; + getEntriesByName(name: string, type?: EntryType): PerformanceEntry[]; /** * @return Returns a list of PerformanceEntry objects in chronological order with respect to performanceEntry.startTime * whose performanceEntry.entryType is equal to type. */ - getEntriesByType(type: string): PerformanceEntry[]; + getEntriesByType(type: EntryType): PerformanceEntry[]; } type PerformanceObserverCallback = (list: PerformanceObserverEntryList, observer: PerformanceObserver) => void; @@ -227,7 +186,7 @@ declare module "perf_hooks" { * Property buffered defaults to false. * @param options */ - observe(options: { entryTypes: string[], buffered?: boolean }): void; + observe(options: { entryTypes: ReadonlyArray; buffered?: boolean }): void; } namespace constants { @@ -235,6 +194,14 @@ declare module "perf_hooks" { const NODE_PERFORMANCE_GC_MINOR: number; const NODE_PERFORMANCE_GC_INCREMENTAL: number; const NODE_PERFORMANCE_GC_WEAKCB: number; + + const NODE_PERFORMANCE_GC_FLAGS_NO: number; + const NODE_PERFORMANCE_GC_FLAGS_CONSTRUCT_RETAINED: number; + const NODE_PERFORMANCE_GC_FLAGS_FORCED: number; + const NODE_PERFORMANCE_GC_FLAGS_SYNCHRONOUS_PHANTOM_PROCESSING: number; + const NODE_PERFORMANCE_GC_FLAGS_ALL_AVAILABLE_GARBAGE: number; + const NODE_PERFORMANCE_GC_FLAGS_ALL_EXTERNAL_MEMORY: number; + const NODE_PERFORMANCE_GC_FLAGS_SCHEDULE_IDLE: number; } const performance: Performance; diff --git a/node_modules/@types/node/process.d.ts b/node_modules/@types/node/process.d.ts index d007d4e..65fe5ca 100644 --- a/node_modules/@types/node/process.d.ts +++ b/node_modules/@types/node/process.d.ts @@ -2,12 +2,405 @@ declare module "process" { import * as tty from "tty"; global { + var process: NodeJS.Process; + namespace NodeJS { // this namespace merge is here because these are specifically used // as the type for process.stdin, process.stdout, and process.stderr. // they can't live in tty.d.ts because we need to disambiguate the imported name. interface ReadStream extends tty.ReadStream {} interface WriteStream extends tty.WriteStream {} + + interface MemoryUsage { + rss: number; + heapTotal: number; + heapUsed: number; + external: number; + arrayBuffers: number; + } + + interface CpuUsage { + user: number; + system: number; + } + + interface ProcessRelease { + name: string; + sourceUrl?: string; + headersUrl?: string; + libUrl?: string; + lts?: string; + } + + interface ProcessVersions extends Dict { + http_parser: string; + node: string; + v8: string; + ares: string; + uv: string; + zlib: string; + modules: string; + openssl: string; + } + + type Platform = 'aix' + | 'android' + | 'darwin' + | 'freebsd' + | 'linux' + | 'openbsd' + | 'sunos' + | 'win32' + | 'cygwin' + | 'netbsd'; + + type Signals = + "SIGABRT" | "SIGALRM" | "SIGBUS" | "SIGCHLD" | "SIGCONT" | "SIGFPE" | "SIGHUP" | "SIGILL" | "SIGINT" | "SIGIO" | + "SIGIOT" | "SIGKILL" | "SIGPIPE" | "SIGPOLL" | "SIGPROF" | "SIGPWR" | "SIGQUIT" | "SIGSEGV" | "SIGSTKFLT" | + "SIGSTOP" | "SIGSYS" | "SIGTERM" | "SIGTRAP" | "SIGTSTP" | "SIGTTIN" | "SIGTTOU" | "SIGUNUSED" | "SIGURG" | + "SIGUSR1" | "SIGUSR2" | "SIGVTALRM" | "SIGWINCH" | "SIGXCPU" | "SIGXFSZ" | "SIGBREAK" | "SIGLOST" | "SIGINFO"; + + type MultipleResolveType = 'resolve' | 'reject'; + + type BeforeExitListener = (code: number) => void; + type DisconnectListener = () => void; + type ExitListener = (code: number) => void; + type RejectionHandledListener = (promise: Promise) => void; + type UncaughtExceptionListener = (error: Error) => void; + type UnhandledRejectionListener = (reason: {} | null | undefined, promise: Promise) => void; + type WarningListener = (warning: Error) => void; + type MessageListener = (message: any, sendHandle: any) => void; + type SignalsListener = (signal: Signals) => void; + type NewListenerListener = (type: string | symbol, listener: (...args: any[]) => void) => void; + type RemoveListenerListener = (type: string | symbol, listener: (...args: any[]) => void) => void; + type MultipleResolveListener = (type: MultipleResolveType, promise: Promise, value: any) => void; + + interface Socket extends ReadWriteStream { + isTTY?: true; + } + + // Alias for compatibility + interface ProcessEnv extends Dict {} + + interface HRTime { + (time?: [number, number]): [number, number]; + bigint(): bigint; + } + + interface ProcessReport { + /** + * Directory where the report is written. + * working directory of the Node.js process. + * @default '' indicating that reports are written to the current + */ + directory: string; + + /** + * Filename where the report is written. + * The default value is the empty string. + * @default '' the output filename will be comprised of a timestamp, + * PID, and sequence number. + */ + filename: string; + + /** + * Returns a JSON-formatted diagnostic report for the running process. + * The report's JavaScript stack trace is taken from err, if present. + */ + getReport(err?: Error): string; + + /** + * If true, a diagnostic report is generated on fatal errors, + * such as out of memory errors or failed C++ assertions. + * @default false + */ + reportOnFatalError: boolean; + + /** + * If true, a diagnostic report is generated when the process + * receives the signal specified by process.report.signal. + * @defaul false + */ + reportOnSignal: boolean; + + /** + * If true, a diagnostic report is generated on uncaught exception. + * @default false + */ + reportOnUncaughtException: boolean; + + /** + * The signal used to trigger the creation of a diagnostic report. + * @default 'SIGUSR2' + */ + signal: Signals; + + /** + * Writes a diagnostic report to a file. If filename is not provided, the default filename + * includes the date, time, PID, and a sequence number. + * The report's JavaScript stack trace is taken from err, if present. + * + * @param fileName Name of the file where the report is written. + * This should be a relative path, that will be appended to the directory specified in + * `process.report.directory`, or the current working directory of the Node.js process, + * if unspecified. + * @param error A custom error used for reporting the JavaScript stack. + * @return Filename of the generated report. + */ + writeReport(fileName?: string): string; + writeReport(error?: Error): string; + writeReport(fileName?: string, err?: Error): string; + } + + interface ResourceUsage { + fsRead: number; + fsWrite: number; + involuntaryContextSwitches: number; + ipcReceived: number; + ipcSent: number; + majorPageFault: number; + maxRSS: number; + minorPageFault: number; + sharedMemorySize: number; + signalsCount: number; + swappedOut: number; + systemCPUTime: number; + unsharedDataSize: number; + unsharedStackSize: number; + userCPUTime: number; + voluntaryContextSwitches: number; + } + + interface Process extends EventEmitter { + /** + * Can also be a tty.WriteStream, not typed due to limitations. + */ + stdout: WriteStream & { + fd: 1; + }; + /** + * Can also be a tty.WriteStream, not typed due to limitations. + */ + stderr: WriteStream & { + fd: 2; + }; + stdin: ReadStream & { + fd: 0; + }; + openStdin(): Socket; + argv: string[]; + argv0: string; + execArgv: string[]; + execPath: string; + abort(): never; + chdir(directory: string): void; + cwd(): string; + debugPort: number; + emitWarning(warning: string | Error, name?: string, ctor?: Function): void; + env: ProcessEnv; + exit(code?: number): never; + exitCode?: number; + getgid(): number; + setgid(id: number | string): void; + getuid(): number; + setuid(id: number | string): void; + geteuid(): number; + seteuid(id: number | string): void; + getegid(): number; + setegid(id: number | string): void; + getgroups(): number[]; + setgroups(groups: ReadonlyArray): void; + setUncaughtExceptionCaptureCallback(cb: ((err: Error) => void) | null): void; + hasUncaughtExceptionCaptureCallback(): boolean; + version: string; + versions: ProcessVersions; + config: { + target_defaults: { + cflags: any[]; + default_configuration: string; + defines: string[]; + include_dirs: string[]; + libraries: string[]; + }; + variables: { + clang: number; + host_arch: string; + node_install_npm: boolean; + node_install_waf: boolean; + node_prefix: string; + node_shared_openssl: boolean; + node_shared_v8: boolean; + node_shared_zlib: boolean; + node_use_dtrace: boolean; + node_use_etw: boolean; + node_use_openssl: boolean; + target_arch: string; + v8_no_strict_aliasing: number; + v8_use_snapshot: boolean; + visibility: string; + }; + }; + kill(pid: number, signal?: string | number): true; + pid: number; + ppid: number; + title: string; + arch: string; + platform: Platform; + /** @deprecated since v14.0.0 - use `require.main` instead. */ + mainModule?: Module; + memoryUsage(): MemoryUsage; + cpuUsage(previousValue?: CpuUsage): CpuUsage; + nextTick(callback: Function, ...args: any[]): void; + release: ProcessRelease; + features: { + inspector: boolean; + debug: boolean; + uv: boolean; + ipv6: boolean; + tls_alpn: boolean; + tls_sni: boolean; + tls_ocsp: boolean; + tls: boolean; + }; + /** + * @deprecated since v14.0.0 - Calling process.umask() with no argument causes + * the process-wide umask to be written twice. This introduces a race condition between threads, + * and is a potential security vulnerability. There is no safe, cross-platform alternative API. + */ + umask(): number; + /** + * Can only be set if not in worker thread. + */ + umask(mask: string | number): number; + uptime(): number; + hrtime: HRTime; + domain: Domain; + + // Worker + send?(message: any, sendHandle?: any, options?: { swallowErrors?: boolean}, callback?: (error: Error | null) => void): boolean; + disconnect(): void; + connected: boolean; + + /** + * The `process.allowedNodeEnvironmentFlags` property is a special, + * read-only `Set` of flags allowable within the [`NODE_OPTIONS`][] + * environment variable. + */ + allowedNodeEnvironmentFlags: ReadonlySet; + + /** + * Only available with `--experimental-report` + */ + report?: ProcessReport; + + resourceUsage(): ResourceUsage; + + traceDeprecation: boolean; + + /* EventEmitter */ + addListener(event: "beforeExit", listener: BeforeExitListener): this; + addListener(event: "disconnect", listener: DisconnectListener): this; + addListener(event: "exit", listener: ExitListener): this; + addListener(event: "rejectionHandled", listener: RejectionHandledListener): this; + addListener(event: "uncaughtException", listener: UncaughtExceptionListener): this; + addListener(event: "uncaughtExceptionMonitor", listener: UncaughtExceptionListener): this; + addListener(event: "unhandledRejection", listener: UnhandledRejectionListener): this; + addListener(event: "warning", listener: WarningListener): this; + addListener(event: "message", listener: MessageListener): this; + addListener(event: Signals, listener: SignalsListener): this; + addListener(event: "newListener", listener: NewListenerListener): this; + addListener(event: "removeListener", listener: RemoveListenerListener): this; + addListener(event: "multipleResolves", listener: MultipleResolveListener): this; + + emit(event: "beforeExit", code: number): boolean; + emit(event: "disconnect"): boolean; + emit(event: "exit", code: number): boolean; + emit(event: "rejectionHandled", promise: Promise): boolean; + emit(event: "uncaughtException", error: Error): boolean; + emit(event: "uncaughtExceptionMonitor", error: Error): boolean; + emit(event: "unhandledRejection", reason: any, promise: Promise): boolean; + emit(event: "warning", warning: Error): boolean; + emit(event: "message", message: any, sendHandle: any): this; + emit(event: Signals, signal: Signals): boolean; + emit(event: "newListener", eventName: string | symbol, listener: (...args: any[]) => void): this; + emit(event: "removeListener", eventName: string, listener: (...args: any[]) => void): this; + emit(event: "multipleResolves", listener: MultipleResolveListener): this; + + on(event: "beforeExit", listener: BeforeExitListener): this; + on(event: "disconnect", listener: DisconnectListener): this; + on(event: "exit", listener: ExitListener): this; + on(event: "rejectionHandled", listener: RejectionHandledListener): this; + on(event: "uncaughtException", listener: UncaughtExceptionListener): this; + on(event: "uncaughtExceptionMonitor", listener: UncaughtExceptionListener): this; + on(event: "unhandledRejection", listener: UnhandledRejectionListener): this; + on(event: "warning", listener: WarningListener): this; + on(event: "message", listener: MessageListener): this; + on(event: Signals, listener: SignalsListener): this; + on(event: "newListener", listener: NewListenerListener): this; + on(event: "removeListener", listener: RemoveListenerListener): this; + on(event: "multipleResolves", listener: MultipleResolveListener): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + + once(event: "beforeExit", listener: BeforeExitListener): this; + once(event: "disconnect", listener: DisconnectListener): this; + once(event: "exit", listener: ExitListener): this; + once(event: "rejectionHandled", listener: RejectionHandledListener): this; + once(event: "uncaughtException", listener: UncaughtExceptionListener): this; + once(event: "uncaughtExceptionMonitor", listener: UncaughtExceptionListener): this; + once(event: "unhandledRejection", listener: UnhandledRejectionListener): this; + once(event: "warning", listener: WarningListener): this; + once(event: "message", listener: MessageListener): this; + once(event: Signals, listener: SignalsListener): this; + once(event: "newListener", listener: NewListenerListener): this; + once(event: "removeListener", listener: RemoveListenerListener): this; + once(event: "multipleResolves", listener: MultipleResolveListener): this; + + prependListener(event: "beforeExit", listener: BeforeExitListener): this; + prependListener(event: "disconnect", listener: DisconnectListener): this; + prependListener(event: "exit", listener: ExitListener): this; + prependListener(event: "rejectionHandled", listener: RejectionHandledListener): this; + prependListener(event: "uncaughtException", listener: UncaughtExceptionListener): this; + prependListener(event: "uncaughtExceptionMonitor", listener: UncaughtExceptionListener): this; + prependListener(event: "unhandledRejection", listener: UnhandledRejectionListener): this; + prependListener(event: "warning", listener: WarningListener): this; + prependListener(event: "message", listener: MessageListener): this; + prependListener(event: Signals, listener: SignalsListener): this; + prependListener(event: "newListener", listener: NewListenerListener): this; + prependListener(event: "removeListener", listener: RemoveListenerListener): this; + prependListener(event: "multipleResolves", listener: MultipleResolveListener): this; + + prependOnceListener(event: "beforeExit", listener: BeforeExitListener): this; + prependOnceListener(event: "disconnect", listener: DisconnectListener): this; + prependOnceListener(event: "exit", listener: ExitListener): this; + prependOnceListener(event: "rejectionHandled", listener: RejectionHandledListener): this; + prependOnceListener(event: "uncaughtException", listener: UncaughtExceptionListener): this; + prependOnceListener(event: "uncaughtExceptionMonitor", listener: UncaughtExceptionListener): this; + prependOnceListener(event: "unhandledRejection", listener: UnhandledRejectionListener): this; + prependOnceListener(event: "warning", listener: WarningListener): this; + prependOnceListener(event: "message", listener: MessageListener): this; + prependOnceListener(event: Signals, listener: SignalsListener): this; + prependOnceListener(event: "newListener", listener: NewListenerListener): this; + prependOnceListener(event: "removeListener", listener: RemoveListenerListener): this; + prependOnceListener(event: "multipleResolves", listener: MultipleResolveListener): this; + + listeners(event: "beforeExit"): BeforeExitListener[]; + listeners(event: "disconnect"): DisconnectListener[]; + listeners(event: "exit"): ExitListener[]; + listeners(event: "rejectionHandled"): RejectionHandledListener[]; + listeners(event: "uncaughtException"): UncaughtExceptionListener[]; + listeners(event: "uncaughtExceptionMonitor"): UncaughtExceptionListener[]; + listeners(event: "unhandledRejection"): UnhandledRejectionListener[]; + listeners(event: "warning"): WarningListener[]; + listeners(event: "message"): MessageListener[]; + listeners(event: Signals): SignalsListener[]; + listeners(event: "newListener"): NewListenerListener[]; + listeners(event: "removeListener"): RemoveListenerListener[]; + listeners(event: "multipleResolves"): MultipleResolveListener[]; + } + + interface Global { + process: Process; + } } } diff --git a/node_modules/@types/node/punycode.d.ts b/node_modules/@types/node/punycode.d.ts index 75d2811..2b771d4 100644 --- a/node_modules/@types/node/punycode.d.ts +++ b/node_modules/@types/node/punycode.d.ts @@ -1,12 +1,68 @@ declare module "punycode" { + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ function decode(string: string): string; + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ function encode(string: string): string; + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ function toUnicode(domain: string): string; + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ function toASCII(domain: string): string; + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ const ucs2: ucs2; interface ucs2 { + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ decode(string: string): number[]; - encode(codePoints: number[]): string; + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ + encode(codePoints: ReadonlyArray): string; } + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ const version: string; } diff --git a/node_modules/@types/node/querystring.d.ts b/node_modules/@types/node/querystring.d.ts index a61269d..3e204e7 100644 --- a/node_modules/@types/node/querystring.d.ts +++ b/node_modules/@types/node/querystring.d.ts @@ -8,10 +8,9 @@ declare module "querystring" { decodeURIComponent?: (str: string) => string; } - interface ParsedUrlQuery { [key: string]: string | string[]; } + interface ParsedUrlQuery extends NodeJS.Dict { } - interface ParsedUrlQueryInput { - [key: string]: NodeJS.PoorMansUnknown; + interface ParsedUrlQueryInput extends NodeJS.Dict | ReadonlyArray | ReadonlyArray | null> { } function stringify(obj?: ParsedUrlQueryInput, sep?: string, eq?: string, options?: StringifyOptions): string; diff --git a/node_modules/@types/node/readline.d.ts b/node_modules/@types/node/readline.d.ts index 6cb572e..fbe4836 100644 --- a/node_modules/@types/node/readline.d.ts +++ b/node_modules/@types/node/readline.d.ts @@ -13,6 +13,13 @@ declare module "readline" { class Interface extends events.EventEmitter { readonly terminal: boolean; + // Need direct access to line/cursor data, for use in external processes + // see: https://github.com/nodejs/node/issues/30347 + /** The current input data */ + readonly line: string; + /** The current cursor position in the input line */ + readonly cursor: number; + /** * NOTE: According to the documentation: * @@ -40,6 +47,13 @@ declare module "readline" { close(): void; write(data: string | Buffer, key?: Key): void; + /** + * Returns the real position of the cursor in relation to the input + * prompt + string. Long input (wrapping) strings, as well as multiple + * line prompts are included in the calculations. + */ + getCursorPos(): CursorPos; + /** * events.EventEmitter * 1. close @@ -123,6 +137,8 @@ declare module "readline" { prompt?: string; crlfDelay?: number; removeHistoryDuplicates?: boolean; + escapeCodeTimeout?: number; + tabSize?: number; } function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean): Interface; @@ -131,6 +147,11 @@ declare module "readline" { type Direction = -1 | 0 | 1; + interface CursorPos { + rows: number; + cols: number; + } + /** * Clears the current line of this WriteStream in a direction identified by `dir`. */ diff --git a/node_modules/@types/node/repl.d.ts b/node_modules/@types/node/repl.d.ts index 9496fcd..4985b52 100644 --- a/node_modules/@types/node/repl.d.ts +++ b/node_modules/@types/node/repl.d.ts @@ -36,6 +36,11 @@ declare module "repl" { * @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_custom_evaluation_functions */ eval?: REPLEval; + /** + * Defines if the repl prints output previews or not. + * @default `true` Always `false` in case `terminal` is falsy. + */ + preview?: boolean; /** * If `true`, specifies that the default `writer` function should include ANSI color * styling to REPL output. If a custom `writer` function is provided then this has no @@ -131,17 +136,25 @@ declare module "repl" { */ readonly context: Context; /** - * The `Readable` stream from which REPL input will be read. + * @deprecated since v14.3.0 - Use `input` instead. */ readonly inputStream: NodeJS.ReadableStream; /** - * The `Writable` stream to which REPL output will be written. + * @deprecated since v14.3.0 - Use `output` instead. */ readonly outputStream: NodeJS.WritableStream; + /** + * The `Readable` stream from which REPL input will be read. + */ + readonly input: NodeJS.ReadableStream; + /** + * The `Writable` stream to which REPL output will be written. + */ + readonly output: NodeJS.WritableStream; /** * The commands registered via `replServer.defineCommand()`. */ - readonly commands: { readonly [name: string]: REPLCommand | undefined }; + readonly commands: NodeJS.ReadOnlyDict; /** * A value indicating whether the REPL is currently in "editor mode". * @@ -353,13 +366,13 @@ declare module "repl" { /** * A flag passed in the REPL options. Evaluates expressions in sloppy mode. */ - const REPL_MODE_SLOPPY: symbol; // TODO: unique symbol + const REPL_MODE_SLOPPY: unique symbol; /** * A flag passed in the REPL options. Evaluates expressions in strict mode. * This is equivalent to prefacing every repl statement with `'use strict'`. */ - const REPL_MODE_STRICT: symbol; // TODO: unique symbol + const REPL_MODE_STRICT: unique symbol; /** * Creates and starts a `repl.REPLServer` instance. diff --git a/node_modules/@types/node/stream.d.ts b/node_modules/@types/node/stream.d.ts index 2a0895b..485d503 100644 --- a/node_modules/@types/node/stream.d.ts +++ b/node_modules/@types/node/stream.d.ts @@ -1,16 +1,18 @@ -declare module "stream" { - import * as events from "events"; +declare module 'stream' { + import EventEmitter = require('events'); - class internal extends events.EventEmitter { + class internal extends EventEmitter { pipe(destination: T, options?: { end?: boolean; }): T; } namespace internal { - class Stream extends internal { } + class Stream extends internal { + constructor(opts?: ReadableOptions); + } interface ReadableOptions { highWaterMark?: number; - encoding?: string; + encoding?: BufferEncoding; objectMode?: boolean; read?(this: Readable, size: number): void; destroy?(this: Readable, error: Error | null, callback: (error: Error | null) => void): void; @@ -24,6 +26,9 @@ declare module "stream" { static from(iterable: Iterable | AsyncIterable, options?: ReadableOptions): Readable; readable: boolean; + readonly readableEncoding: BufferEncoding | null; + readonly readableEnded: boolean; + readonly readableFlowing: boolean | null; readonly readableHighWaterMark: number; readonly readableLength: number; readonly readableObjectMode: boolean; @@ -31,14 +36,14 @@ declare module "stream" { constructor(opts?: ReadableOptions); _read(size: number): void; read(size?: number): any; - setEncoding(encoding: string): this; + setEncoding(encoding: BufferEncoding): this; pause(): this; resume(): this; isPaused(): boolean; unpipe(destination?: NodeJS.WritableStream): this; unshift(chunk: any, encoding?: BufferEncoding): void; wrap(oldStream: NodeJS.ReadableStream): this; - push(chunk: any, encoding?: string): boolean; + push(chunk: any, encoding?: BufferEncoding): boolean; _destroy(error: Error | null, callback: (error?: Error | null) => void): void; destroy(error?: Error): void; @@ -48,56 +53,72 @@ declare module "stream" { * 1. close * 2. data * 3. end - * 4. readable - * 5. error + * 4. error + * 5. pause + * 6. readable + * 7. resume */ addListener(event: "close", listener: () => void): this; addListener(event: "data", listener: (chunk: any) => void): this; addListener(event: "end", listener: () => void): this; - addListener(event: "readable", listener: () => void): this; addListener(event: "error", listener: (err: Error) => void): this; + addListener(event: "pause", listener: () => void): this; + addListener(event: "readable", listener: () => void): this; + addListener(event: "resume", listener: () => void): this; addListener(event: string | symbol, listener: (...args: any[]) => void): this; emit(event: "close"): boolean; emit(event: "data", chunk: any): boolean; emit(event: "end"): boolean; - emit(event: "readable"): boolean; emit(event: "error", err: Error): boolean; + emit(event: "pause"): boolean; + emit(event: "readable"): boolean; + emit(event: "resume"): boolean; emit(event: string | symbol, ...args: any[]): boolean; on(event: "close", listener: () => void): this; on(event: "data", listener: (chunk: any) => void): this; on(event: "end", listener: () => void): this; - on(event: "readable", listener: () => void): this; on(event: "error", listener: (err: Error) => void): this; + on(event: "pause", listener: () => void): this; + on(event: "readable", listener: () => void): this; + on(event: "resume", listener: () => void): this; on(event: string | symbol, listener: (...args: any[]) => void): this; once(event: "close", listener: () => void): this; once(event: "data", listener: (chunk: any) => void): this; once(event: "end", listener: () => void): this; - once(event: "readable", listener: () => void): this; once(event: "error", listener: (err: Error) => void): this; + once(event: "pause", listener: () => void): this; + once(event: "readable", listener: () => void): this; + once(event: "resume", listener: () => void): this; once(event: string | symbol, listener: (...args: any[]) => void): this; prependListener(event: "close", listener: () => void): this; prependListener(event: "data", listener: (chunk: any) => void): this; prependListener(event: "end", listener: () => void): this; - prependListener(event: "readable", listener: () => void): this; prependListener(event: "error", listener: (err: Error) => void): this; + prependListener(event: "pause", listener: () => void): this; + prependListener(event: "readable", listener: () => void): this; + prependListener(event: "resume", listener: () => void): this; prependListener(event: string | symbol, listener: (...args: any[]) => void): this; prependOnceListener(event: "close", listener: () => void): this; prependOnceListener(event: "data", listener: (chunk: any) => void): this; prependOnceListener(event: "end", listener: () => void): this; - prependOnceListener(event: "readable", listener: () => void): this; prependOnceListener(event: "error", listener: (err: Error) => void): this; + prependOnceListener(event: "pause", listener: () => void): this; + prependOnceListener(event: "readable", listener: () => void): this; + prependOnceListener(event: "resume", listener: () => void): this; prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; removeListener(event: "close", listener: () => void): this; removeListener(event: "data", listener: (chunk: any) => void): this; removeListener(event: "end", listener: () => void): this; - removeListener(event: "readable", listener: () => void): this; removeListener(event: "error", listener: (err: Error) => void): this; + removeListener(event: "pause", listener: () => void): this; + removeListener(event: "readable", listener: () => void): this; + removeListener(event: "resume", listener: () => void): this; removeListener(event: string | symbol, listener: (...args: any[]) => void): this; [Symbol.asyncIterator](): AsyncIterableIterator; @@ -106,11 +127,11 @@ declare module "stream" { interface WritableOptions { highWaterMark?: number; decodeStrings?: boolean; - defaultEncoding?: string; + defaultEncoding?: BufferEncoding; objectMode?: boolean; emitClose?: boolean; - write?(this: Writable, chunk: any, encoding: string, callback: (error?: Error | null) => void): void; - writev?(this: Writable, chunks: Array<{ chunk: any, encoding: string }>, callback: (error?: Error | null) => void): void; + write?(this: Writable, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + writev?(this: Writable, chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; destroy?(this: Writable, error: Error | null, callback: (error: Error | null) => void): void; final?(this: Writable, callback: (error?: Error | null) => void): void; autoDestroy?: boolean; @@ -123,18 +144,19 @@ declare module "stream" { readonly writableHighWaterMark: number; readonly writableLength: number; readonly writableObjectMode: boolean; + readonly writableCorked: number; destroyed: boolean; constructor(opts?: WritableOptions); - _write(chunk: any, encoding: string, callback: (error?: Error | null) => void): void; - _writev?(chunks: Array<{ chunk: any, encoding: string }>, callback: (error?: Error | null) => void): void; + _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + _writev?(chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; _destroy(error: Error | null, callback: (error?: Error | null) => void): void; _final(callback: (error?: Error | null) => void): void; write(chunk: any, cb?: (error: Error | null | undefined) => void): boolean; - write(chunk: any, encoding: string, cb?: (error: Error | null | undefined) => void): boolean; - setDefaultEncoding(encoding: string): this; + write(chunk: any, encoding: BufferEncoding, cb?: (error: Error | null | undefined) => void): boolean; + setDefaultEncoding(encoding: BufferEncoding): this; end(cb?: () => void): void; end(chunk: any, cb?: () => void): void; - end(chunk: any, encoding: string, cb?: () => void): void; + end(chunk: any, encoding: BufferEncoding, cb?: () => void): void; cork(): void; uncork(): void; destroy(error?: Error): void; @@ -210,9 +232,12 @@ declare module "stream" { allowHalfOpen?: boolean; readableObjectMode?: boolean; writableObjectMode?: boolean; + readableHighWaterMark?: number; + writableHighWaterMark?: number; + writableCorked?: number; read?(this: Duplex, size: number): void; - write?(this: Duplex, chunk: any, encoding: string, callback: (error?: Error | null) => void): void; - writev?(this: Duplex, chunks: Array<{ chunk: any, encoding: string }>, callback: (error?: Error | null) => void): void; + write?(this: Duplex, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + writev?(this: Duplex, chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; final?(this: Duplex, callback: (error?: Error | null) => void): void; destroy?(this: Duplex, error: Error | null, callback: (error: Error | null) => void): void; } @@ -225,17 +250,18 @@ declare module "stream" { readonly writableHighWaterMark: number; readonly writableLength: number; readonly writableObjectMode: boolean; + readonly writableCorked: number; constructor(opts?: DuplexOptions); - _write(chunk: any, encoding: string, callback: (error?: Error | null) => void): void; - _writev?(chunks: Array<{ chunk: any, encoding: string }>, callback: (error?: Error | null) => void): void; + _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + _writev?(chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; _destroy(error: Error | null, callback: (error: Error | null) => void): void; _final(callback: (error?: Error | null) => void): void; - write(chunk: any, encoding?: string, cb?: (error: Error | null | undefined) => void): boolean; + write(chunk: any, encoding?: BufferEncoding, cb?: (error: Error | null | undefined) => void): boolean; write(chunk: any, cb?: (error: Error | null | undefined) => void): boolean; - setDefaultEncoding(encoding: string): this; + setDefaultEncoding(encoding: BufferEncoding): this; end(cb?: () => void): void; end(chunk: any, cb?: () => void): void; - end(chunk: any, encoding?: string, cb?: () => void): void; + end(chunk: any, encoding?: BufferEncoding, cb?: () => void): void; cork(): void; uncork(): void; } @@ -244,25 +270,31 @@ declare module "stream" { interface TransformOptions extends DuplexOptions { read?(this: Transform, size: number): void; - write?(this: Transform, chunk: any, encoding: string, callback: (error?: Error | null) => void): void; - writev?(this: Transform, chunks: Array<{ chunk: any, encoding: string }>, callback: (error?: Error | null) => void): void; + write?(this: Transform, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + writev?(this: Transform, chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; final?(this: Transform, callback: (error?: Error | null) => void): void; destroy?(this: Transform, error: Error | null, callback: (error: Error | null) => void): void; - transform?(this: Transform, chunk: any, encoding: string, callback: TransformCallback): void; + transform?(this: Transform, chunk: any, encoding: BufferEncoding, callback: TransformCallback): void; flush?(this: Transform, callback: TransformCallback): void; } class Transform extends Duplex { constructor(opts?: TransformOptions); - _transform(chunk: any, encoding: string, callback: TransformCallback): void; + _transform(chunk: any, encoding: BufferEncoding, callback: TransformCallback): void; _flush(callback: TransformCallback): void; } class PassThrough extends Transform { } + interface FinishedOptions { + error?: boolean; + readable?: boolean; + writable?: boolean; + } + function finished(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, options: FinishedOptions, callback: (err?: NodeJS.ErrnoException | null) => void): () => void; function finished(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, callback: (err?: NodeJS.ErrnoException | null) => void): () => void; namespace finished { - function __promisify__(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream): Promise; + function __promisify__(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, options?: FinishedOptions): Promise; } function pipeline(stream1: NodeJS.ReadableStream, stream2: T, callback?: (err: NodeJS.ErrnoException | null) => void): T; @@ -282,7 +314,10 @@ declare module "stream" { stream5: T, callback?: (err: NodeJS.ErrnoException | null) => void, ): T; - function pipeline(streams: Array, callback?: (err: NodeJS.ErrnoException | null) => void): NodeJS.WritableStream; + function pipeline( + streams: ReadonlyArray, + callback?: (err: NodeJS.ErrnoException | null) => void, + ): NodeJS.WritableStream; function pipeline( stream1: NodeJS.ReadableStream, stream2: NodeJS.ReadWriteStream | NodeJS.WritableStream, @@ -299,7 +334,7 @@ declare module "stream" { stream4: NodeJS.ReadWriteStream, stream5: NodeJS.WritableStream, ): Promise; - function __promisify__(streams: Array): Promise; + function __promisify__(streams: ReadonlyArray): Promise; function __promisify__( stream1: NodeJS.ReadableStream, stream2: NodeJS.ReadWriteStream | NodeJS.WritableStream, diff --git a/node_modules/@types/node/string_decoder.d.ts b/node_modules/@types/node/string_decoder.d.ts index fe0e0b4..a6a4060 100644 --- a/node_modules/@types/node/string_decoder.d.ts +++ b/node_modules/@types/node/string_decoder.d.ts @@ -1,6 +1,6 @@ declare module "string_decoder" { class StringDecoder { - constructor(encoding?: string); + constructor(encoding?: BufferEncoding); write(buffer: Buffer): string; end(buffer?: Buffer): string; } diff --git a/node_modules/@types/node/tls.d.ts b/node_modules/@types/node/tls.d.ts index 2ff817b..9c548ef 100644 --- a/node_modules/@types/node/tls.d.ts +++ b/node_modules/@types/node/tls.d.ts @@ -38,12 +38,13 @@ declare module "tls" { subject: Certificate; issuer: Certificate; subjectaltname: string; - infoAccess: { [index: string]: string[] | undefined }; + infoAccess: NodeJS.Dict; modulus: string; exponent: string; valid_from: string; valid_to: string; fingerprint: string; + fingerprint256: string; ext_key_usage: string[]; serialNumber: string; raw: Buffer; @@ -62,6 +63,48 @@ declare module "tls" { * SSL/TLS protocol version. */ version: string; + + /** + * IETF name for the cipher suite. + */ + standardName: string; + } + + interface EphemeralKeyInfo { + /** + * The supported types are 'DH' and 'ECDH'. + */ + type: string; + /** + * The name property is available only when type is 'ECDH'. + */ + name?: string; + /** + * The size of parameter of an ephemeral key exchange. + */ + size: number; + } + + interface KeyObject { + /** + * Private keys in PEM format. + */ + pem: string | Buffer; + /** + * Optional passphrase. + */ + passphrase?: string; + } + + interface PxfObject { + /** + * PFX or PKCS12 encoded private key and certificate chain. + */ + buf: string | Buffer; + /** + * Optional passphrase. + */ + passphrase?: string; } interface TLSSocketOptions extends SecureContextOptions, CommonConnectionOptions { @@ -114,12 +157,50 @@ declare module "tls" { */ alpnProtocol?: string; + /** + * Returns an object representing the local certificate. The returned + * object has some properties corresponding to the fields of the + * certificate. + * + * See tls.TLSSocket.getPeerCertificate() for an example of the + * certificate structure. + * + * If there is no local certificate, an empty object will be returned. + * If the socket has been destroyed, null will be returned. + */ + getCertificate(): PeerCertificate | object | null; /** * Returns an object representing the cipher name and the SSL/TLS protocol version of the current connection. * @returns Returns an object representing the cipher name * and the SSL/TLS protocol version of the current connection. */ getCipher(): CipherNameAndProtocol; + /** + * Returns an object representing the type, name, and size of parameter + * of an ephemeral key exchange in Perfect Forward Secrecy on a client + * connection. It returns an empty object when the key exchange is not + * ephemeral. As this is only supported on a client socket; null is + * returned if called on a server socket. The supported types are 'DH' + * and 'ECDH'. The name property is available only when type is 'ECDH'. + * + * For example: { type: 'ECDH', name: 'prime256v1', size: 256 }. + */ + getEphemeralKeyInfo(): EphemeralKeyInfo | object | null; + /** + * Returns the latest Finished message that has + * been sent to the socket as part of a SSL/TLS handshake, or undefined + * if no Finished message has been sent yet. + * + * As the Finished messages are message digests of the complete + * handshake (with a total of 192 bits for TLS 1.0 and more for SSL + * 3.0), they can be used for external authentication procedures when + * the authentication provided by SSL/TLS is not desired or is not + * enough. + * + * Corresponds to the SSL_get_finished routine in OpenSSL and may be + * used to implement the tls-unique channel binding from RFC 5929. + */ + getFinished(): Buffer | undefined; /** * Returns an object representing the peer's certificate. * The returned object has some properties corresponding to the field of the certificate. @@ -132,6 +213,21 @@ declare module "tls" { getPeerCertificate(detailed: true): DetailedPeerCertificate; getPeerCertificate(detailed?: false): PeerCertificate; getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate; + /** + * Returns the latest Finished message that is expected or has actually + * been received from the socket as part of a SSL/TLS handshake, or + * undefined if there is no Finished message so far. + * + * As the Finished messages are message digests of the complete + * handshake (with a total of 192 bits for TLS 1.0 and more for SSL + * 3.0), they can be used for external authentication procedures when + * the authentication provided by SSL/TLS is not desired or is not + * enough. + * + * Corresponds to the SSL_get_peer_finished routine in OpenSSL and may + * be used to implement the tls-unique channel binding from RFC 5929. + */ + getPeerFinished(): Buffer | undefined; /** * Returns a string containing the negotiated SSL/TLS protocol version of the current connection. * The value `'unknown'` will be returned for connected sockets that have not completed the handshaking process. @@ -145,12 +241,21 @@ declare module "tls" { * @returns ASN.1 encoded TLS session or undefined if none was negotiated. */ getSession(): Buffer | undefined; + /** + * Returns a list of signature algorithms shared between the server and + * the client in the order of decreasing preference. + */ + getSharedSigalgs(): string[]; /** * NOTE: Works only with client TLS sockets. * Useful only for debugging, for session reuse provide session option to tls.connect(). * @returns TLS session ticket or undefined if none was negotiated. */ getTLSTicket(): Buffer | undefined; + /** + * Returns true if the session was reused, false otherwise. + */ + isSessionReused(): boolean; /** * Initiate TLS renegotiation process. * @@ -175,6 +280,13 @@ declare module "tls" { */ setMaxSendFragment(size: number): boolean; + /** + * Disables TLS renegotiation for this TLSSocket instance. Once called, + * attempts to renegotiate will trigger an 'error' event on the + * TLSSocket. + */ + disableRenegotiation(): void; + /** * When enabled, TLS packet trace information is written to `stderr`. This can be * used to debug TLS connection problems. @@ -186,6 +298,14 @@ declare module "tls" { */ enableTrace(): void; + /** + * @param length number of bytes to retrieve from keying material + * @param label an application specific label, typically this will be a value from the + * [IANA Exporter Label Registry](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#exporter-labels). + * @param context optionally provide a context. + */ + exportKeyingMaterial(length: number, label: string, context: Buffer): Buffer; + addListener(event: string, listener: (...args: any[]) => void): this; addListener(event: "OCSPResponse", listener: (response: Buffer) => void): this; addListener(event: "secureConnect", listener: () => void): this; @@ -266,9 +386,57 @@ declare module "tls" { } interface TlsOptions extends SecureContextOptions, CommonConnectionOptions { + /** + * Abort the connection if the SSL/TLS handshake does not finish in the + * specified number of milliseconds. A 'tlsClientError' is emitted on + * the tls.Server object whenever a handshake times out. Default: + * 120000 (120 seconds). + */ handshakeTimeout?: number; + /** + * The number of seconds after which a TLS session created by the + * server will no longer be resumable. See Session Resumption for more + * information. Default: 300. + */ sessionTimeout?: number; + /** + * 48-bytes of cryptographically strong pseudo-random data. + */ ticketKeys?: Buffer; + + /** + * + * @param socket + * @param identity identity parameter sent from the client. + * @return pre-shared key that must either be + * a buffer or `null` to stop the negotiation process. Returned PSK must be + * compatible with the selected cipher's digest. + * + * When negotiating TLS-PSK (pre-shared keys), this function is called + * with the identity provided by the client. + * If the return value is `null` the negotiation process will stop and an + * "unknown_psk_identity" alert message will be sent to the other party. + * If the server wishes to hide the fact that the PSK identity was not known, + * the callback must provide some random data as `psk` to make the connection + * fail with "decrypt_error" before negotiation is finished. + * PSK ciphers are disabled by default, and using TLS-PSK thus + * requires explicitly specifying a cipher suite with the `ciphers` option. + * More information can be found in the RFC 4279. + */ + + pskCallback?(socket: TLSSocket, identity: string): DataView | NodeJS.TypedArray | null; + /** + * hint to send to a client to help + * with selecting the identity during TLS-PSK negotiation. Will be ignored + * in TLS 1.3. Upon failing to set pskIdentityHint `tlsClientError` will be + * emitted with `ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED` code. + */ + pskIdentityHint?: string; + } + + interface PSKCallbackNegotation { + psk: DataView | NodeJS.TypedArray; + identity: string; } interface ConnectionOptions extends SecureContextOptions, CommonConnectionOptions { @@ -282,10 +450,50 @@ declare module "tls" { minDHSize?: number; lookup?: net.LookupFunction; timeout?: number; + /** + * When negotiating TLS-PSK (pre-shared keys), this function is called + * with optional identity `hint` provided by the server or `null` + * in case of TLS 1.3 where `hint` was removed. + * It will be necessary to provide a custom `tls.checkServerIdentity()` + * for the connection as the default one will try to check hostname/IP + * of the server against the certificate but that's not applicable for PSK + * because there won't be a certificate present. + * More information can be found in the RFC 4279. + * + * @param hint message sent from the server to help client + * decide which identity to use during negotiation. + * Always `null` if TLS 1.3 is used. + * @returns Return `null` to stop the negotiation process. `psk` must be + * compatible with the selected cipher's digest. + * `identity` must use UTF-8 encoding. + */ + pskCallback?(hint: string | null): PSKCallbackNegotation | null; } class Server extends net.Server { + /** + * The server.addContext() method adds a secure context that will be + * used if the client request's SNI name matches the supplied hostname + * (or wildcard). + */ addContext(hostName: string, credentials: SecureContextOptions): void; + /** + * Returns the session ticket keys. + */ + getTicketKeys(): Buffer; + /** + * + * The server.setSecureContext() method replaces the + * secure context of an existing server. Existing connections to the + * server are not interrupted. + */ + setSecureContext(details: SecureContextOptions): void; + /** + * The server.setSecureContext() method replaces the secure context of + * an existing server. Existing connections to the server are not + * interrupted. + */ + setTicketKeys(keys: Buffer): void; /** * events.EventEmitter @@ -294,6 +502,7 @@ declare module "tls" { * 3. OCSPRequest * 4. resumeSession * 5. secureConnection + * 6. keylog */ addListener(event: string, listener: (...args: any[]) => void): this; addListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this; @@ -352,20 +561,93 @@ declare module "tls" { type SecureVersion = 'TLSv1.3' | 'TLSv1.2' | 'TLSv1.1' | 'TLSv1'; interface SecureContextOptions { - pfx?: string | Buffer | Array; - key?: string | Buffer | Array; - passphrase?: string; - cert?: string | Buffer | Array; + /** + * Optionally override the trusted CA certificates. Default is to trust + * the well-known CAs curated by Mozilla. Mozilla's CAs are completely + * replaced when CAs are explicitly specified using this option. + */ ca?: string | Buffer | Array; + /** + * Cert chains in PEM format. One cert chain should be provided per + * private key. Each cert chain should consist of the PEM formatted + * certificate for a provided private key, followed by the PEM + * formatted intermediate certificates (if any), in order, and not + * including the root CA (the root CA must be pre-known to the peer, + * see ca). When providing multiple cert chains, they do not have to + * be in the same order as their private keys in key. If the + * intermediate certificates are not provided, the peer will not be + * able to validate the certificate, and the handshake will fail. + */ + cert?: string | Buffer | Array; + /** + * Colon-separated list of supported signature algorithms. The list + * can contain digest algorithms (SHA256, MD5 etc.), public key + * algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g + * 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512). + */ + sigalgs?: string; + /** + * Cipher suite specification, replacing the default. For more + * information, see modifying the default cipher suite. Permitted + * ciphers can be obtained via tls.getCiphers(). Cipher names must be + * uppercased in order for OpenSSL to accept them. + */ ciphers?: string; - honorCipherOrder?: boolean; - ecdhCurve?: string; + /** + * Name of an OpenSSL engine which can provide the client certificate. + */ clientCertEngine?: string; + /** + * PEM formatted CRLs (Certificate Revocation Lists). + */ crl?: string | Buffer | Array; + /** + * Diffie Hellman parameters, required for Perfect Forward Secrecy. Use + * openssl dhparam to create the parameters. The key length must be + * greater than or equal to 1024 bits or else an error will be thrown. + * Although 1024 bits is permissible, use 2048 bits or larger for + * stronger security. If omitted or invalid, the parameters are + * silently discarded and DHE ciphers will not be available. + */ dhparam?: string | Buffer; - secureOptions?: number; // Value is a numeric bitmask of the `SSL_OP_*` options - secureProtocol?: string; // SSL Method, e.g. SSLv23_method - sessionIdContext?: string; + /** + * A string describing a named curve or a colon separated list of curve + * NIDs or names, for example P-521:P-384:P-256, to use for ECDH key + * agreement. Set to auto to select the curve automatically. Use + * crypto.getCurves() to obtain a list of available curve names. On + * recent releases, openssl ecparam -list_curves will also display the + * name and description of each available elliptic curve. Default: + * tls.DEFAULT_ECDH_CURVE. + */ + ecdhCurve?: string; + /** + * Attempt to use the server's cipher suite preferences instead of the + * client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be + * set in secureOptions + */ + honorCipherOrder?: boolean; + /** + * Private keys in PEM format. PEM allows the option of private keys + * being encrypted. Encrypted keys will be decrypted with + * options.passphrase. Multiple keys using different algorithms can be + * provided either as an array of unencrypted key strings or buffers, + * or an array of objects in the form {pem: [, + * passphrase: ]}. The object form can only occur in an array. + * object.passphrase is optional. Encrypted keys will be decrypted with + * object.passphrase if provided, or options.passphrase if it is not. + */ + key?: string | Buffer | Array; + /** + * Name of an OpenSSL engine to get private key from. Should be used + * together with privateKeyIdentifier. + */ + privateKeyEngine?: string; + /** + * Identifier of a private key managed by an OpenSSL engine. Should be + * used together with privateKeyEngine. Should not be set together with + * key, because both options define a private key in different ways. + */ + privateKeyIdentifier?: string; /** * Optionally set the maximum TLS version to allow. One * of `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the @@ -386,6 +668,55 @@ declare module "tls" { * 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used. */ minVersion?: SecureVersion; + /** + * Shared passphrase used for a single private key and/or a PFX. + */ + passphrase?: string; + /** + * PFX or PKCS12 encoded private key and certificate chain. pfx is an + * alternative to providing key and cert individually. PFX is usually + * encrypted, if it is, passphrase will be used to decrypt it. Multiple + * PFX can be provided either as an array of unencrypted PFX buffers, + * or an array of objects in the form {buf: [, + * passphrase: ]}. The object form can only occur in an array. + * object.passphrase is optional. Encrypted PFX will be decrypted with + * object.passphrase if provided, or options.passphrase if it is not. + */ + pfx?: string | Buffer | Array; + /** + * Optionally affect the OpenSSL protocol behavior, which is not + * usually necessary. This should be used carefully if at all! Value is + * a numeric bitmask of the SSL_OP_* options from OpenSSL Options + */ + secureOptions?: number; // Value is a numeric bitmask of the `SSL_OP_*` options + /** + * Legacy mechanism to select the TLS protocol version to use, it does + * not support independent control of the minimum and maximum version, + * and does not support limiting the protocol to TLSv1.3. Use + * minVersion and maxVersion instead. The possible values are listed as + * SSL_METHODS, use the function names as strings. For example, use + * 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow + * any TLS protocol version up to TLSv1.3. It is not recommended to use + * TLS versions less than 1.2, but it may be required for + * interoperability. Default: none, see minVersion. + */ + secureProtocol?: string; + /** + * Opaque identifier used by servers to ensure session state is not + * shared between applications. Unused by clients. + */ + sessionIdContext?: string; + /** + * 48-bytes of cryptographically strong pseudo-random data. + * See Session Resumption for more information. + */ + ticketKeys?: Buffer; + /** + * The number of seconds after which a TLS session created by the + * server will no longer be resumable. See Session Resumption for more + * information. Default: 300. + */ + sessionTimeout?: number; } interface SecureContext { @@ -406,13 +737,43 @@ declare module "tls" { function connect(port: number, host?: string, options?: ConnectionOptions, secureConnectListener?: () => void): TLSSocket; function connect(port: number, options?: ConnectionOptions, secureConnectListener?: () => void): TLSSocket; /** - * @deprecated + * @deprecated since v0.11.3 Use `tls.TLSSocket` instead. */ function createSecurePair(credentials?: SecureContext, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair; - function createSecureContext(details: SecureContextOptions): SecureContext; + function createSecureContext(options?: SecureContextOptions): SecureContext; function getCiphers(): string[]; - const DEFAULT_ECDH_CURVE: string; + /** + * The default curve name to use for ECDH key agreement in a tls server. + * The default value is 'auto'. See tls.createSecureContext() for further + * information. + */ + let DEFAULT_ECDH_CURVE: string; + /** + * The default value of the maxVersion option of + * tls.createSecureContext(). It can be assigned any of the supported TLS + * protocol versions, 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Default: + * 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets + * the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to + * 'TLSv1.3'. If multiple of the options are provided, the highest maximum + * is used. + */ + let DEFAULT_MAX_VERSION: SecureVersion; + /** + * The default value of the minVersion option of tls.createSecureContext(). + * It can be assigned any of the supported TLS protocol versions, + * 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Default: 'TLSv1.2', unless + * changed using CLI options. Using --tls-min-v1.0 sets the default to + * 'TLSv1'. Using --tls-min-v1.1 sets the default to 'TLSv1.1'. Using + * --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options + * are provided, the lowest minimum is used. + */ + let DEFAULT_MIN_VERSION: SecureVersion; + /** + * An immutable array of strings representing the root certificates (in PEM + * format) used for verifying peer certificates. This is the default value + * of the ca option to tls.createSecureContext(). + */ const rootCertificates: ReadonlyArray; } diff --git a/node_modules/@types/node/ts3.2/fs.d.ts b/node_modules/@types/node/ts3.2/fs.d.ts deleted file mode 100644 index 0a9eae0..0000000 --- a/node_modules/@types/node/ts3.2/fs.d.ts +++ /dev/null @@ -1,33 +0,0 @@ -// tslint:disable-next-line:no-bad-reference -/// - -declare module 'fs' { - interface BigIntStats extends StatsBase { - } - - class BigIntStats { - atimeNs: BigInt; - mtimeNs: BigInt; - ctimeNs: BigInt; - birthtimeNs: BigInt; - } - - interface BigIntOptions { - bigint: true; - } - - interface StatOptions { - bigint: boolean; - } - - function stat(path: PathLike, options: BigIntOptions, callback: (err: NodeJS.ErrnoException | null, stats: BigIntStats) => void): void; - function stat(path: PathLike, options: StatOptions, callback: (err: NodeJS.ErrnoException | null, stats: Stats | BigIntStats) => void): void; - - namespace stat { - function __promisify__(path: PathLike, options: BigIntOptions): Promise; - function __promisify__(path: PathLike, options: StatOptions): Promise; - } - - function statSync(path: PathLike, options: BigIntOptions): BigIntStats; - function statSync(path: PathLike, options: StatOptions): Stats | BigIntStats; -} diff --git a/node_modules/@types/node/ts3.2/globals.d.ts b/node_modules/@types/node/ts3.2/globals.d.ts deleted file mode 100644 index 70892bc..0000000 --- a/node_modules/@types/node/ts3.2/globals.d.ts +++ /dev/null @@ -1,19 +0,0 @@ -// tslint:disable-next-line:no-bad-reference -/// - -declare namespace NodeJS { - interface HRTime { - bigint(): bigint; - } -} - -interface Buffer extends Uint8Array { - readBigUInt64BE(offset?: number): bigint; - readBigUInt64LE(offset?: number): bigint; - readBigInt64BE(offset?: number): bigint; - readBigInt64LE(offset?: number): bigint; - writeBigInt64BE(value: bigint, offset?: number): number; - writeBigInt64LE(value: bigint, offset?: number): number; - writeBigUInt64BE(value: bigint, offset?: number): number; - writeBigUInt64LE(value: bigint, offset?: number): number; -} diff --git a/node_modules/@types/node/ts3.2/util.d.ts b/node_modules/@types/node/ts3.2/util.d.ts deleted file mode 100644 index a8b2487..0000000 --- a/node_modules/@types/node/ts3.2/util.d.ts +++ /dev/null @@ -1,15 +0,0 @@ -// tslint:disable-next-line:no-bad-reference -/// - -declare module "util" { - namespace inspect { - const custom: unique symbol; - } - namespace promisify { - const custom: unique symbol; - } - namespace types { - function isBigInt64Array(value: any): value is BigInt64Array; - function isBigUint64Array(value: any): value is BigUint64Array; - } -} diff --git a/node_modules/@types/node/ts3.4/assert.d.ts b/node_modules/@types/node/ts3.4/assert.d.ts new file mode 100644 index 0000000..37e24f5 --- /dev/null +++ b/node_modules/@types/node/ts3.4/assert.d.ts @@ -0,0 +1,98 @@ +declare module 'assert' { + /** An alias of `assert.ok()`. */ + function assert(value: any, message?: string | Error): void; + namespace assert { + class AssertionError extends Error { + actual: any; + expected: any; + operator: string; + generatedMessage: boolean; + code: 'ERR_ASSERTION'; + + constructor(options?: { + /** If provided, the error message is set to this value. */ + message?: string; + /** The `actual` property on the error instance. */ + actual?: any; + /** The `expected` property on the error instance. */ + expected?: any; + /** The `operator` property on the error instance. */ + operator?: string; + /** If provided, the generated stack trace omits frames before this function. */ + // tslint:disable-next-line:ban-types + stackStartFn?: Function; + }); + } + + class CallTracker { + calls(exact?: number): () => void; + calls any>(fn?: Func, exact?: number): Func; + report(): CallTrackerReportInformation[]; + verify(): void; + } + interface CallTrackerReportInformation { + message: string; + /** The actual number of times the function was called. */ + actual: number; + /** The number of times the function was expected to be called. */ + expected: number; + /** The name of the function that is wrapped. */ + operator: string; + /** A stack trace of the function. */ + stack: object; + } + + type AssertPredicate = RegExp | (new () => object) | ((thrown: any) => boolean) | object | Error; + + function fail(message?: string | Error): never; + /** @deprecated since v10.0.0 - use fail([message]) or other assert functions instead. */ + function fail( + actual: any, + expected: any, + message?: string | Error, + operator?: string, + // tslint:disable-next-line:ban-types + stackStartFn?: Function, + ): never; + function ok(value: any, message?: string | Error): void; + /** @deprecated since v9.9.0 - use strictEqual() instead. */ + function equal(actual: any, expected: any, message?: string | Error): void; + /** @deprecated since v9.9.0 - use notStrictEqual() instead. */ + function notEqual(actual: any, expected: any, message?: string | Error): void; + /** @deprecated since v9.9.0 - use deepStrictEqual() instead. */ + function deepEqual(actual: any, expected: any, message?: string | Error): void; + /** @deprecated since v9.9.0 - use notDeepStrictEqual() instead. */ + function notDeepEqual(actual: any, expected: any, message?: string | Error): void; + function strictEqual(actual: any, expected: any, message?: string | Error): void; + function notStrictEqual(actual: any, expected: any, message?: string | Error): void; + function deepStrictEqual(actual: any, expected: any, message?: string | Error): void; + function notDeepStrictEqual(actual: any, expected: any, message?: string | Error): void; + + function throws(block: () => any, message?: string | Error): void; + function throws(block: () => any, error: AssertPredicate, message?: string | Error): void; + function doesNotThrow(block: () => any, message?: string | Error): void; + function doesNotThrow(block: () => any, error: AssertPredicate, message?: string | Error): void; + + function ifError(value: any): void; + + function rejects(block: (() => Promise) | Promise, message?: string | Error): Promise; + function rejects( + block: (() => Promise) | Promise, + error: AssertPredicate, + message?: string | Error, + ): Promise; + function doesNotReject(block: (() => Promise) | Promise, message?: string | Error): Promise; + function doesNotReject( + block: (() => Promise) | Promise, + error: AssertPredicate, + message?: string | Error, + ): Promise; + + function match(value: string, regExp: RegExp, message?: string | Error): void; + function doesNotMatch(value: string, regExp: RegExp, message?: string | Error): void; + + const strict: typeof assert; + } + + export = assert; +} diff --git a/node_modules/@types/node/ts3.4/base.d.ts b/node_modules/@types/node/ts3.4/base.d.ts new file mode 100644 index 0000000..2ea04f5 --- /dev/null +++ b/node_modules/@types/node/ts3.4/base.d.ts @@ -0,0 +1,56 @@ +// NOTE: These definitions support NodeJS and TypeScript 3.2 - 3.4. + +// NOTE: TypeScript version-specific augmentations can be found in the following paths: +// - ~/base.d.ts - Shared definitions common to all TypeScript versions +// - ~/index.d.ts - Definitions specific to TypeScript 2.1 +// - ~/ts3.2/base.d.ts - Definitions specific to TypeScript 3.2 +// - ~/ts3.2/index.d.ts - Definitions specific to TypeScript 3.2 with global and assert pulled in + +// Reference required types from the default lib: +/// +/// +/// +/// + +// Base definitions for all NodeJS modules that are not specific to any version of TypeScript: + +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// diff --git a/node_modules/@types/node/ts3.4/globals.global.d.ts b/node_modules/@types/node/ts3.4/globals.global.d.ts new file mode 100644 index 0000000..8e85466 --- /dev/null +++ b/node_modules/@types/node/ts3.4/globals.global.d.ts @@ -0,0 +1 @@ +declare var global: NodeJS.Global; diff --git a/node_modules/@types/node/ts3.4/index.d.ts b/node_modules/@types/node/ts3.4/index.d.ts new file mode 100644 index 0000000..506b32a --- /dev/null +++ b/node_modules/@types/node/ts3.4/index.d.ts @@ -0,0 +1,8 @@ +// NOTE: These definitions support NodeJS and TypeScript 3.2 - 3.4. +// This is required to enable globalThis support for global in ts3.5 without causing errors +// This is required to enable typing assert in ts3.7 without causing errors +// Typically type modifiations should be made in base.d.ts instead of here + +/// +/// +/// diff --git a/node_modules/@types/node/ts3.2/index.d.ts b/node_modules/@types/node/ts3.6/base.d.ts similarity index 55% rename from node_modules/@types/node/ts3.2/index.d.ts rename to node_modules/@types/node/ts3.6/base.d.ts index ee07693..05afa40 100644 --- a/node_modules/@types/node/ts3.2/index.d.ts +++ b/node_modules/@types/node/ts3.6/base.d.ts @@ -1,9 +1,10 @@ -// NOTE: These definitions support NodeJS and TypeScript 3.2. +// NOTE: These definitions support NodeJS and TypeScript 3.5. // NOTE: TypeScript version-specific augmentations can be found in the following paths: // - ~/base.d.ts - Shared definitions common to all TypeScript versions // - ~/index.d.ts - Definitions specific to TypeScript 2.1 -// - ~/ts3.2/index.d.ts - Definitions specific to TypeScript 3.2 +// - ~/ts3.5/base.d.ts - Definitions specific to TypeScript 3.5 +// - ~/ts3.5/index.d.ts - Definitions specific to TypeScript 3.5 with assert pulled in // Reference required types from the default lib: /// @@ -12,10 +13,10 @@ /// // Base definitions for all NodeJS modules that are not specific to any version of TypeScript: -// tslint:disable-next-line:no-bad-reference -/// +/// -// TypeScript 3.2-specific augmentations: -/// -/// -/// +// TypeScript 3.5-specific augmentations: +/// + +// TypeScript 3.5-specific augmentations: +/// diff --git a/node_modules/@types/node/ts3.6/index.d.ts b/node_modules/@types/node/ts3.6/index.d.ts new file mode 100644 index 0000000..7e6b98c --- /dev/null +++ b/node_modules/@types/node/ts3.6/index.d.ts @@ -0,0 +1,7 @@ +// NOTE: These definitions support NodeJS and TypeScript 3.5 - 3.6. +// This is required to enable typing assert in ts3.7 without causing errors +// Typically type modifications should be made in base.d.ts instead of here + +/// + +/// diff --git a/node_modules/@types/node/tty.d.ts b/node_modules/@types/node/tty.d.ts index 22bce21..7854366 100644 --- a/node_modules/@types/node/tty.d.ts +++ b/node_modules/@types/node/tty.d.ts @@ -5,7 +5,7 @@ declare module "tty" { class ReadStream extends net.Socket { constructor(fd: number, options?: net.SocketConstructorOpts); isRaw: boolean; - setRawMode(mode: boolean): void; + setRawMode(mode: boolean): this; isTTY: boolean; } /** diff --git a/node_modules/@types/node/url.d.ts b/node_modules/@types/node/url.d.ts index e5b7e28..24c7afc 100644 --- a/node_modules/@types/node/url.d.ts +++ b/node_modules/@types/node/url.d.ts @@ -8,7 +8,6 @@ declare module "url" { host?: string | null; hostname?: string | null; href?: string | null; - path?: string | null; pathname?: string | null; protocol?: string | null; search?: string | null; @@ -41,13 +40,19 @@ declare module "url" { query: string | null; } + /** @deprecated since v11.0.0 - Use the WHATWG URL API. */ function parse(urlStr: string): UrlWithStringQuery; + /** @deprecated since v11.0.0 - Use the WHATWG URL API. */ function parse(urlStr: string, parseQueryString: false | undefined, slashesDenoteHost?: boolean): UrlWithStringQuery; + /** @deprecated since v11.0.0 - Use the WHATWG URL API. */ function parse(urlStr: string, parseQueryString: true, slashesDenoteHost?: boolean): UrlWithParsedQuery; + /** @deprecated since v11.0.0 - Use the WHATWG URL API. */ function parse(urlStr: string, parseQueryString: boolean, slashesDenoteHost?: boolean): Url; function format(URL: URL, options?: URLFormatOptions): string; + /** @deprecated since v11.0.0 - Use the WHATWG URL API. */ function format(urlObject: UrlObject | string): string; + /** @deprecated since v11.0.0 - Use the WHATWG URL API. */ function resolve(from: string, to: string): string; function domainToASCII(domain: string): string; @@ -93,7 +98,7 @@ declare module "url" { } class URLSearchParams implements Iterable<[string, string]> { - constructor(init?: URLSearchParams | string | { [key: string]: string | string[] | undefined } | Iterable<[string, string]> | Array<[string, string]>); + constructor(init?: URLSearchParams | string | NodeJS.Dict> | Iterable<[string, string]> | ReadonlyArray<[string, string]>); append(name: string, value: string): void; delete(name: string): void; entries(): IterableIterator<[string, string]>; diff --git a/node_modules/@types/node/util.d.ts b/node_modules/@types/node/util.d.ts index e0b6c89..f83a853 100644 --- a/node_modules/@types/node/util.d.ts +++ b/node_modules/@types/node/util.d.ts @@ -1,23 +1,27 @@ declare module "util" { interface InspectOptions extends NodeJS.InspectOptions { } - function format(format: any, ...param: any[]): string; - function formatWithOptions(inspectOptions: InspectOptions, format: string, ...param: any[]): string; + type Style = 'special' | 'number' | 'bigint' | 'boolean' | 'undefined' | 'null' | 'string' | 'symbol' | 'date' | 'regexp' | 'module'; + type CustomInspectFunction = (depth: number, options: InspectOptionsStylized) => string; + interface InspectOptionsStylized extends InspectOptions { + stylize(text: string, styleType: Style): string; + } + function format(format?: any, ...param: any[]): string; + function formatWithOptions(inspectOptions: InspectOptions, format?: any, ...param: any[]): string; /** @deprecated since v0.11.3 - use a third party module instead. */ function log(string: string): void; function inspect(object: any, showHidden?: boolean, depth?: number | null, color?: boolean): string; function inspect(object: any, options: InspectOptions): string; namespace inspect { - let colors: { - [color: string]: [number, number] | undefined - }; + let colors: NodeJS.Dict<[number, number]>; let styles: { - [style: string]: string | undefined + [K in Style]: string }; let defaultOptions: InspectOptions; /** * Allows changing inspect settings from the repl. */ let replDefaults: InspectOptions; + const custom: unique symbol; } /** @deprecated since v4.0.0 - use `Array.isArray()` instead. */ function isArray(object: any): object is any[]; @@ -54,10 +58,6 @@ declare module "util" { function deprecate(fn: T, message: string, code?: string): T; function isDeepStrictEqual(val1: any, val2: any): boolean; - interface CustomPromisify extends Function { - __promisify__: TCustom; - } - function callbackify(fn: () => Promise): (callback: (err: NodeJS.ErrnoException) => void) => void; function callbackify(fn: () => Promise): (callback: (err: NodeJS.ErrnoException, result: TResult) => void) => void; function callbackify(fn: (arg1: T1) => Promise): (arg1: T1, callback: (err: NodeJS.ErrnoException) => void) => void; @@ -83,6 +83,16 @@ declare module "util" { fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void; + interface CustomPromisifyLegacy extends Function { + __promisify__: TCustom; + } + + interface CustomPromisifySymbol extends Function { + [promisify.custom]: TCustom; + } + + type CustomPromisify = CustomPromisifySymbol | CustomPromisifyLegacy; + function promisify(fn: CustomPromisify): TCustom; function promisify(fn: (callback: (err: any, result: TResult) => void) => void): () => Promise; function promisify(fn: (callback: (err?: any) => void) => void): () => Promise; @@ -105,45 +115,62 @@ declare module "util" { fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err?: any) => void) => void, ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise; function promisify(fn: Function): Function; + namespace promisify { + const custom: unique symbol; + } namespace types { - function isAnyArrayBuffer(object: any): boolean; + function isAnyArrayBuffer(object: any): object is ArrayBufferLike; function isArgumentsObject(object: any): object is IArguments; function isArrayBuffer(object: any): object is ArrayBuffer; + function isArrayBufferView(object: any): object is NodeJS.ArrayBufferView; function isAsyncFunction(object: any): boolean; + function isBigInt64Array(value: any): value is BigInt64Array; + function isBigUint64Array(value: any): value is BigUint64Array; function isBooleanObject(object: any): object is Boolean; - function isBoxedPrimitive(object: any): object is (Number | Boolean | String | Symbol /* | Object(BigInt) | Object(Symbol) */); + function isBoxedPrimitive(object: any): object is String | Number | BigInt | Boolean | Symbol; function isDataView(object: any): object is DataView; function isDate(object: any): object is Date; function isExternal(object: any): boolean; function isFloat32Array(object: any): object is Float32Array; function isFloat64Array(object: any): object is Float64Array; - function isGeneratorFunction(object: any): boolean; - function isGeneratorObject(object: any): boolean; + function isGeneratorFunction(object: any): object is GeneratorFunction; + function isGeneratorObject(object: any): object is Generator; function isInt8Array(object: any): object is Int8Array; function isInt16Array(object: any): object is Int16Array; function isInt32Array(object: any): object is Int32Array; - function isMap(object: any): boolean; + function isMap( + object: T | {}, + ): object is T extends ReadonlyMap + ? unknown extends T + ? never + : ReadonlyMap + : Map; function isMapIterator(object: any): boolean; function isModuleNamespaceObject(value: any): boolean; function isNativeError(object: any): object is Error; function isNumberObject(object: any): object is Number; - function isPromise(object: any): boolean; + function isPromise(object: any): object is Promise; function isProxy(object: any): boolean; function isRegExp(object: any): object is RegExp; - function isSet(object: any): boolean; + function isSet( + object: T | {}, + ): object is T extends ReadonlySet + ? unknown extends T + ? never + : ReadonlySet + : Set; function isSetIterator(object: any): boolean; - function isSharedArrayBuffer(object: any): boolean; - function isStringObject(object: any): boolean; - function isSymbolObject(object: any): boolean; + function isSharedArrayBuffer(object: any): object is SharedArrayBuffer; + function isStringObject(object: any): object is String; + function isSymbolObject(object: any): object is Symbol; function isTypedArray(object: any): object is NodeJS.TypedArray; function isUint8Array(object: any): object is Uint8Array; function isUint8ClampedArray(object: any): object is Uint8ClampedArray; function isUint16Array(object: any): object is Uint16Array; function isUint32Array(object: any): object is Uint32Array; - function isWeakMap(object: any): boolean; - function isWeakSet(object: any): boolean; - function isWebAssemblyCompiledModule(object: any): boolean; + function isWeakMap(object: any): object is WeakMap; + function isWeakSet(object: any): object is WeakSet; } class TextDecoder { diff --git a/node_modules/@types/node/v8.d.ts b/node_modules/@types/node/v8.d.ts index 2e2706e..7d95082 100644 --- a/node_modules/@types/node/v8.d.ts +++ b/node_modules/@types/node/v8.d.ts @@ -64,9 +64,6 @@ declare module "v8" { function getHeapCodeStatistics(): HeapCodeStatistics; - /** - * @experimental - */ class Serializer { /** * Writes out a header, which includes the serialization format version. @@ -117,14 +114,10 @@ declare module "v8" { /** * A subclass of `Serializer` that serializes `TypedArray` (in particular `Buffer`) and `DataView` objects as host objects, * and only stores the part of their underlying `ArrayBuffers` that they are referring to. - * @experimental */ class DefaultSerializer extends Serializer { } - /** - * @experimental - */ class Deserializer { constructor(data: NodeJS.TypedArray); /** @@ -178,20 +171,17 @@ declare module "v8" { /** * A subclass of `Serializer` that serializes `TypedArray` (in particular `Buffer`) and `DataView` objects as host objects, * and only stores the part of their underlying `ArrayBuffers` that they are referring to. - * @experimental */ class DefaultDeserializer extends Deserializer { } /** * Uses a `DefaultSerializer` to serialize value into a buffer. - * @experimental */ function serialize(value: any): Buffer; /** * Uses a `DefaultDeserializer` with default options to read a JS value from a buffer. - * @experimental */ function deserialize(data: NodeJS.TypedArray): any; } diff --git a/node_modules/@types/node/vm.d.ts b/node_modules/@types/node/vm.d.ts index 208498c..399c2a6 100644 --- a/node_modules/@types/node/vm.d.ts +++ b/node_modules/@types/node/vm.d.ts @@ -1,7 +1,5 @@ declare module "vm" { - interface Context { - [key: string]: any; - } + interface Context extends NodeJS.Dict { } interface BaseOptions { /** * Specifies the filename used in stack traces produced by this script. @@ -43,6 +41,10 @@ declare module "vm" { * Default: `false`. */ breakOnSigint?: boolean; + /** + * If set to `afterEvaluate`, microtasks will be run immediately after the script has run. + */ + microtaskMode?: 'afterEvaluate'; } interface CompileFunctionOptions extends BaseOptions { /** @@ -94,6 +96,23 @@ declare module "vm" { }; } + type MeasureMemoryMode = 'summary' | 'detailed'; + + interface MeasureMemoryOptions { + /** + * @default 'summary' + */ + mode?: MeasureMemoryMode; + context?: Context; + } + + interface MemoryMeasurement { + total: { + jsMemoryEstimate: number; + jsMemoryRange: [number, number]; + }; + } + class Script { constructor(code: string, options?: ScriptOptions); runInContext(contextifiedSandbox: Context, options?: RunningScriptOptions): any; @@ -106,5 +125,22 @@ declare module "vm" { function runInContext(code: string, contextifiedSandbox: Context, options?: RunningScriptOptions | string): any; function runInNewContext(code: string, sandbox?: Context, options?: RunningScriptOptions | string): any; function runInThisContext(code: string, options?: RunningScriptOptions | string): any; - function compileFunction(code: string, params: string[], options: CompileFunctionOptions): Function; + function compileFunction(code: string, params?: ReadonlyArray, options?: CompileFunctionOptions): Function; + + /** + * Measure the memory known to V8 and used by the current execution context or a specified context. + * + * The format of the object that the returned Promise may resolve with is + * specific to the V8 engine and may change from one version of V8 to the next. + * + * The returned result is different from the statistics returned by + * `v8.getHeapSpaceStatistics()` in that `vm.measureMemory()` measures + * the memory reachable by V8 from a specific context, while + * `v8.getHeapSpaceStatistics()` measures the memory used by an instance + * of V8 engine, which can switch among multiple contexts that reference + * objects in the heap of one engine. + * + * @experimental + */ + function measureMemory(options?: MeasureMemoryOptions): Promise; } diff --git a/node_modules/@types/node/wasi.d.ts b/node_modules/@types/node/wasi.d.ts new file mode 100644 index 0000000..fe2b2aa --- /dev/null +++ b/node_modules/@types/node/wasi.d.ts @@ -0,0 +1,86 @@ +declare module 'wasi' { + interface WASIOptions { + /** + * An array of strings that the WebAssembly application will + * see as command line arguments. The first argument is the virtual path to the + * WASI command itself. + */ + args?: string[]; + + /** + * An object similar to `process.env` that the WebAssembly + * application will see as its environment. + */ + env?: object; + + /** + * This object represents the WebAssembly application's + * sandbox directory structure. The string keys of `preopens` are treated as + * directories within the sandbox. The corresponding values in `preopens` are + * the real paths to those directories on the host machine. + */ + preopens?: NodeJS.Dict; + + /** + * By default, WASI applications terminate the Node.js + * process via the `__wasi_proc_exit()` function. Setting this option to `true` + * causes `wasi.start()` to return the exit code rather than terminate the + * process. + * @default false + */ + returnOnExit?: boolean; + + /** + * The file descriptor used as standard input in the WebAssembly application. + * @default 0 + */ + stdin?: number; + + /** + * The file descriptor used as standard output in the WebAssembly application. + * @default 1 + */ + stdout?: number; + + /** + * The file descriptor used as standard error in the WebAssembly application. + * @default 2 + */ + stderr?: number; + } + + class WASI { + constructor(options?: WASIOptions); + /** + * + * Attempt to begin execution of `instance` by invoking its `_start()` export. + * If `instance` does not contain a `_start()` export, then `start()` attempts to + * invoke the `__wasi_unstable_reactor_start()` export. If neither of those exports + * is present on `instance`, then `start()` does nothing. + * + * `start()` requires that `instance` exports a [`WebAssembly.Memory`][] named + * `memory`. If `instance` does not have a `memory` export an exception is thrown. + * + * If `start()` is called more than once, an exception is thrown. + */ + start(instance: object): void; // TODO: avoid DOM dependency until WASM moved to own lib. + + /** + * Attempt to initialize `instance` as a WASI reactor by invoking its `_initialize()` export, if it is present. + * If `instance` contains a `_start()` export, then an exception is thrown. + * + * `start()` requires that `instance` exports a [`WebAssembly.Memory`][] named + * `memory`. If `instance` does not have a `memory` export an exception is thrown. + * + * If `initialize()` is called more than once, an exception is thrown. + */ + initialize(instance: object): void; // TODO: avoid DOM dependency until WASM moved to own lib. + + /** + * Is an object that implements the WASI system call API. This object + * should be passed as the `wasi_snapshot_preview1` import during the instantiation of a + * [`WebAssembly.Instance`][]. + */ + readonly wasiImport: NodeJS.Dict; // TODO: Narrow to DOM types + } +} diff --git a/node_modules/@types/node/worker_threads.d.ts b/node_modules/@types/node/worker_threads.d.ts index 45ea85e..3a8881e 100644 --- a/node_modules/@types/node/worker_threads.d.ts +++ b/node_modules/@types/node/worker_threads.d.ts @@ -2,9 +2,13 @@ declare module "worker_threads" { import { Context } from "vm"; import { EventEmitter } from "events"; import { Readable, Writable } from "stream"; + import { URL } from "url"; + import { FileHandle } from "fs/promises"; const isMainThread: boolean; const parentPort: null | MessagePort; + const resourceLimits: ResourceLimits; + const SHARE_ENV: unique symbol; const threadId: number; const workerData: any; @@ -13,53 +17,97 @@ declare module "worker_threads" { readonly port2: MessagePort; } + type TransferListItem = ArrayBuffer | MessagePort | FileHandle; + class MessagePort extends EventEmitter { close(): void; - postMessage(value: any, transferList?: Array): void; + postMessage(value: any, transferList?: ReadonlyArray): void; ref(): void; unref(): void; start(): void; addListener(event: "close", listener: () => void): this; addListener(event: "message", listener: (value: any) => void): this; + addListener(event: "messageerror", listener: (error: Error) => void): this; addListener(event: string | symbol, listener: (...args: any[]) => void): this; emit(event: "close"): boolean; emit(event: "message", value: any): boolean; + emit(event: "messageerror", error: Error): boolean; emit(event: string | symbol, ...args: any[]): boolean; on(event: "close", listener: () => void): this; on(event: "message", listener: (value: any) => void): this; + on(event: "messageerror", listener: (error: Error) => void): this; on(event: string | symbol, listener: (...args: any[]) => void): this; once(event: "close", listener: () => void): this; once(event: "message", listener: (value: any) => void): this; + once(event: "messageerror", listener: (error: Error) => void): this; once(event: string | symbol, listener: (...args: any[]) => void): this; prependListener(event: "close", listener: () => void): this; prependListener(event: "message", listener: (value: any) => void): this; + prependListener(event: "messageerror", listener: (error: Error) => void): this; prependListener(event: string | symbol, listener: (...args: any[]) => void): this; prependOnceListener(event: "close", listener: () => void): this; prependOnceListener(event: "message", listener: (value: any) => void): this; + prependOnceListener(event: "messageerror", listener: (error: Error) => void): this; prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; removeListener(event: "close", listener: () => void): this; removeListener(event: "message", listener: (value: any) => void): this; + removeListener(event: "messageerror", listener: (error: Error) => void): this; removeListener(event: string | symbol, listener: (...args: any[]) => void): this; off(event: "close", listener: () => void): this; off(event: "message", listener: (value: any) => void): this; + off(event: "messageerror", listener: (error: Error) => void): this; off(event: string | symbol, listener: (...args: any[]) => void): this; } interface WorkerOptions { + /** + * List of arguments which would be stringified and appended to + * `process.argv` in the worker. This is mostly similar to the `workerData` + * but the values will be available on the global `process.argv` as if they + * were passed as CLI options to the script. + */ + argv?: any[]; + env?: NodeJS.Dict | typeof SHARE_ENV; eval?: boolean; workerData?: any; stdin?: boolean; stdout?: boolean; stderr?: boolean; execArgv?: string[]; + resourceLimits?: ResourceLimits; + /** + * Additional data to send in the first worker message. + */ + transferList?: TransferListItem[]; + trackUnmanagedFds?: boolean; + } + + interface ResourceLimits { + /** + * The maximum size of a heap space for recently created objects. + */ + maxYoungGenerationSizeMb?: number; + /** + * The maximum size of the main heap in MB. + */ + maxOldGenerationSizeMb?: number; + /** + * The size of a pre-allocated memory range used for generated code. + */ + codeRangeSizeMb?: number; + /** + * The default maximum stack size for the thread. Small values may lead to unusable Worker instances. + * @default 4 + */ + stackSizeMb?: number; } class Worker extends EventEmitter { @@ -67,10 +115,16 @@ declare module "worker_threads" { readonly stdout: Readable; readonly stderr: Readable; readonly threadId: number; + readonly resourceLimits?: ResourceLimits; - constructor(filename: string, options?: WorkerOptions); + /** + * @param filename The path to the Worker’s main script or module. + * Must be either an absolute path or a relative path (i.e. relative to the current working directory) starting with ./ or ../, + * or a WHATWG URL object using file: protocol. If options.eval is true, this is a string containing JavaScript code rather than a path. + */ + constructor(filename: string | URL, options?: WorkerOptions); - postMessage(value: any, transferList?: Array): void; + postMessage(value: any, transferList?: ReadonlyArray): void; ref(): void; unref(): void; /** @@ -78,76 +132,107 @@ declare module "worker_threads" { * Returns a Promise for the exit code that is fulfilled when the `exit` event is emitted. */ terminate(): Promise; - /** - * Transfer a `MessagePort` to a different `vm` Context. The original `port` - * object will be rendered unusable, and the returned `MessagePort` instance will - * take its place. - * - * The returned `MessagePort` will be an object in the target context, and will - * inherit from its global `Object` class. Objects passed to the - * `port.onmessage()` listener will also be created in the target context - * and inherit from its global `Object` class. - * - * However, the created `MessagePort` will no longer inherit from - * `EventEmitter`, and only `port.onmessage()` can be used to receive - * events using it. - */ - moveMessagePortToContext(port: MessagePort, context: Context): MessagePort; /** - * Receive a single message from a given `MessagePort`. If no message is available, - * `undefined` is returned, otherwise an object with a single `message` property - * that contains the message payload, corresponding to the oldest message in the - * `MessagePort`’s queue. + * Returns a readable stream for a V8 snapshot of the current state of the Worker. + * See [`v8.getHeapSnapshot()`][] for more details. + * + * If the Worker thread is no longer running, which may occur before the + * [`'exit'` event][] is emitted, the returned `Promise` will be rejected + * immediately with an [`ERR_WORKER_NOT_RUNNING`][] error */ - receiveMessageOnPort(port: MessagePort): {} | undefined; + getHeapSnapshot(): Promise; addListener(event: "error", listener: (err: Error) => void): this; addListener(event: "exit", listener: (exitCode: number) => void): this; addListener(event: "message", listener: (value: any) => void): this; + addListener(event: "messageerror", listener: (error: Error) => void): this; addListener(event: "online", listener: () => void): this; addListener(event: string | symbol, listener: (...args: any[]) => void): this; emit(event: "error", err: Error): boolean; emit(event: "exit", exitCode: number): boolean; emit(event: "message", value: any): boolean; + emit(event: "messageerror", error: Error): boolean; emit(event: "online"): boolean; emit(event: string | symbol, ...args: any[]): boolean; on(event: "error", listener: (err: Error) => void): this; on(event: "exit", listener: (exitCode: number) => void): this; on(event: "message", listener: (value: any) => void): this; + on(event: "messageerror", listener: (error: Error) => void): this; on(event: "online", listener: () => void): this; on(event: string | symbol, listener: (...args: any[]) => void): this; once(event: "error", listener: (err: Error) => void): this; once(event: "exit", listener: (exitCode: number) => void): this; once(event: "message", listener: (value: any) => void): this; + once(event: "messageerror", listener: (error: Error) => void): this; once(event: "online", listener: () => void): this; once(event: string | symbol, listener: (...args: any[]) => void): this; prependListener(event: "error", listener: (err: Error) => void): this; prependListener(event: "exit", listener: (exitCode: number) => void): this; prependListener(event: "message", listener: (value: any) => void): this; + prependListener(event: "messageerror", listener: (error: Error) => void): this; prependListener(event: "online", listener: () => void): this; prependListener(event: string | symbol, listener: (...args: any[]) => void): this; prependOnceListener(event: "error", listener: (err: Error) => void): this; prependOnceListener(event: "exit", listener: (exitCode: number) => void): this; prependOnceListener(event: "message", listener: (value: any) => void): this; + prependOnceListener(event: "messageerror", listener: (error: Error) => void): this; prependOnceListener(event: "online", listener: () => void): this; prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; removeListener(event: "error", listener: (err: Error) => void): this; removeListener(event: "exit", listener: (exitCode: number) => void): this; removeListener(event: "message", listener: (value: any) => void): this; + removeListener(event: "messageerror", listener: (error: Error) => void): this; removeListener(event: "online", listener: () => void): this; removeListener(event: string | symbol, listener: (...args: any[]) => void): this; off(event: "error", listener: (err: Error) => void): this; off(event: "exit", listener: (exitCode: number) => void): this; off(event: "message", listener: (value: any) => void): this; + off(event: "messageerror", listener: (error: Error) => void): this; off(event: "online", listener: () => void): this; off(event: string | symbol, listener: (...args: any[]) => void): this; } + + /** + * Mark an object as not transferable. + * If `object` occurs in the transfer list of a `port.postMessage()` call, it will be ignored. + * + * In particular, this makes sense for objects that can be cloned, rather than transferred, + * and which are used by other objects on the sending side. For example, Node.js marks + * the `ArrayBuffer`s it uses for its Buffer pool with this. + * + * This operation cannot be undone. + */ + function markAsUntransferable(object: object): void; + + /** + * Transfer a `MessagePort` to a different `vm` Context. The original `port` + * object will be rendered unusable, and the returned `MessagePort` instance will + * take its place. + * + * The returned `MessagePort` will be an object in the target context, and will + * inherit from its global `Object` class. Objects passed to the + * `port.onmessage()` listener will also be created in the target context + * and inherit from its global `Object` class. + * + * However, the created `MessagePort` will no longer inherit from + * `EventEmitter`, and only `port.onmessage()` can be used to receive + * events using it. + */ + function moveMessagePortToContext(port: MessagePort, context: Context): MessagePort; + + /** + * Receive a single message from a given `MessagePort`. If no message is available, + * `undefined` is returned, otherwise an object with a single `message` property + * that contains the message payload, corresponding to the oldest message in the + * `MessagePort`’s queue. + */ + function receiveMessageOnPort(port: MessagePort): { message: any } | undefined; } diff --git a/node_modules/@types/node/zlib.d.ts b/node_modules/@types/node/zlib.d.ts index a03e900..754f5ed 100644 --- a/node_modules/@types/node/zlib.d.ts +++ b/node_modules/@types/node/zlib.d.ts @@ -19,6 +19,8 @@ declare module "zlib" { memLevel?: number; // compression only strategy?: number; // compression only dictionary?: NodeJS.ArrayBufferView | ArrayBuffer; // deflate/inflate only, empty dictionary by default + info?: boolean; + maxOutputLength?: number; } interface BrotliOptions { @@ -40,6 +42,7 @@ declare module "zlib" { */ [key: number]: boolean | number; }; + maxOutputLength?: number; } interface Zlib { @@ -48,7 +51,8 @@ declare module "zlib" { readonly bytesWritten: number; shell?: boolean | string; close(callback?: () => void): void; - flush(kind?: number | (() => void), callback?: () => void): void; + flush(kind?: number, callback?: () => void): void; + flush(callback?: () => void): void; } interface ZlibParams { @@ -85,30 +89,74 @@ declare module "zlib" { function brotliCompress(buf: InputType, options: BrotliOptions, callback: CompressCallback): void; function brotliCompress(buf: InputType, callback: CompressCallback): void; + namespace brotliCompress { + function __promisify__(buffer: InputType, options?: BrotliOptions): Promise; + } + function brotliCompressSync(buf: InputType, options?: BrotliOptions): Buffer; + function brotliDecompress(buf: InputType, options: BrotliOptions, callback: CompressCallback): void; function brotliDecompress(buf: InputType, callback: CompressCallback): void; + namespace brotliDecompress { + function __promisify__(buffer: InputType, options?: BrotliOptions): Promise; + } + function brotliDecompressSync(buf: InputType, options?: BrotliOptions): Buffer; + function deflate(buf: InputType, callback: CompressCallback): void; function deflate(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace deflate { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function deflateSync(buf: InputType, options?: ZlibOptions): Buffer; + function deflateRaw(buf: InputType, callback: CompressCallback): void; function deflateRaw(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace deflateRaw { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function deflateRawSync(buf: InputType, options?: ZlibOptions): Buffer; + function gzip(buf: InputType, callback: CompressCallback): void; function gzip(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace gzip { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function gzipSync(buf: InputType, options?: ZlibOptions): Buffer; + function gunzip(buf: InputType, callback: CompressCallback): void; function gunzip(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace gunzip { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function gunzipSync(buf: InputType, options?: ZlibOptions): Buffer; + function inflate(buf: InputType, callback: CompressCallback): void; function inflate(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace inflate { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function inflateSync(buf: InputType, options?: ZlibOptions): Buffer; + function inflateRaw(buf: InputType, callback: CompressCallback): void; function inflateRaw(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace inflateRaw { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function inflateRawSync(buf: InputType, options?: ZlibOptions): Buffer; + function unzip(buf: InputType, callback: CompressCallback): void; function unzip(buf: InputType, options: ZlibOptions, callback: CompressCallback): void; + namespace unzip { + function __promisify__(buffer: InputType, options?: ZlibOptions): Promise; + } + function unzipSync(buf: InputType, options?: ZlibOptions): Buffer; namespace constants { @@ -188,165 +236,126 @@ declare module "zlib" { const INFLATERAW: number; const UNZIP: number; - const Z_BEST_COMPRESSION: number; - const Z_BEST_SPEED: number; - const Z_BLOCK: number; - const Z_BUF_ERROR: number; - const Z_DATA_ERROR: number; - - const Z_DEFAULT_CHUNK: number; - const Z_DEFAULT_COMPRESSION: number; - const Z_DEFAULT_LEVEL: number; - const Z_DEFAULT_MEMLEVEL: number; - const Z_DEFAULT_STRATEGY: number; - const Z_DEFAULT_WINDOWBITS: number; - - const Z_ERRNO: number; - const Z_FILTERED: number; - const Z_FINISH: number; - const Z_FIXED: number; - const Z_FULL_FLUSH: number; - const Z_HUFFMAN_ONLY: number; - const Z_MAX_CHUNK: number; - const Z_MAX_LEVEL: number; - const Z_MAX_MEMLEVEL: number; - const Z_MAX_WINDOWBITS: number; - const Z_MEM_ERROR: number; - const Z_MIN_CHUNK: number; - const Z_MIN_LEVEL: number; - const Z_MIN_MEMLEVEL: number; - const Z_MIN_WINDOWBITS: number; - const Z_NEED_DICT: number; - const Z_NO_COMPRESSION: number; + // Allowed flush values. const Z_NO_FLUSH: number; - const Z_OK: number; const Z_PARTIAL_FLUSH: number; - const Z_RLE: number; - const Z_STREAM_END: number; - const Z_STREAM_ERROR: number; const Z_SYNC_FLUSH: number; + const Z_FULL_FLUSH: number; + const Z_FINISH: number; + const Z_BLOCK: number; + const Z_TREES: number; + + // Return codes for the compression/decompression functions. + // Negative values are errors, positive values are used for special but normal events. + const Z_OK: number; + const Z_STREAM_END: number; + const Z_NEED_DICT: number; + const Z_ERRNO: number; + const Z_STREAM_ERROR: number; + const Z_DATA_ERROR: number; + const Z_MEM_ERROR: number; + const Z_BUF_ERROR: number; const Z_VERSION_ERROR: number; + + // Compression levels. + const Z_NO_COMPRESSION: number; + const Z_BEST_SPEED: number; + const Z_BEST_COMPRESSION: number; + const Z_DEFAULT_COMPRESSION: number; + + // Compression strategy. + const Z_FILTERED: number; + const Z_HUFFMAN_ONLY: number; + const Z_RLE: number; + const Z_FIXED: number; + const Z_DEFAULT_STRATEGY: number; + + const Z_DEFAULT_WINDOWBITS: number; + const Z_MIN_WINDOWBITS: number; + const Z_MAX_WINDOWBITS: number; + + const Z_MIN_CHUNK: number; + const Z_MAX_CHUNK: number; + const Z_DEFAULT_CHUNK: number; + + const Z_MIN_MEMLEVEL: number; + const Z_MAX_MEMLEVEL: number; + const Z_DEFAULT_MEMLEVEL: number; + + const Z_MIN_LEVEL: number; + const Z_MAX_LEVEL: number; + const Z_DEFAULT_LEVEL: number; + const ZLIB_VERNUM: number; } - /** - * @deprecated - */ + // Allowed flush values. + /** @deprecated Use `constants.Z_NO_FLUSH` */ const Z_NO_FLUSH: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_PARTIAL_FLUSH` */ const Z_PARTIAL_FLUSH: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_SYNC_FLUSH` */ const Z_SYNC_FLUSH: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_FULL_FLUSH` */ const Z_FULL_FLUSH: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_FINISH` */ const Z_FINISH: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_BLOCK` */ const Z_BLOCK: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_TREES` */ const Z_TREES: number; - /** - * @deprecated - */ + + // Return codes for the compression/decompression functions. + // Negative values are errors, positive values are used for special but normal events. + /** @deprecated Use `constants.Z_OK` */ const Z_OK: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_STREAM_END` */ const Z_STREAM_END: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_NEED_DICT` */ const Z_NEED_DICT: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_ERRNO` */ const Z_ERRNO: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_STREAM_ERROR` */ const Z_STREAM_ERROR: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_DATA_ERROR` */ const Z_DATA_ERROR: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_MEM_ERROR` */ const Z_MEM_ERROR: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_BUF_ERROR` */ const Z_BUF_ERROR: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_VERSION_ERROR` */ const Z_VERSION_ERROR: number; - /** - * @deprecated - */ + + // Compression levels. + /** @deprecated Use `constants.Z_NO_COMPRESSION` */ const Z_NO_COMPRESSION: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_BEST_SPEED` */ const Z_BEST_SPEED: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_BEST_COMPRESSION` */ const Z_BEST_COMPRESSION: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_DEFAULT_COMPRESSION` */ const Z_DEFAULT_COMPRESSION: number; - /** - * @deprecated - */ + + // Compression strategy. + /** @deprecated Use `constants.Z_FILTERED` */ const Z_FILTERED: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_HUFFMAN_ONLY` */ const Z_HUFFMAN_ONLY: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_RLE` */ const Z_RLE: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_FIXED` */ const Z_FIXED: number; - /** - * @deprecated - */ + /** @deprecated Use `constants.Z_DEFAULT_STRATEGY` */ const Z_DEFAULT_STRATEGY: number; - /** - * @deprecated - */ + + /** @deprecated */ const Z_BINARY: number; - /** - * @deprecated - */ + /** @deprecated */ const Z_TEXT: number; - /** - * @deprecated - */ + /** @deprecated */ const Z_ASCII: number; - /** - * @deprecated - */ + /** @deprecated */ const Z_UNKNOWN: number; - /** - * @deprecated - */ + /** @deprecated */ const Z_DEFLATED: number; } diff --git a/node_modules/atob-lite/.npmignore b/node_modules/atob-lite/.npmignore deleted file mode 100644 index 50c7458..0000000 --- a/node_modules/atob-lite/.npmignore +++ /dev/null @@ -1,6 +0,0 @@ -node_modules -*.log -.DS_Store -bundle.js -test -test.js diff --git a/node_modules/atob-lite/LICENSE.md b/node_modules/atob-lite/LICENSE.md deleted file mode 100644 index ee27ba4..0000000 --- a/node_modules/atob-lite/LICENSE.md +++ /dev/null @@ -1,18 +0,0 @@ -This software is released under the MIT license: - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/atob-lite/README.md b/node_modules/atob-lite/README.md deleted file mode 100644 index 99ea05d..0000000 --- a/node_modules/atob-lite/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# atob-lite -![](http://img.shields.io/badge/stability-stable-orange.svg?style=flat) -![](http://img.shields.io/npm/v/atob-lite.svg?style=flat) -![](http://img.shields.io/npm/dm/atob-lite.svg?style=flat) -![](http://img.shields.io/npm/l/atob-lite.svg?style=flat) - -Smallest/simplest possible means of using atob with both Node and browserify. - -In the browser, decoding base64 strings is done using: - -``` javascript -var decoded = atob(encoded) -``` - -However in Node, it's done like so: - -``` javascript -var decoded = new Buffer(encoded, 'base64').toString('utf8') -``` - -You can easily check if `Buffer` exists and switch between the approaches -accordingly, but using `Buffer` anywhere in your browser source will pull -in browserify's `Buffer` shim which is pretty hefty. This package uses -the `main` and `browser` fields in its `package.json` to perform this -check at build time and avoid pulling `Buffer` in unnecessarily. - -## Usage - -[![NPM](https://nodei.co/npm/atob-lite.png)](https://nodei.co/npm/atob-lite/) - -### `decoded = atob(encoded)` - -Returns the decoded value of a base64-encoded string. - -## License - -MIT. See [LICENSE.md](http://github.com/hughsk/atob-lite/blob/master/LICENSE.md) for details. diff --git a/node_modules/atob-lite/atob-browser.js b/node_modules/atob-lite/atob-browser.js deleted file mode 100644 index cee1a38..0000000 --- a/node_modules/atob-lite/atob-browser.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = function _atob(str) { - return atob(str) -} diff --git a/node_modules/atob-lite/atob-node.js b/node_modules/atob-lite/atob-node.js deleted file mode 100644 index 7072075..0000000 --- a/node_modules/atob-lite/atob-node.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = function atob(str) { - return Buffer.from(str, 'base64').toString('binary') -} diff --git a/node_modules/atob-lite/package.json b/node_modules/atob-lite/package.json deleted file mode 100644 index bc66c4e..0000000 --- a/node_modules/atob-lite/package.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "_from": "atob-lite@^2.0.0", - "_id": "atob-lite@2.0.0", - "_inBundle": false, - "_integrity": "sha1-D+9a1G8b16hQLGVyfwNn1e5D1pY=", - "_location": "/atob-lite", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "atob-lite@^2.0.0", - "name": "atob-lite", - "escapedName": "atob-lite", - "rawSpec": "^2.0.0", - "saveSpec": null, - "fetchSpec": "^2.0.0" - }, - "_requiredBy": [ - "/@octokit/rest" - ], - "_resolved": "https://registry.npmjs.org/atob-lite/-/atob-lite-2.0.0.tgz", - "_shasum": "0fef5ad46f1bd7a8502c65727f0367d5ee43d696", - "_spec": "atob-lite@^2.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/rest", - "author": { - "name": "Hugh Kennedy", - "email": "hughskennedy@gmail.com", - "url": "http://hughsk.io/" - }, - "browser": "atob-browser.js", - "bugs": { - "url": "https://github.com/hughsk/atob-lite/issues" - }, - "bundleDependencies": false, - "dependencies": {}, - "deprecated": false, - "description": "Smallest/simplest possible means of using atob with both Node and browserify", - "devDependencies": { - "browserify": "^10.2.4", - "smokestack": "^3.3.0", - "tap-closer": "^1.0.0", - "tap-spec": "^4.0.0", - "tape": "^4.0.0" - }, - "homepage": "https://github.com/hughsk/atob-lite", - "keywords": [ - "atob", - "base64", - "isomorphic", - "browser", - "node", - "shared" - ], - "license": "MIT", - "main": "atob-node.js", - "name": "atob-lite", - "repository": { - "type": "git", - "url": "git://github.com/hughsk/atob-lite.git" - }, - "scripts": { - "test": "npm run test-node && npm run test-browser", - "test-browser": "browserify test | smokestack | tap-spec", - "test-node": "node test | tap-spec" - }, - "version": "2.0.0" -} diff --git a/node_modules/before-after-hook/package.json b/node_modules/before-after-hook/package.json index fbebe84..1827b7c 100644 --- a/node_modules/before-after-hook/package.json +++ b/node_modules/before-after-hook/package.json @@ -1,36 +1,39 @@ { - "_from": "before-after-hook@^2.0.0", + "_args": [ + [ + "before-after-hook@2.1.0", + "." + ] + ], + "_from": "before-after-hook@2.1.0", "_id": "before-after-hook@2.1.0", "_inBundle": false, "_integrity": "sha512-IWIbu7pMqyw3EAJHzzHbWa85b6oud/yfKYg5rqB5hNE8CeMi3nX+2C2sj0HswfblST86hpVEOAb9x34NZd6P7A==", "_location": "/before-after-hook", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "before-after-hook@^2.0.0", + "raw": "before-after-hook@2.1.0", "name": "before-after-hook", "escapedName": "before-after-hook", - "rawSpec": "^2.0.0", + "rawSpec": "2.1.0", "saveSpec": null, - "fetchSpec": "^2.0.0" + "fetchSpec": "2.1.0" }, "_requiredBy": [ - "/@octokit/rest" + "/@octokit/core" ], "_resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.1.0.tgz", - "_shasum": "b6c03487f44e24200dd30ca5e6a1979c5d2fb635", - "_spec": "before-after-hook@^2.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/rest", + "_spec": "2.1.0", + "_where": ".", "author": { "name": "Gregor Martynus" }, "bugs": { "url": "https://github.com/gr2m/before-after-hook/issues" }, - "bundleDependencies": false, "dependencies": {}, - "deprecated": false, "description": "asynchronous before/error/after hooks for internal functionality", "devDependencies": { "browserify": "^16.0.0", diff --git a/node_modules/btoa-lite/.npmignore b/node_modules/btoa-lite/.npmignore deleted file mode 100644 index 50c7458..0000000 --- a/node_modules/btoa-lite/.npmignore +++ /dev/null @@ -1,6 +0,0 @@ -node_modules -*.log -.DS_Store -bundle.js -test -test.js diff --git a/node_modules/btoa-lite/LICENSE.md b/node_modules/btoa-lite/LICENSE.md deleted file mode 100644 index ee27ba4..0000000 --- a/node_modules/btoa-lite/LICENSE.md +++ /dev/null @@ -1,18 +0,0 @@ -This software is released under the MIT license: - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/btoa-lite/README.md b/node_modules/btoa-lite/README.md deleted file mode 100644 index e36492e..0000000 --- a/node_modules/btoa-lite/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# btoa-lite -![](http://img.shields.io/badge/stability-stable-orange.svg?style=flat) -![](http://img.shields.io/npm/v/btoa-lite.svg?style=flat) -![](http://img.shields.io/npm/dm/btoa-lite.svg?style=flat) -![](http://img.shields.io/npm/l/btoa-lite.svg?style=flat) - -Smallest/simplest possible means of using btoa with both Node and browserify. - -In the browser, encoding base64 strings is done using: - -``` javascript -var encoded = btoa(decoded) -``` - -However in Node, it's done like so: - -``` javascript -var encoded = new Buffer(decoded).toString('base64') -``` - -You can easily check if `Buffer` exists and switch between the approaches -accordingly, but using `Buffer` anywhere in your browser source will pull -in browserify's `Buffer` shim which is pretty hefty. This package uses -the `main` and `browser` fields in its `package.json` to perform this -check at build time and avoid pulling `Buffer` in unnecessarily. - -## Usage - -[![NPM](https://nodei.co/npm/btoa-lite.png)](https://nodei.co/npm/btoa-lite/) - -### `encoded = btoa(decoded)` - -Returns the base64-encoded value of a string. - -## License - -MIT. See [LICENSE.md](http://github.com/hughsk/btoa-lite/blob/master/LICENSE.md) for details. diff --git a/node_modules/btoa-lite/btoa-browser.js b/node_modules/btoa-lite/btoa-browser.js deleted file mode 100644 index 1b3acdb..0000000 --- a/node_modules/btoa-lite/btoa-browser.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = function _btoa(str) { - return btoa(str) -} diff --git a/node_modules/btoa-lite/btoa-node.js b/node_modules/btoa-lite/btoa-node.js deleted file mode 100644 index 0278470..0000000 --- a/node_modules/btoa-lite/btoa-node.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = function btoa(str) { - return new Buffer(str).toString('base64') -} diff --git a/node_modules/btoa-lite/package.json b/node_modules/btoa-lite/package.json deleted file mode 100644 index e338d20..0000000 --- a/node_modules/btoa-lite/package.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "_from": "btoa-lite@^1.0.0", - "_id": "btoa-lite@1.0.0", - "_inBundle": false, - "_integrity": "sha1-M3dm2hWAEhD92VbCLpxokaudAzc=", - "_location": "/btoa-lite", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "btoa-lite@^1.0.0", - "name": "btoa-lite", - "escapedName": "btoa-lite", - "rawSpec": "^1.0.0", - "saveSpec": null, - "fetchSpec": "^1.0.0" - }, - "_requiredBy": [ - "/@octokit/rest" - ], - "_resolved": "https://registry.npmjs.org/btoa-lite/-/btoa-lite-1.0.0.tgz", - "_shasum": "337766da15801210fdd956c22e9c6891ab9d0337", - "_spec": "btoa-lite@^1.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/rest", - "author": { - "name": "Hugh Kennedy", - "email": "hughskennedy@gmail.com", - "url": "http://hughsk.io/" - }, - "browser": "btoa-browser.js", - "bugs": { - "url": "https://github.com/hughsk/btoa-lite/issues" - }, - "bundleDependencies": false, - "dependencies": {}, - "deprecated": false, - "description": "Smallest/simplest possible means of using btoa with both Node and browserify", - "devDependencies": { - "browserify": "^10.2.4", - "smokestack": "^3.3.0", - "tap-spec": "^4.0.0", - "tape": "^4.0.0" - }, - "homepage": "https://github.com/hughsk/btoa-lite", - "keywords": [ - "btoa", - "base64", - "isomorphic", - "browser", - "node", - "shared" - ], - "license": "MIT", - "main": "btoa-node.js", - "name": "btoa-lite", - "repository": { - "type": "git", - "url": "git://github.com/hughsk/btoa-lite.git" - }, - "scripts": { - "test": "npm run test-node && npm run test-browser", - "test-browser": "browserify test | smokestack | tap-spec", - "test-node": "node test | tap-spec" - }, - "version": "1.0.0" -} diff --git a/node_modules/cross-spawn/CHANGELOG.md b/node_modules/cross-spawn/CHANGELOG.md deleted file mode 100644 index ded9620..0000000 --- a/node_modules/cross-spawn/CHANGELOG.md +++ /dev/null @@ -1,100 +0,0 @@ -# Change Log - -All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. - - -## [6.0.5](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.4...v6.0.5) (2018-03-02) - - -### Bug Fixes - -* avoid using deprecated Buffer constructor ([#94](https://github.com/moxystudio/node-cross-spawn/issues/94)) ([d5770df](https://github.com/moxystudio/node-cross-spawn/commit/d5770df)), closes [/nodejs.org/api/deprecations.html#deprecations_dep0005](https://github.com//nodejs.org/api/deprecations.html/issues/deprecations_dep0005) - - - - -## [6.0.4](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.3...v6.0.4) (2018-01-31) - - -### Bug Fixes - -* fix paths being incorrectly normalized on unix ([06ee3c6](https://github.com/moxystudio/node-cross-spawn/commit/06ee3c6)), closes [#90](https://github.com/moxystudio/node-cross-spawn/issues/90) - - - - -## [6.0.3](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.2...v6.0.3) (2018-01-23) - - - - -## [6.0.2](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.1...v6.0.2) (2018-01-23) - - - - -## [6.0.1](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.0...v6.0.1) (2018-01-23) - - - - -# [6.0.0](https://github.com/moxystudio/node-cross-spawn/compare/5.1.0...6.0.0) (2018-01-23) - - -### Bug Fixes - -* fix certain arguments not being correctly escaped or causing batch syntax error ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)), closes [#82](https://github.com/moxystudio/node-cross-spawn/issues/82) [#51](https://github.com/moxystudio/node-cross-spawn/issues/51) -* fix commands as posix relatixe paths not working correctly, e.g.: `./my-command` ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)) -* fix `options` argument being mutated ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)) -* fix commands resolution when PATH was actually Path ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)) - - -### Features - -* improve compliance with node's ENOENT errors ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)) -* improve detection of node's shell option support ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)) - - -### Chores - -* upgrade tooling -* upgrate project to es6 (node v4) - - -### BREAKING CHANGES - -* remove support for older nodejs versions, only `node >= 4` is supported - - - -## [5.1.0](https://github.com/moxystudio/node-cross-spawn/compare/5.0.1...5.1.0) (2017-02-26) - - -### Bug Fixes - -* fix `options.shell` support for NodeJS [v4.8](https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_V4.md#4.8.0) - - - -## [5.0.1](https://github.com/moxystudio/node-cross-spawn/compare/5.0.0...5.0.1) (2016-11-04) - - -### Bug Fixes - -* fix `options.shell` support for NodeJS v7 - - - -# [5.0.0](https://github.com/moxystudio/node-cross-spawn/compare/4.0.2...5.0.0) (2016-10-30) - - -## Features - -* add support for `options.shell` -* improve parsing of shebangs by using [`shebang-command`](https://github.com/kevva/shebang-command) module - - -## Chores - -* refactor some code to make it more clear -* update README caveats diff --git a/node_modules/cross-spawn/LICENSE b/node_modules/cross-spawn/LICENSE deleted file mode 100644 index 8407b9a..0000000 --- a/node_modules/cross-spawn/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2018 Made With MOXY Lda - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/node_modules/cross-spawn/README.md b/node_modules/cross-spawn/README.md deleted file mode 100644 index e895cd7..0000000 --- a/node_modules/cross-spawn/README.md +++ /dev/null @@ -1,94 +0,0 @@ -# cross-spawn - -[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Build status][appveyor-image]][appveyor-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url] [![Greenkeeper badge][greenkeeper-image]][greenkeeper-url] - -[npm-url]:https://npmjs.org/package/cross-spawn -[downloads-image]:http://img.shields.io/npm/dm/cross-spawn.svg -[npm-image]:http://img.shields.io/npm/v/cross-spawn.svg -[travis-url]:https://travis-ci.org/moxystudio/node-cross-spawn -[travis-image]:http://img.shields.io/travis/moxystudio/node-cross-spawn/master.svg -[appveyor-url]:https://ci.appveyor.com/project/satazor/node-cross-spawn -[appveyor-image]:https://img.shields.io/appveyor/ci/satazor/node-cross-spawn/master.svg -[codecov-url]:https://codecov.io/gh/moxystudio/node-cross-spawn -[codecov-image]:https://img.shields.io/codecov/c/github/moxystudio/node-cross-spawn/master.svg -[david-dm-url]:https://david-dm.org/moxystudio/node-cross-spawn -[david-dm-image]:https://img.shields.io/david/moxystudio/node-cross-spawn.svg -[david-dm-dev-url]:https://david-dm.org/moxystudio/node-cross-spawn?type=dev -[david-dm-dev-image]:https://img.shields.io/david/dev/moxystudio/node-cross-spawn.svg -[greenkeeper-image]:https://badges.greenkeeper.io/moxystudio/node-cross-spawn.svg -[greenkeeper-url]:https://greenkeeper.io/ - -A cross platform solution to node's spawn and spawnSync. - - -## Installation - -`$ npm install cross-spawn` - - -## Why - -Node has issues when using spawn on Windows: - -- It ignores [PATHEXT](https://github.com/joyent/node/issues/2318) -- It does not support [shebangs](https://en.wikipedia.org/wiki/Shebang_(Unix)) -- Has problems running commands with [spaces](https://github.com/nodejs/node/issues/7367) -- Has problems running commands with posix relative paths (e.g.: `./my-folder/my-executable`) -- Has an [issue](https://github.com/moxystudio/node-cross-spawn/issues/82) with command shims (files in `node_modules/.bin/`), where arguments with quotes and parenthesis would result in [invalid syntax error](https://github.com/moxystudio/node-cross-spawn/blob/e77b8f22a416db46b6196767bcd35601d7e11d54/test/index.test.js#L149) -- No `options.shell` support on node `` where `` must not contain any arguments. -If you would like to have the shebang support improved, feel free to contribute via a pull-request. - -Remember to always test your code on Windows! - - -## Tests - -`$ npm test` -`$ npm test -- --watch` during development - -## License - -Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php). diff --git a/node_modules/cross-spawn/index.js b/node_modules/cross-spawn/index.js deleted file mode 100644 index 5509742..0000000 --- a/node_modules/cross-spawn/index.js +++ /dev/null @@ -1,39 +0,0 @@ -'use strict'; - -const cp = require('child_process'); -const parse = require('./lib/parse'); -const enoent = require('./lib/enoent'); - -function spawn(command, args, options) { - // Parse the arguments - const parsed = parse(command, args, options); - - // Spawn the child process - const spawned = cp.spawn(parsed.command, parsed.args, parsed.options); - - // Hook into child process "exit" event to emit an error if the command - // does not exists, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16 - enoent.hookChildProcess(spawned, parsed); - - return spawned; -} - -function spawnSync(command, args, options) { - // Parse the arguments - const parsed = parse(command, args, options); - - // Spawn the child process - const result = cp.spawnSync(parsed.command, parsed.args, parsed.options); - - // Analyze if the command does not exist, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16 - result.error = result.error || enoent.verifyENOENTSync(result.status, parsed); - - return result; -} - -module.exports = spawn; -module.exports.spawn = spawn; -module.exports.sync = spawnSync; - -module.exports._parse = parse; -module.exports._enoent = enoent; diff --git a/node_modules/cross-spawn/lib/enoent.js b/node_modules/cross-spawn/lib/enoent.js deleted file mode 100644 index 14df9b6..0000000 --- a/node_modules/cross-spawn/lib/enoent.js +++ /dev/null @@ -1,59 +0,0 @@ -'use strict'; - -const isWin = process.platform === 'win32'; - -function notFoundError(original, syscall) { - return Object.assign(new Error(`${syscall} ${original.command} ENOENT`), { - code: 'ENOENT', - errno: 'ENOENT', - syscall: `${syscall} ${original.command}`, - path: original.command, - spawnargs: original.args, - }); -} - -function hookChildProcess(cp, parsed) { - if (!isWin) { - return; - } - - const originalEmit = cp.emit; - - cp.emit = function (name, arg1) { - // If emitting "exit" event and exit code is 1, we need to check if - // the command exists and emit an "error" instead - // See https://github.com/IndigoUnited/node-cross-spawn/issues/16 - if (name === 'exit') { - const err = verifyENOENT(arg1, parsed, 'spawn'); - - if (err) { - return originalEmit.call(cp, 'error', err); - } - } - - return originalEmit.apply(cp, arguments); // eslint-disable-line prefer-rest-params - }; -} - -function verifyENOENT(status, parsed) { - if (isWin && status === 1 && !parsed.file) { - return notFoundError(parsed.original, 'spawn'); - } - - return null; -} - -function verifyENOENTSync(status, parsed) { - if (isWin && status === 1 && !parsed.file) { - return notFoundError(parsed.original, 'spawnSync'); - } - - return null; -} - -module.exports = { - hookChildProcess, - verifyENOENT, - verifyENOENTSync, - notFoundError, -}; diff --git a/node_modules/cross-spawn/lib/parse.js b/node_modules/cross-spawn/lib/parse.js deleted file mode 100644 index 962827a..0000000 --- a/node_modules/cross-spawn/lib/parse.js +++ /dev/null @@ -1,125 +0,0 @@ -'use strict'; - -const path = require('path'); -const niceTry = require('nice-try'); -const resolveCommand = require('./util/resolveCommand'); -const escape = require('./util/escape'); -const readShebang = require('./util/readShebang'); -const semver = require('semver'); - -const isWin = process.platform === 'win32'; -const isExecutableRegExp = /\.(?:com|exe)$/i; -const isCmdShimRegExp = /node_modules[\\/].bin[\\/][^\\/]+\.cmd$/i; - -// `options.shell` is supported in Node ^4.8.0, ^5.7.0 and >= 6.0.0 -const supportsShellOption = niceTry(() => semver.satisfies(process.version, '^4.8.0 || ^5.7.0 || >= 6.0.0', true)) || false; - -function detectShebang(parsed) { - parsed.file = resolveCommand(parsed); - - const shebang = parsed.file && readShebang(parsed.file); - - if (shebang) { - parsed.args.unshift(parsed.file); - parsed.command = shebang; - - return resolveCommand(parsed); - } - - return parsed.file; -} - -function parseNonShell(parsed) { - if (!isWin) { - return parsed; - } - - // Detect & add support for shebangs - const commandFile = detectShebang(parsed); - - // We don't need a shell if the command filename is an executable - const needsShell = !isExecutableRegExp.test(commandFile); - - // If a shell is required, use cmd.exe and take care of escaping everything correctly - // Note that `forceShell` is an hidden option used only in tests - if (parsed.options.forceShell || needsShell) { - // Need to double escape meta chars if the command is a cmd-shim located in `node_modules/.bin/` - // The cmd-shim simply calls execute the package bin file with NodeJS, proxying any argument - // Because the escape of metachars with ^ gets interpreted when the cmd.exe is first called, - // we need to double escape them - const needsDoubleEscapeMetaChars = isCmdShimRegExp.test(commandFile); - - // Normalize posix paths into OS compatible paths (e.g.: foo/bar -> foo\bar) - // This is necessary otherwise it will always fail with ENOENT in those cases - parsed.command = path.normalize(parsed.command); - - // Escape command & arguments - parsed.command = escape.command(parsed.command); - parsed.args = parsed.args.map((arg) => escape.argument(arg, needsDoubleEscapeMetaChars)); - - const shellCommand = [parsed.command].concat(parsed.args).join(' '); - - parsed.args = ['/d', '/s', '/c', `"${shellCommand}"`]; - parsed.command = process.env.comspec || 'cmd.exe'; - parsed.options.windowsVerbatimArguments = true; // Tell node's spawn that the arguments are already escaped - } - - return parsed; -} - -function parseShell(parsed) { - // If node supports the shell option, there's no need to mimic its behavior - if (supportsShellOption) { - return parsed; - } - - // Mimic node shell option - // See https://github.com/nodejs/node/blob/b9f6a2dc059a1062776133f3d4fd848c4da7d150/lib/child_process.js#L335 - const shellCommand = [parsed.command].concat(parsed.args).join(' '); - - if (isWin) { - parsed.command = typeof parsed.options.shell === 'string' ? parsed.options.shell : process.env.comspec || 'cmd.exe'; - parsed.args = ['/d', '/s', '/c', `"${shellCommand}"`]; - parsed.options.windowsVerbatimArguments = true; // Tell node's spawn that the arguments are already escaped - } else { - if (typeof parsed.options.shell === 'string') { - parsed.command = parsed.options.shell; - } else if (process.platform === 'android') { - parsed.command = '/system/bin/sh'; - } else { - parsed.command = '/bin/sh'; - } - - parsed.args = ['-c', shellCommand]; - } - - return parsed; -} - -function parse(command, args, options) { - // Normalize arguments, similar to nodejs - if (args && !Array.isArray(args)) { - options = args; - args = null; - } - - args = args ? args.slice(0) : []; // Clone array to avoid changing the original - options = Object.assign({}, options); // Clone object to avoid changing the original - - // Build our parsed object - const parsed = { - command, - args, - options, - file: undefined, - original: { - command, - args, - }, - }; - - // Delegate further parsing to shell or non-shell - return options.shell ? parseShell(parsed) : parseNonShell(parsed); -} - -module.exports = parse; diff --git a/node_modules/cross-spawn/lib/util/escape.js b/node_modules/cross-spawn/lib/util/escape.js deleted file mode 100644 index b0bb84c..0000000 --- a/node_modules/cross-spawn/lib/util/escape.js +++ /dev/null @@ -1,45 +0,0 @@ -'use strict'; - -// See http://www.robvanderwoude.com/escapechars.php -const metaCharsRegExp = /([()\][%!^"`<>&|;, *?])/g; - -function escapeCommand(arg) { - // Escape meta chars - arg = arg.replace(metaCharsRegExp, '^$1'); - - return arg; -} - -function escapeArgument(arg, doubleEscapeMetaChars) { - // Convert to string - arg = `${arg}`; - - // Algorithm below is based on https://qntm.org/cmd - - // Sequence of backslashes followed by a double quote: - // double up all the backslashes and escape the double quote - arg = arg.replace(/(\\*)"/g, '$1$1\\"'); - - // Sequence of backslashes followed by the end of the string - // (which will become a double quote later): - // double up all the backslashes - arg = arg.replace(/(\\*)$/, '$1$1'); - - // All other backslashes occur literally - - // Quote the whole thing: - arg = `"${arg}"`; - - // Escape meta chars - arg = arg.replace(metaCharsRegExp, '^$1'); - - // Double escape meta chars if necessary - if (doubleEscapeMetaChars) { - arg = arg.replace(metaCharsRegExp, '^$1'); - } - - return arg; -} - -module.exports.command = escapeCommand; -module.exports.argument = escapeArgument; diff --git a/node_modules/cross-spawn/lib/util/readShebang.js b/node_modules/cross-spawn/lib/util/readShebang.js deleted file mode 100644 index bd4f128..0000000 --- a/node_modules/cross-spawn/lib/util/readShebang.js +++ /dev/null @@ -1,32 +0,0 @@ -'use strict'; - -const fs = require('fs'); -const shebangCommand = require('shebang-command'); - -function readShebang(command) { - // Read the first 150 bytes from the file - const size = 150; - let buffer; - - if (Buffer.alloc) { - // Node.js v4.5+ / v5.10+ - buffer = Buffer.alloc(size); - } else { - // Old Node.js API - buffer = new Buffer(size); - buffer.fill(0); // zero-fill - } - - let fd; - - try { - fd = fs.openSync(command, 'r'); - fs.readSync(fd, buffer, 0, size, 0); - fs.closeSync(fd); - } catch (e) { /* Empty */ } - - // Attempt to extract shebang (null is returned if not a shebang) - return shebangCommand(buffer.toString()); -} - -module.exports = readShebang; diff --git a/node_modules/cross-spawn/lib/util/resolveCommand.js b/node_modules/cross-spawn/lib/util/resolveCommand.js deleted file mode 100644 index 2fd5ad2..0000000 --- a/node_modules/cross-spawn/lib/util/resolveCommand.js +++ /dev/null @@ -1,47 +0,0 @@ -'use strict'; - -const path = require('path'); -const which = require('which'); -const pathKey = require('path-key')(); - -function resolveCommandAttempt(parsed, withoutPathExt) { - const cwd = process.cwd(); - const hasCustomCwd = parsed.options.cwd != null; - - // If a custom `cwd` was specified, we need to change the process cwd - // because `which` will do stat calls but does not support a custom cwd - if (hasCustomCwd) { - try { - process.chdir(parsed.options.cwd); - } catch (err) { - /* Empty */ - } - } - - let resolved; - - try { - resolved = which.sync(parsed.command, { - path: (parsed.options.env || process.env)[pathKey], - pathExt: withoutPathExt ? path.delimiter : undefined, - }); - } catch (e) { - /* Empty */ - } finally { - process.chdir(cwd); - } - - // If we successfully resolved, ensure that an absolute path is returned - // Note that when a custom `cwd` was used, we need to resolve to an absolute path based on it - if (resolved) { - resolved = path.resolve(hasCustomCwd ? parsed.options.cwd : '', resolved); - } - - return resolved; -} - -function resolveCommand(parsed) { - return resolveCommandAttempt(parsed) || resolveCommandAttempt(parsed, true); -} - -module.exports = resolveCommand; diff --git a/node_modules/cross-spawn/node_modules/.bin/semver b/node_modules/cross-spawn/node_modules/.bin/semver deleted file mode 120000 index 317eb29..0000000 --- a/node_modules/cross-spawn/node_modules/.bin/semver +++ /dev/null @@ -1 +0,0 @@ -../semver/bin/semver \ No newline at end of file diff --git a/node_modules/cross-spawn/node_modules/semver/CHANGELOG.md b/node_modules/cross-spawn/node_modules/semver/CHANGELOG.md deleted file mode 100644 index 66304fd..0000000 --- a/node_modules/cross-spawn/node_modules/semver/CHANGELOG.md +++ /dev/null @@ -1,39 +0,0 @@ -# changes log - -## 5.7 - -* Add `minVersion` method - -## 5.6 - -* Move boolean `loose` param to an options object, with - backwards-compatibility protection. -* Add ability to opt out of special prerelease version handling with - the `includePrerelease` option flag. - -## 5.5 - -* Add version coercion capabilities - -## 5.4 - -* Add intersection checking - -## 5.3 - -* Add `minSatisfying` method - -## 5.2 - -* Add `prerelease(v)` that returns prerelease components - -## 5.1 - -* Add Backus-Naur for ranges -* Remove excessively cute inspection methods - -## 5.0 - -* Remove AMD/Browserified build artifacts -* Fix ltr and gtr when using the `*` range -* Fix for range `*` with a prerelease identifier diff --git a/node_modules/cross-spawn/node_modules/semver/LICENSE b/node_modules/cross-spawn/node_modules/semver/LICENSE deleted file mode 100644 index 19129e3..0000000 --- a/node_modules/cross-spawn/node_modules/semver/LICENSE +++ /dev/null @@ -1,15 +0,0 @@ -The ISC License - -Copyright (c) Isaac Z. Schlueter and Contributors - -Permission to use, copy, modify, and/or distribute this software for any -purpose with or without fee is hereby granted, provided that the above -copyright notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR -IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/cross-spawn/node_modules/semver/README.md b/node_modules/cross-spawn/node_modules/semver/README.md deleted file mode 100644 index e5ccece..0000000 --- a/node_modules/cross-spawn/node_modules/semver/README.md +++ /dev/null @@ -1,411 +0,0 @@ -semver(1) -- The semantic versioner for npm -=========================================== - -## Install - -```bash -npm install --save semver -```` - -## Usage - -As a node module: - -```js -const semver = require('semver') - -semver.valid('1.2.3') // '1.2.3' -semver.valid('a.b.c') // null -semver.clean(' =v1.2.3 ') // '1.2.3' -semver.satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3') // true -semver.gt('1.2.3', '9.8.7') // false -semver.lt('1.2.3', '9.8.7') // true -semver.minVersion('>=1.0.0') // '1.0.0' -semver.valid(semver.coerce('v2')) // '2.0.0' -semver.valid(semver.coerce('42.6.7.9.3-alpha')) // '42.6.7' -``` - -As a command-line utility: - -``` -$ semver -h - -A JavaScript implementation of the https://semver.org/ specification -Copyright Isaac Z. Schlueter - -Usage: semver [options] [ [...]] -Prints valid versions sorted by SemVer precedence - -Options: --r --range - Print versions that match the specified range. - --i --increment [] - Increment a version by the specified level. Level can - be one of: major, minor, patch, premajor, preminor, - prepatch, or prerelease. Default level is 'patch'. - Only one version may be specified. - ---preid - Identifier to be used to prefix premajor, preminor, - prepatch or prerelease version increments. - --l --loose - Interpret versions and ranges loosely - --p --include-prerelease - Always include prerelease versions in range matching - --c --coerce - Coerce a string into SemVer if possible - (does not imply --loose) - -Program exits successfully if any valid version satisfies -all supplied ranges, and prints all satisfying versions. - -If no satisfying versions are found, then exits failure. - -Versions are printed in ascending order, so supplying -multiple versions to the utility will just sort them. -``` - -## Versions - -A "version" is described by the `v2.0.0` specification found at -. - -A leading `"="` or `"v"` character is stripped off and ignored. - -## Ranges - -A `version range` is a set of `comparators` which specify versions -that satisfy the range. - -A `comparator` is composed of an `operator` and a `version`. The set -of primitive `operators` is: - -* `<` Less than -* `<=` Less than or equal to -* `>` Greater than -* `>=` Greater than or equal to -* `=` Equal. If no operator is specified, then equality is assumed, - so this operator is optional, but MAY be included. - -For example, the comparator `>=1.2.7` would match the versions -`1.2.7`, `1.2.8`, `2.5.3`, and `1.3.9`, but not the versions `1.2.6` -or `1.1.0`. - -Comparators can be joined by whitespace to form a `comparator set`, -which is satisfied by the **intersection** of all of the comparators -it includes. - -A range is composed of one or more comparator sets, joined by `||`. A -version matches a range if and only if every comparator in at least -one of the `||`-separated comparator sets is satisfied by the version. - -For example, the range `>=1.2.7 <1.3.0` would match the versions -`1.2.7`, `1.2.8`, and `1.2.99`, but not the versions `1.2.6`, `1.3.0`, -or `1.1.0`. - -The range `1.2.7 || >=1.2.9 <2.0.0` would match the versions `1.2.7`, -`1.2.9`, and `1.4.6`, but not the versions `1.2.8` or `2.0.0`. - -### Prerelease Tags - -If a version has a prerelease tag (for example, `1.2.3-alpha.3`) then -it will only be allowed to satisfy comparator sets if at least one -comparator with the same `[major, minor, patch]` tuple also has a -prerelease tag. - -For example, the range `>1.2.3-alpha.3` would be allowed to match the -version `1.2.3-alpha.7`, but it would *not* be satisfied by -`3.4.5-alpha.9`, even though `3.4.5-alpha.9` is technically "greater -than" `1.2.3-alpha.3` according to the SemVer sort rules. The version -range only accepts prerelease tags on the `1.2.3` version. The -version `3.4.5` *would* satisfy the range, because it does not have a -prerelease flag, and `3.4.5` is greater than `1.2.3-alpha.7`. - -The purpose for this behavior is twofold. First, prerelease versions -frequently are updated very quickly, and contain many breaking changes -that are (by the author's design) not yet fit for public consumption. -Therefore, by default, they are excluded from range matching -semantics. - -Second, a user who has opted into using a prerelease version has -clearly indicated the intent to use *that specific* set of -alpha/beta/rc versions. By including a prerelease tag in the range, -the user is indicating that they are aware of the risk. However, it -is still not appropriate to assume that they have opted into taking a -similar risk on the *next* set of prerelease versions. - -Note that this behavior can be suppressed (treating all prerelease -versions as if they were normal versions, for the purpose of range -matching) by setting the `includePrerelease` flag on the options -object to any -[functions](https://github.com/npm/node-semver#functions) that do -range matching. - -#### Prerelease Identifiers - -The method `.inc` takes an additional `identifier` string argument that -will append the value of the string as a prerelease identifier: - -```javascript -semver.inc('1.2.3', 'prerelease', 'beta') -// '1.2.4-beta.0' -``` - -command-line example: - -```bash -$ semver 1.2.3 -i prerelease --preid beta -1.2.4-beta.0 -``` - -Which then can be used to increment further: - -```bash -$ semver 1.2.4-beta.0 -i prerelease -1.2.4-beta.1 -``` - -### Advanced Range Syntax - -Advanced range syntax desugars to primitive comparators in -deterministic ways. - -Advanced ranges may be combined in the same way as primitive -comparators using white space or `||`. - -#### Hyphen Ranges `X.Y.Z - A.B.C` - -Specifies an inclusive set. - -* `1.2.3 - 2.3.4` := `>=1.2.3 <=2.3.4` - -If a partial version is provided as the first version in the inclusive -range, then the missing pieces are replaced with zeroes. - -* `1.2 - 2.3.4` := `>=1.2.0 <=2.3.4` - -If a partial version is provided as the second version in the -inclusive range, then all versions that start with the supplied parts -of the tuple are accepted, but nothing that would be greater than the -provided tuple parts. - -* `1.2.3 - 2.3` := `>=1.2.3 <2.4.0` -* `1.2.3 - 2` := `>=1.2.3 <3.0.0` - -#### X-Ranges `1.2.x` `1.X` `1.2.*` `*` - -Any of `X`, `x`, or `*` may be used to "stand in" for one of the -numeric values in the `[major, minor, patch]` tuple. - -* `*` := `>=0.0.0` (Any version satisfies) -* `1.x` := `>=1.0.0 <2.0.0` (Matching major version) -* `1.2.x` := `>=1.2.0 <1.3.0` (Matching major and minor versions) - -A partial version range is treated as an X-Range, so the special -character is in fact optional. - -* `""` (empty string) := `*` := `>=0.0.0` -* `1` := `1.x.x` := `>=1.0.0 <2.0.0` -* `1.2` := `1.2.x` := `>=1.2.0 <1.3.0` - -#### Tilde Ranges `~1.2.3` `~1.2` `~1` - -Allows patch-level changes if a minor version is specified on the -comparator. Allows minor-level changes if not. - -* `~1.2.3` := `>=1.2.3 <1.(2+1).0` := `>=1.2.3 <1.3.0` -* `~1.2` := `>=1.2.0 <1.(2+1).0` := `>=1.2.0 <1.3.0` (Same as `1.2.x`) -* `~1` := `>=1.0.0 <(1+1).0.0` := `>=1.0.0 <2.0.0` (Same as `1.x`) -* `~0.2.3` := `>=0.2.3 <0.(2+1).0` := `>=0.2.3 <0.3.0` -* `~0.2` := `>=0.2.0 <0.(2+1).0` := `>=0.2.0 <0.3.0` (Same as `0.2.x`) -* `~0` := `>=0.0.0 <(0+1).0.0` := `>=0.0.0 <1.0.0` (Same as `0.x`) -* `~1.2.3-beta.2` := `>=1.2.3-beta.2 <1.3.0` Note that prereleases in - the `1.2.3` version will be allowed, if they are greater than or - equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but - `1.2.4-beta.2` would not, because it is a prerelease of a - different `[major, minor, patch]` tuple. - -#### Caret Ranges `^1.2.3` `^0.2.5` `^0.0.4` - -Allows changes that do not modify the left-most non-zero digit in the -`[major, minor, patch]` tuple. In other words, this allows patch and -minor updates for versions `1.0.0` and above, patch updates for -versions `0.X >=0.1.0`, and *no* updates for versions `0.0.X`. - -Many authors treat a `0.x` version as if the `x` were the major -"breaking-change" indicator. - -Caret ranges are ideal when an author may make breaking changes -between `0.2.4` and `0.3.0` releases, which is a common practice. -However, it presumes that there will *not* be breaking changes between -`0.2.4` and `0.2.5`. It allows for changes that are presumed to be -additive (but non-breaking), according to commonly observed practices. - -* `^1.2.3` := `>=1.2.3 <2.0.0` -* `^0.2.3` := `>=0.2.3 <0.3.0` -* `^0.0.3` := `>=0.0.3 <0.0.4` -* `^1.2.3-beta.2` := `>=1.2.3-beta.2 <2.0.0` Note that prereleases in - the `1.2.3` version will be allowed, if they are greater than or - equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but - `1.2.4-beta.2` would not, because it is a prerelease of a - different `[major, minor, patch]` tuple. -* `^0.0.3-beta` := `>=0.0.3-beta <0.0.4` Note that prereleases in the - `0.0.3` version *only* will be allowed, if they are greater than or - equal to `beta`. So, `0.0.3-pr.2` would be allowed. - -When parsing caret ranges, a missing `patch` value desugars to the -number `0`, but will allow flexibility within that value, even if the -major and minor versions are both `0`. - -* `^1.2.x` := `>=1.2.0 <2.0.0` -* `^0.0.x` := `>=0.0.0 <0.1.0` -* `^0.0` := `>=0.0.0 <0.1.0` - -A missing `minor` and `patch` values will desugar to zero, but also -allow flexibility within those values, even if the major version is -zero. - -* `^1.x` := `>=1.0.0 <2.0.0` -* `^0.x` := `>=0.0.0 <1.0.0` - -### Range Grammar - -Putting all this together, here is a Backus-Naur grammar for ranges, -for the benefit of parser authors: - -```bnf -range-set ::= range ( logical-or range ) * -logical-or ::= ( ' ' ) * '||' ( ' ' ) * -range ::= hyphen | simple ( ' ' simple ) * | '' -hyphen ::= partial ' - ' partial -simple ::= primitive | partial | tilde | caret -primitive ::= ( '<' | '>' | '>=' | '<=' | '=' ) partial -partial ::= xr ( '.' xr ( '.' xr qualifier ? )? )? -xr ::= 'x' | 'X' | '*' | nr -nr ::= '0' | ['1'-'9'] ( ['0'-'9'] ) * -tilde ::= '~' partial -caret ::= '^' partial -qualifier ::= ( '-' pre )? ( '+' build )? -pre ::= parts -build ::= parts -parts ::= part ( '.' part ) * -part ::= nr | [-0-9A-Za-z]+ -``` - -## Functions - -All methods and classes take a final `options` object argument. All -options in this object are `false` by default. The options supported -are: - -- `loose` Be more forgiving about not-quite-valid semver strings. - (Any resulting output will always be 100% strict compliant, of - course.) For backwards compatibility reasons, if the `options` - argument is a boolean value instead of an object, it is interpreted - to be the `loose` param. -- `includePrerelease` Set to suppress the [default - behavior](https://github.com/npm/node-semver#prerelease-tags) of - excluding prerelease tagged versions from ranges unless they are - explicitly opted into. - -Strict-mode Comparators and Ranges will be strict about the SemVer -strings that they parse. - -* `valid(v)`: Return the parsed version, or null if it's not valid. -* `inc(v, release)`: Return the version incremented by the release - type (`major`, `premajor`, `minor`, `preminor`, `patch`, - `prepatch`, or `prerelease`), or null if it's not valid - * `premajor` in one call will bump the version up to the next major - version and down to a prerelease of that major version. - `preminor`, and `prepatch` work the same way. - * If called from a non-prerelease version, the `prerelease` will work the - same as `prepatch`. It increments the patch version, then makes a - prerelease. If the input version is already a prerelease it simply - increments it. -* `prerelease(v)`: Returns an array of prerelease components, or null - if none exist. Example: `prerelease('1.2.3-alpha.1') -> ['alpha', 1]` -* `major(v)`: Return the major version number. -* `minor(v)`: Return the minor version number. -* `patch(v)`: Return the patch version number. -* `intersects(r1, r2, loose)`: Return true if the two supplied ranges - or comparators intersect. -* `parse(v)`: Attempt to parse a string as a semantic version, returning either - a `SemVer` object or `null`. - -### Comparison - -* `gt(v1, v2)`: `v1 > v2` -* `gte(v1, v2)`: `v1 >= v2` -* `lt(v1, v2)`: `v1 < v2` -* `lte(v1, v2)`: `v1 <= v2` -* `eq(v1, v2)`: `v1 == v2` This is true if they're logically equivalent, - even if they're not the exact same string. You already know how to - compare strings. -* `neq(v1, v2)`: `v1 != v2` The opposite of `eq`. -* `cmp(v1, comparator, v2)`: Pass in a comparison string, and it'll call - the corresponding function above. `"==="` and `"!=="` do simple - string comparison, but are included for completeness. Throws if an - invalid comparison string is provided. -* `compare(v1, v2)`: Return `0` if `v1 == v2`, or `1` if `v1` is greater, or `-1` if - `v2` is greater. Sorts in ascending order if passed to `Array.sort()`. -* `rcompare(v1, v2)`: The reverse of compare. Sorts an array of versions - in descending order when passed to `Array.sort()`. -* `diff(v1, v2)`: Returns difference between two versions by the release type - (`major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, or `prerelease`), - or null if the versions are the same. - -### Comparators - -* `intersects(comparator)`: Return true if the comparators intersect - -### Ranges - -* `validRange(range)`: Return the valid range or null if it's not valid -* `satisfies(version, range)`: Return true if the version satisfies the - range. -* `maxSatisfying(versions, range)`: Return the highest version in the list - that satisfies the range, or `null` if none of them do. -* `minSatisfying(versions, range)`: Return the lowest version in the list - that satisfies the range, or `null` if none of them do. -* `minVersion(range)`: Return the lowest version that can possibly match - the given range. -* `gtr(version, range)`: Return `true` if version is greater than all the - versions possible in the range. -* `ltr(version, range)`: Return `true` if version is less than all the - versions possible in the range. -* `outside(version, range, hilo)`: Return true if the version is outside - the bounds of the range in either the high or low direction. The - `hilo` argument must be either the string `'>'` or `'<'`. (This is - the function called by `gtr` and `ltr`.) -* `intersects(range)`: Return true if any of the ranges comparators intersect - -Note that, since ranges may be non-contiguous, a version might not be -greater than a range, less than a range, *or* satisfy a range! For -example, the range `1.2 <1.2.9 || >2.0.0` would have a hole from `1.2.9` -until `2.0.0`, so the version `1.2.10` would not be greater than the -range (because `2.0.1` satisfies, which is higher), nor less than the -range (since `1.2.8` satisfies, which is lower), and it also does not -satisfy the range. - -If you want to know if a version satisfies or does not satisfy a -range, use the `satisfies(version, range)` function. - -### Coercion - -* `coerce(version)`: Coerces a string to semver if possible - -This aims to provide a very forgiving translation of a non-semver -string to semver. It looks for the first digit in a string, and -consumes all remaining characters which satisfy at least a partial semver -(e.g., `1`, `1.2`, `1.2.3`) up to the max permitted length (256 characters). -Longer versions are simply truncated (`4.6.3.9.2-alpha2` becomes `4.6.3`). -All surrounding text is simply ignored (`v3.4 replaces v3.3.1` becomes `3.4.0`). -Only text which lacks digits will fail coercion (`version one` is not valid). -The maximum length for any semver component considered for coercion is 16 characters; -longer components will be ignored (`10000000000000000.4.7.4` becomes `4.7.4`). -The maximum value for any semver component is `Integer.MAX_SAFE_INTEGER || (2**53 - 1)`; -higher value components are invalid (`9999999999999999.4.7.4` is likely invalid). diff --git a/node_modules/cross-spawn/node_modules/semver/bin/semver b/node_modules/cross-spawn/node_modules/semver/bin/semver deleted file mode 100755 index 801e77f..0000000 --- a/node_modules/cross-spawn/node_modules/semver/bin/semver +++ /dev/null @@ -1,160 +0,0 @@ -#!/usr/bin/env node -// Standalone semver comparison program. -// Exits successfully and prints matching version(s) if -// any supplied version is valid and passes all tests. - -var argv = process.argv.slice(2) - -var versions = [] - -var range = [] - -var inc = null - -var version = require('../package.json').version - -var loose = false - -var includePrerelease = false - -var coerce = false - -var identifier - -var semver = require('../semver') - -var reverse = false - -var options = {} - -main() - -function main () { - if (!argv.length) return help() - while (argv.length) { - var a = argv.shift() - var indexOfEqualSign = a.indexOf('=') - if (indexOfEqualSign !== -1) { - a = a.slice(0, indexOfEqualSign) - argv.unshift(a.slice(indexOfEqualSign + 1)) - } - switch (a) { - case '-rv': case '-rev': case '--rev': case '--reverse': - reverse = true - break - case '-l': case '--loose': - loose = true - break - case '-p': case '--include-prerelease': - includePrerelease = true - break - case '-v': case '--version': - versions.push(argv.shift()) - break - case '-i': case '--inc': case '--increment': - switch (argv[0]) { - case 'major': case 'minor': case 'patch': case 'prerelease': - case 'premajor': case 'preminor': case 'prepatch': - inc = argv.shift() - break - default: - inc = 'patch' - break - } - break - case '--preid': - identifier = argv.shift() - break - case '-r': case '--range': - range.push(argv.shift()) - break - case '-c': case '--coerce': - coerce = true - break - case '-h': case '--help': case '-?': - return help() - default: - versions.push(a) - break - } - } - - var options = { loose: loose, includePrerelease: includePrerelease } - - versions = versions.map(function (v) { - return coerce ? (semver.coerce(v) || { version: v }).version : v - }).filter(function (v) { - return semver.valid(v) - }) - if (!versions.length) return fail() - if (inc && (versions.length !== 1 || range.length)) { return failInc() } - - for (var i = 0, l = range.length; i < l; i++) { - versions = versions.filter(function (v) { - return semver.satisfies(v, range[i], options) - }) - if (!versions.length) return fail() - } - return success(versions) -} - -function failInc () { - console.error('--inc can only be used on a single version with no range') - fail() -} - -function fail () { process.exit(1) } - -function success () { - var compare = reverse ? 'rcompare' : 'compare' - versions.sort(function (a, b) { - return semver[compare](a, b, options) - }).map(function (v) { - return semver.clean(v, options) - }).map(function (v) { - return inc ? semver.inc(v, inc, options, identifier) : v - }).forEach(function (v, i, _) { console.log(v) }) -} - -function help () { - console.log(['SemVer ' + version, - '', - 'A JavaScript implementation of the https://semver.org/ specification', - 'Copyright Isaac Z. Schlueter', - '', - 'Usage: semver [options] [ [...]]', - 'Prints valid versions sorted by SemVer precedence', - '', - 'Options:', - '-r --range ', - ' Print versions that match the specified range.', - '', - '-i --increment []', - ' Increment a version by the specified level. Level can', - ' be one of: major, minor, patch, premajor, preminor,', - " prepatch, or prerelease. Default level is 'patch'.", - ' Only one version may be specified.', - '', - '--preid ', - ' Identifier to be used to prefix premajor, preminor,', - ' prepatch or prerelease version increments.', - '', - '-l --loose', - ' Interpret versions and ranges loosely', - '', - '-p --include-prerelease', - ' Always include prerelease versions in range matching', - '', - '-c --coerce', - ' Coerce a string into SemVer if possible', - ' (does not imply --loose)', - '', - 'Program exits successfully if any valid version satisfies', - 'all supplied ranges, and prints all satisfying versions.', - '', - 'If no satisfying versions are found, then exits failure.', - '', - 'Versions are printed in ascending order, so supplying', - 'multiple versions to the utility will just sort them.' - ].join('\n')) -} diff --git a/node_modules/cross-spawn/node_modules/semver/package.json b/node_modules/cross-spawn/node_modules/semver/package.json deleted file mode 100644 index 04be96c..0000000 --- a/node_modules/cross-spawn/node_modules/semver/package.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "_args": [ - [ - "semver@5.7.0", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "semver@5.7.0", - "_id": "semver@5.7.0", - "_inBundle": false, - "_integrity": "sha512-Ya52jSX2u7QKghxeoFGpLwCtGlt7j0oY9DYb5apt9nPlJ42ID+ulTXESnt/qAQcoSERyZ5sl3LDIOw0nAn/5DA==", - "_location": "/cross-spawn/semver", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "semver@5.7.0", - "name": "semver", - "escapedName": "semver", - "rawSpec": "5.7.0", - "saveSpec": null, - "fetchSpec": "5.7.0" - }, - "_requiredBy": [ - "/cross-spawn" - ], - "_resolved": "https://registry.npmjs.org/semver/-/semver-5.7.0.tgz", - "_spec": "5.7.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "bin": { - "semver": "./bin/semver" - }, - "bugs": { - "url": "https://github.com/npm/node-semver/issues" - }, - "description": "The semantic version parser used by npm.", - "devDependencies": { - "tap": "^13.0.0-rc.18" - }, - "files": [ - "bin", - "range.bnf", - "semver.js" - ], - "homepage": "https://github.com/npm/node-semver#readme", - "license": "ISC", - "main": "semver.js", - "name": "semver", - "repository": { - "type": "git", - "url": "git+https://github.com/npm/node-semver.git" - }, - "scripts": { - "postpublish": "git push origin --all; git push origin --tags", - "postversion": "npm publish", - "preversion": "npm test", - "test": "tap" - }, - "tap": { - "check-coverage": true - }, - "version": "5.7.0" -} diff --git a/node_modules/cross-spawn/node_modules/semver/range.bnf b/node_modules/cross-spawn/node_modules/semver/range.bnf deleted file mode 100644 index d4c6ae0..0000000 --- a/node_modules/cross-spawn/node_modules/semver/range.bnf +++ /dev/null @@ -1,16 +0,0 @@ -range-set ::= range ( logical-or range ) * -logical-or ::= ( ' ' ) * '||' ( ' ' ) * -range ::= hyphen | simple ( ' ' simple ) * | '' -hyphen ::= partial ' - ' partial -simple ::= primitive | partial | tilde | caret -primitive ::= ( '<' | '>' | '>=' | '<=' | '=' ) partial -partial ::= xr ( '.' xr ( '.' xr qualifier ? )? )? -xr ::= 'x' | 'X' | '*' | nr -nr ::= '0' | [1-9] ( [0-9] ) * -tilde ::= '~' partial -caret ::= '^' partial -qualifier ::= ( '-' pre )? ( '+' build )? -pre ::= parts -build ::= parts -parts ::= part ( '.' part ) * -part ::= nr | [-0-9A-Za-z]+ diff --git a/node_modules/cross-spawn/node_modules/semver/semver.js b/node_modules/cross-spawn/node_modules/semver/semver.js deleted file mode 100644 index d315d5d..0000000 --- a/node_modules/cross-spawn/node_modules/semver/semver.js +++ /dev/null @@ -1,1483 +0,0 @@ -exports = module.exports = SemVer - -var debug -/* istanbul ignore next */ -if (typeof process === 'object' && - process.env && - process.env.NODE_DEBUG && - /\bsemver\b/i.test(process.env.NODE_DEBUG)) { - debug = function () { - var args = Array.prototype.slice.call(arguments, 0) - args.unshift('SEMVER') - console.log.apply(console, args) - } -} else { - debug = function () {} -} - -// Note: this is the semver.org version of the spec that it implements -// Not necessarily the package version of this code. -exports.SEMVER_SPEC_VERSION = '2.0.0' - -var MAX_LENGTH = 256 -var MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER || - /* istanbul ignore next */ 9007199254740991 - -// Max safe segment length for coercion. -var MAX_SAFE_COMPONENT_LENGTH = 16 - -// The actual regexps go on exports.re -var re = exports.re = [] -var src = exports.src = [] -var R = 0 - -// The following Regular Expressions can be used for tokenizing, -// validating, and parsing SemVer version strings. - -// ## Numeric Identifier -// A single `0`, or a non-zero digit followed by zero or more digits. - -var NUMERICIDENTIFIER = R++ -src[NUMERICIDENTIFIER] = '0|[1-9]\\d*' -var NUMERICIDENTIFIERLOOSE = R++ -src[NUMERICIDENTIFIERLOOSE] = '[0-9]+' - -// ## Non-numeric Identifier -// Zero or more digits, followed by a letter or hyphen, and then zero or -// more letters, digits, or hyphens. - -var NONNUMERICIDENTIFIER = R++ -src[NONNUMERICIDENTIFIER] = '\\d*[a-zA-Z-][a-zA-Z0-9-]*' - -// ## Main Version -// Three dot-separated numeric identifiers. - -var MAINVERSION = R++ -src[MAINVERSION] = '(' + src[NUMERICIDENTIFIER] + ')\\.' + - '(' + src[NUMERICIDENTIFIER] + ')\\.' + - '(' + src[NUMERICIDENTIFIER] + ')' - -var MAINVERSIONLOOSE = R++ -src[MAINVERSIONLOOSE] = '(' + src[NUMERICIDENTIFIERLOOSE] + ')\\.' + - '(' + src[NUMERICIDENTIFIERLOOSE] + ')\\.' + - '(' + src[NUMERICIDENTIFIERLOOSE] + ')' - -// ## Pre-release Version Identifier -// A numeric identifier, or a non-numeric identifier. - -var PRERELEASEIDENTIFIER = R++ -src[PRERELEASEIDENTIFIER] = '(?:' + src[NUMERICIDENTIFIER] + - '|' + src[NONNUMERICIDENTIFIER] + ')' - -var PRERELEASEIDENTIFIERLOOSE = R++ -src[PRERELEASEIDENTIFIERLOOSE] = '(?:' + src[NUMERICIDENTIFIERLOOSE] + - '|' + src[NONNUMERICIDENTIFIER] + ')' - -// ## Pre-release Version -// Hyphen, followed by one or more dot-separated pre-release version -// identifiers. - -var PRERELEASE = R++ -src[PRERELEASE] = '(?:-(' + src[PRERELEASEIDENTIFIER] + - '(?:\\.' + src[PRERELEASEIDENTIFIER] + ')*))' - -var PRERELEASELOOSE = R++ -src[PRERELEASELOOSE] = '(?:-?(' + src[PRERELEASEIDENTIFIERLOOSE] + - '(?:\\.' + src[PRERELEASEIDENTIFIERLOOSE] + ')*))' - -// ## Build Metadata Identifier -// Any combination of digits, letters, or hyphens. - -var BUILDIDENTIFIER = R++ -src[BUILDIDENTIFIER] = '[0-9A-Za-z-]+' - -// ## Build Metadata -// Plus sign, followed by one or more period-separated build metadata -// identifiers. - -var BUILD = R++ -src[BUILD] = '(?:\\+(' + src[BUILDIDENTIFIER] + - '(?:\\.' + src[BUILDIDENTIFIER] + ')*))' - -// ## Full Version String -// A main version, followed optionally by a pre-release version and -// build metadata. - -// Note that the only major, minor, patch, and pre-release sections of -// the version string are capturing groups. The build metadata is not a -// capturing group, because it should not ever be used in version -// comparison. - -var FULL = R++ -var FULLPLAIN = 'v?' + src[MAINVERSION] + - src[PRERELEASE] + '?' + - src[BUILD] + '?' - -src[FULL] = '^' + FULLPLAIN + '$' - -// like full, but allows v1.2.3 and =1.2.3, which people do sometimes. -// also, 1.0.0alpha1 (prerelease without the hyphen) which is pretty -// common in the npm registry. -var LOOSEPLAIN = '[v=\\s]*' + src[MAINVERSIONLOOSE] + - src[PRERELEASELOOSE] + '?' + - src[BUILD] + '?' - -var LOOSE = R++ -src[LOOSE] = '^' + LOOSEPLAIN + '$' - -var GTLT = R++ -src[GTLT] = '((?:<|>)?=?)' - -// Something like "2.*" or "1.2.x". -// Note that "x.x" is a valid xRange identifer, meaning "any version" -// Only the first item is strictly required. -var XRANGEIDENTIFIERLOOSE = R++ -src[XRANGEIDENTIFIERLOOSE] = src[NUMERICIDENTIFIERLOOSE] + '|x|X|\\*' -var XRANGEIDENTIFIER = R++ -src[XRANGEIDENTIFIER] = src[NUMERICIDENTIFIER] + '|x|X|\\*' - -var XRANGEPLAIN = R++ -src[XRANGEPLAIN] = '[v=\\s]*(' + src[XRANGEIDENTIFIER] + ')' + - '(?:\\.(' + src[XRANGEIDENTIFIER] + ')' + - '(?:\\.(' + src[XRANGEIDENTIFIER] + ')' + - '(?:' + src[PRERELEASE] + ')?' + - src[BUILD] + '?' + - ')?)?' - -var XRANGEPLAINLOOSE = R++ -src[XRANGEPLAINLOOSE] = '[v=\\s]*(' + src[XRANGEIDENTIFIERLOOSE] + ')' + - '(?:\\.(' + src[XRANGEIDENTIFIERLOOSE] + ')' + - '(?:\\.(' + src[XRANGEIDENTIFIERLOOSE] + ')' + - '(?:' + src[PRERELEASELOOSE] + ')?' + - src[BUILD] + '?' + - ')?)?' - -var XRANGE = R++ -src[XRANGE] = '^' + src[GTLT] + '\\s*' + src[XRANGEPLAIN] + '$' -var XRANGELOOSE = R++ -src[XRANGELOOSE] = '^' + src[GTLT] + '\\s*' + src[XRANGEPLAINLOOSE] + '$' - -// Coercion. -// Extract anything that could conceivably be a part of a valid semver -var COERCE = R++ -src[COERCE] = '(?:^|[^\\d])' + - '(\\d{1,' + MAX_SAFE_COMPONENT_LENGTH + '})' + - '(?:\\.(\\d{1,' + MAX_SAFE_COMPONENT_LENGTH + '}))?' + - '(?:\\.(\\d{1,' + MAX_SAFE_COMPONENT_LENGTH + '}))?' + - '(?:$|[^\\d])' - -// Tilde ranges. -// Meaning is "reasonably at or greater than" -var LONETILDE = R++ -src[LONETILDE] = '(?:~>?)' - -var TILDETRIM = R++ -src[TILDETRIM] = '(\\s*)' + src[LONETILDE] + '\\s+' -re[TILDETRIM] = new RegExp(src[TILDETRIM], 'g') -var tildeTrimReplace = '$1~' - -var TILDE = R++ -src[TILDE] = '^' + src[LONETILDE] + src[XRANGEPLAIN] + '$' -var TILDELOOSE = R++ -src[TILDELOOSE] = '^' + src[LONETILDE] + src[XRANGEPLAINLOOSE] + '$' - -// Caret ranges. -// Meaning is "at least and backwards compatible with" -var LONECARET = R++ -src[LONECARET] = '(?:\\^)' - -var CARETTRIM = R++ -src[CARETTRIM] = '(\\s*)' + src[LONECARET] + '\\s+' -re[CARETTRIM] = new RegExp(src[CARETTRIM], 'g') -var caretTrimReplace = '$1^' - -var CARET = R++ -src[CARET] = '^' + src[LONECARET] + src[XRANGEPLAIN] + '$' -var CARETLOOSE = R++ -src[CARETLOOSE] = '^' + src[LONECARET] + src[XRANGEPLAINLOOSE] + '$' - -// A simple gt/lt/eq thing, or just "" to indicate "any version" -var COMPARATORLOOSE = R++ -src[COMPARATORLOOSE] = '^' + src[GTLT] + '\\s*(' + LOOSEPLAIN + ')$|^$' -var COMPARATOR = R++ -src[COMPARATOR] = '^' + src[GTLT] + '\\s*(' + FULLPLAIN + ')$|^$' - -// An expression to strip any whitespace between the gtlt and the thing -// it modifies, so that `> 1.2.3` ==> `>1.2.3` -var COMPARATORTRIM = R++ -src[COMPARATORTRIM] = '(\\s*)' + src[GTLT] + - '\\s*(' + LOOSEPLAIN + '|' + src[XRANGEPLAIN] + ')' - -// this one has to use the /g flag -re[COMPARATORTRIM] = new RegExp(src[COMPARATORTRIM], 'g') -var comparatorTrimReplace = '$1$2$3' - -// Something like `1.2.3 - 1.2.4` -// Note that these all use the loose form, because they'll be -// checked against either the strict or loose comparator form -// later. -var HYPHENRANGE = R++ -src[HYPHENRANGE] = '^\\s*(' + src[XRANGEPLAIN] + ')' + - '\\s+-\\s+' + - '(' + src[XRANGEPLAIN] + ')' + - '\\s*$' - -var HYPHENRANGELOOSE = R++ -src[HYPHENRANGELOOSE] = '^\\s*(' + src[XRANGEPLAINLOOSE] + ')' + - '\\s+-\\s+' + - '(' + src[XRANGEPLAINLOOSE] + ')' + - '\\s*$' - -// Star ranges basically just allow anything at all. -var STAR = R++ -src[STAR] = '(<|>)?=?\\s*\\*' - -// Compile to actual regexp objects. -// All are flag-free, unless they were created above with a flag. -for (var i = 0; i < R; i++) { - debug(i, src[i]) - if (!re[i]) { - re[i] = new RegExp(src[i]) - } -} - -exports.parse = parse -function parse (version, options) { - if (!options || typeof options !== 'object') { - options = { - loose: !!options, - includePrerelease: false - } - } - - if (version instanceof SemVer) { - return version - } - - if (typeof version !== 'string') { - return null - } - - if (version.length > MAX_LENGTH) { - return null - } - - var r = options.loose ? re[LOOSE] : re[FULL] - if (!r.test(version)) { - return null - } - - try { - return new SemVer(version, options) - } catch (er) { - return null - } -} - -exports.valid = valid -function valid (version, options) { - var v = parse(version, options) - return v ? v.version : null -} - -exports.clean = clean -function clean (version, options) { - var s = parse(version.trim().replace(/^[=v]+/, ''), options) - return s ? s.version : null -} - -exports.SemVer = SemVer - -function SemVer (version, options) { - if (!options || typeof options !== 'object') { - options = { - loose: !!options, - includePrerelease: false - } - } - if (version instanceof SemVer) { - if (version.loose === options.loose) { - return version - } else { - version = version.version - } - } else if (typeof version !== 'string') { - throw new TypeError('Invalid Version: ' + version) - } - - if (version.length > MAX_LENGTH) { - throw new TypeError('version is longer than ' + MAX_LENGTH + ' characters') - } - - if (!(this instanceof SemVer)) { - return new SemVer(version, options) - } - - debug('SemVer', version, options) - this.options = options - this.loose = !!options.loose - - var m = version.trim().match(options.loose ? re[LOOSE] : re[FULL]) - - if (!m) { - throw new TypeError('Invalid Version: ' + version) - } - - this.raw = version - - // these are actually numbers - this.major = +m[1] - this.minor = +m[2] - this.patch = +m[3] - - if (this.major > MAX_SAFE_INTEGER || this.major < 0) { - throw new TypeError('Invalid major version') - } - - if (this.minor > MAX_SAFE_INTEGER || this.minor < 0) { - throw new TypeError('Invalid minor version') - } - - if (this.patch > MAX_SAFE_INTEGER || this.patch < 0) { - throw new TypeError('Invalid patch version') - } - - // numberify any prerelease numeric ids - if (!m[4]) { - this.prerelease = [] - } else { - this.prerelease = m[4].split('.').map(function (id) { - if (/^[0-9]+$/.test(id)) { - var num = +id - if (num >= 0 && num < MAX_SAFE_INTEGER) { - return num - } - } - return id - }) - } - - this.build = m[5] ? m[5].split('.') : [] - this.format() -} - -SemVer.prototype.format = function () { - this.version = this.major + '.' + this.minor + '.' + this.patch - if (this.prerelease.length) { - this.version += '-' + this.prerelease.join('.') - } - return this.version -} - -SemVer.prototype.toString = function () { - return this.version -} - -SemVer.prototype.compare = function (other) { - debug('SemVer.compare', this.version, this.options, other) - if (!(other instanceof SemVer)) { - other = new SemVer(other, this.options) - } - - return this.compareMain(other) || this.comparePre(other) -} - -SemVer.prototype.compareMain = function (other) { - if (!(other instanceof SemVer)) { - other = new SemVer(other, this.options) - } - - return compareIdentifiers(this.major, other.major) || - compareIdentifiers(this.minor, other.minor) || - compareIdentifiers(this.patch, other.patch) -} - -SemVer.prototype.comparePre = function (other) { - if (!(other instanceof SemVer)) { - other = new SemVer(other, this.options) - } - - // NOT having a prerelease is > having one - if (this.prerelease.length && !other.prerelease.length) { - return -1 - } else if (!this.prerelease.length && other.prerelease.length) { - return 1 - } else if (!this.prerelease.length && !other.prerelease.length) { - return 0 - } - - var i = 0 - do { - var a = this.prerelease[i] - var b = other.prerelease[i] - debug('prerelease compare', i, a, b) - if (a === undefined && b === undefined) { - return 0 - } else if (b === undefined) { - return 1 - } else if (a === undefined) { - return -1 - } else if (a === b) { - continue - } else { - return compareIdentifiers(a, b) - } - } while (++i) -} - -// preminor will bump the version up to the next minor release, and immediately -// down to pre-release. premajor and prepatch work the same way. -SemVer.prototype.inc = function (release, identifier) { - switch (release) { - case 'premajor': - this.prerelease.length = 0 - this.patch = 0 - this.minor = 0 - this.major++ - this.inc('pre', identifier) - break - case 'preminor': - this.prerelease.length = 0 - this.patch = 0 - this.minor++ - this.inc('pre', identifier) - break - case 'prepatch': - // If this is already a prerelease, it will bump to the next version - // drop any prereleases that might already exist, since they are not - // relevant at this point. - this.prerelease.length = 0 - this.inc('patch', identifier) - this.inc('pre', identifier) - break - // If the input is a non-prerelease version, this acts the same as - // prepatch. - case 'prerelease': - if (this.prerelease.length === 0) { - this.inc('patch', identifier) - } - this.inc('pre', identifier) - break - - case 'major': - // If this is a pre-major version, bump up to the same major version. - // Otherwise increment major. - // 1.0.0-5 bumps to 1.0.0 - // 1.1.0 bumps to 2.0.0 - if (this.minor !== 0 || - this.patch !== 0 || - this.prerelease.length === 0) { - this.major++ - } - this.minor = 0 - this.patch = 0 - this.prerelease = [] - break - case 'minor': - // If this is a pre-minor version, bump up to the same minor version. - // Otherwise increment minor. - // 1.2.0-5 bumps to 1.2.0 - // 1.2.1 bumps to 1.3.0 - if (this.patch !== 0 || this.prerelease.length === 0) { - this.minor++ - } - this.patch = 0 - this.prerelease = [] - break - case 'patch': - // If this is not a pre-release version, it will increment the patch. - // If it is a pre-release it will bump up to the same patch version. - // 1.2.0-5 patches to 1.2.0 - // 1.2.0 patches to 1.2.1 - if (this.prerelease.length === 0) { - this.patch++ - } - this.prerelease = [] - break - // This probably shouldn't be used publicly. - // 1.0.0 "pre" would become 1.0.0-0 which is the wrong direction. - case 'pre': - if (this.prerelease.length === 0) { - this.prerelease = [0] - } else { - var i = this.prerelease.length - while (--i >= 0) { - if (typeof this.prerelease[i] === 'number') { - this.prerelease[i]++ - i = -2 - } - } - if (i === -1) { - // didn't increment anything - this.prerelease.push(0) - } - } - if (identifier) { - // 1.2.0-beta.1 bumps to 1.2.0-beta.2, - // 1.2.0-beta.fooblz or 1.2.0-beta bumps to 1.2.0-beta.0 - if (this.prerelease[0] === identifier) { - if (isNaN(this.prerelease[1])) { - this.prerelease = [identifier, 0] - } - } else { - this.prerelease = [identifier, 0] - } - } - break - - default: - throw new Error('invalid increment argument: ' + release) - } - this.format() - this.raw = this.version - return this -} - -exports.inc = inc -function inc (version, release, loose, identifier) { - if (typeof (loose) === 'string') { - identifier = loose - loose = undefined - } - - try { - return new SemVer(version, loose).inc(release, identifier).version - } catch (er) { - return null - } -} - -exports.diff = diff -function diff (version1, version2) { - if (eq(version1, version2)) { - return null - } else { - var v1 = parse(version1) - var v2 = parse(version2) - var prefix = '' - if (v1.prerelease.length || v2.prerelease.length) { - prefix = 'pre' - var defaultResult = 'prerelease' - } - for (var key in v1) { - if (key === 'major' || key === 'minor' || key === 'patch') { - if (v1[key] !== v2[key]) { - return prefix + key - } - } - } - return defaultResult // may be undefined - } -} - -exports.compareIdentifiers = compareIdentifiers - -var numeric = /^[0-9]+$/ -function compareIdentifiers (a, b) { - var anum = numeric.test(a) - var bnum = numeric.test(b) - - if (anum && bnum) { - a = +a - b = +b - } - - return a === b ? 0 - : (anum && !bnum) ? -1 - : (bnum && !anum) ? 1 - : a < b ? -1 - : 1 -} - -exports.rcompareIdentifiers = rcompareIdentifiers -function rcompareIdentifiers (a, b) { - return compareIdentifiers(b, a) -} - -exports.major = major -function major (a, loose) { - return new SemVer(a, loose).major -} - -exports.minor = minor -function minor (a, loose) { - return new SemVer(a, loose).minor -} - -exports.patch = patch -function patch (a, loose) { - return new SemVer(a, loose).patch -} - -exports.compare = compare -function compare (a, b, loose) { - return new SemVer(a, loose).compare(new SemVer(b, loose)) -} - -exports.compareLoose = compareLoose -function compareLoose (a, b) { - return compare(a, b, true) -} - -exports.rcompare = rcompare -function rcompare (a, b, loose) { - return compare(b, a, loose) -} - -exports.sort = sort -function sort (list, loose) { - return list.sort(function (a, b) { - return exports.compare(a, b, loose) - }) -} - -exports.rsort = rsort -function rsort (list, loose) { - return list.sort(function (a, b) { - return exports.rcompare(a, b, loose) - }) -} - -exports.gt = gt -function gt (a, b, loose) { - return compare(a, b, loose) > 0 -} - -exports.lt = lt -function lt (a, b, loose) { - return compare(a, b, loose) < 0 -} - -exports.eq = eq -function eq (a, b, loose) { - return compare(a, b, loose) === 0 -} - -exports.neq = neq -function neq (a, b, loose) { - return compare(a, b, loose) !== 0 -} - -exports.gte = gte -function gte (a, b, loose) { - return compare(a, b, loose) >= 0 -} - -exports.lte = lte -function lte (a, b, loose) { - return compare(a, b, loose) <= 0 -} - -exports.cmp = cmp -function cmp (a, op, b, loose) { - switch (op) { - case '===': - if (typeof a === 'object') - a = a.version - if (typeof b === 'object') - b = b.version - return a === b - - case '!==': - if (typeof a === 'object') - a = a.version - if (typeof b === 'object') - b = b.version - return a !== b - - case '': - case '=': - case '==': - return eq(a, b, loose) - - case '!=': - return neq(a, b, loose) - - case '>': - return gt(a, b, loose) - - case '>=': - return gte(a, b, loose) - - case '<': - return lt(a, b, loose) - - case '<=': - return lte(a, b, loose) - - default: - throw new TypeError('Invalid operator: ' + op) - } -} - -exports.Comparator = Comparator -function Comparator (comp, options) { - if (!options || typeof options !== 'object') { - options = { - loose: !!options, - includePrerelease: false - } - } - - if (comp instanceof Comparator) { - if (comp.loose === !!options.loose) { - return comp - } else { - comp = comp.value - } - } - - if (!(this instanceof Comparator)) { - return new Comparator(comp, options) - } - - debug('comparator', comp, options) - this.options = options - this.loose = !!options.loose - this.parse(comp) - - if (this.semver === ANY) { - this.value = '' - } else { - this.value = this.operator + this.semver.version - } - - debug('comp', this) -} - -var ANY = {} -Comparator.prototype.parse = function (comp) { - var r = this.options.loose ? re[COMPARATORLOOSE] : re[COMPARATOR] - var m = comp.match(r) - - if (!m) { - throw new TypeError('Invalid comparator: ' + comp) - } - - this.operator = m[1] - if (this.operator === '=') { - this.operator = '' - } - - // if it literally is just '>' or '' then allow anything. - if (!m[2]) { - this.semver = ANY - } else { - this.semver = new SemVer(m[2], this.options.loose) - } -} - -Comparator.prototype.toString = function () { - return this.value -} - -Comparator.prototype.test = function (version) { - debug('Comparator.test', version, this.options.loose) - - if (this.semver === ANY) { - return true - } - - if (typeof version === 'string') { - version = new SemVer(version, this.options) - } - - return cmp(version, this.operator, this.semver, this.options) -} - -Comparator.prototype.intersects = function (comp, options) { - if (!(comp instanceof Comparator)) { - throw new TypeError('a Comparator is required') - } - - if (!options || typeof options !== 'object') { - options = { - loose: !!options, - includePrerelease: false - } - } - - var rangeTmp - - if (this.operator === '') { - rangeTmp = new Range(comp.value, options) - return satisfies(this.value, rangeTmp, options) - } else if (comp.operator === '') { - rangeTmp = new Range(this.value, options) - return satisfies(comp.semver, rangeTmp, options) - } - - var sameDirectionIncreasing = - (this.operator === '>=' || this.operator === '>') && - (comp.operator === '>=' || comp.operator === '>') - var sameDirectionDecreasing = - (this.operator === '<=' || this.operator === '<') && - (comp.operator === '<=' || comp.operator === '<') - var sameSemVer = this.semver.version === comp.semver.version - var differentDirectionsInclusive = - (this.operator === '>=' || this.operator === '<=') && - (comp.operator === '>=' || comp.operator === '<=') - var oppositeDirectionsLessThan = - cmp(this.semver, '<', comp.semver, options) && - ((this.operator === '>=' || this.operator === '>') && - (comp.operator === '<=' || comp.operator === '<')) - var oppositeDirectionsGreaterThan = - cmp(this.semver, '>', comp.semver, options) && - ((this.operator === '<=' || this.operator === '<') && - (comp.operator === '>=' || comp.operator === '>')) - - return sameDirectionIncreasing || sameDirectionDecreasing || - (sameSemVer && differentDirectionsInclusive) || - oppositeDirectionsLessThan || oppositeDirectionsGreaterThan -} - -exports.Range = Range -function Range (range, options) { - if (!options || typeof options !== 'object') { - options = { - loose: !!options, - includePrerelease: false - } - } - - if (range instanceof Range) { - if (range.loose === !!options.loose && - range.includePrerelease === !!options.includePrerelease) { - return range - } else { - return new Range(range.raw, options) - } - } - - if (range instanceof Comparator) { - return new Range(range.value, options) - } - - if (!(this instanceof Range)) { - return new Range(range, options) - } - - this.options = options - this.loose = !!options.loose - this.includePrerelease = !!options.includePrerelease - - // First, split based on boolean or || - this.raw = range - this.set = range.split(/\s*\|\|\s*/).map(function (range) { - return this.parseRange(range.trim()) - }, this).filter(function (c) { - // throw out any that are not relevant for whatever reason - return c.length - }) - - if (!this.set.length) { - throw new TypeError('Invalid SemVer Range: ' + range) - } - - this.format() -} - -Range.prototype.format = function () { - this.range = this.set.map(function (comps) { - return comps.join(' ').trim() - }).join('||').trim() - return this.range -} - -Range.prototype.toString = function () { - return this.range -} - -Range.prototype.parseRange = function (range) { - var loose = this.options.loose - range = range.trim() - // `1.2.3 - 1.2.4` => `>=1.2.3 <=1.2.4` - var hr = loose ? re[HYPHENRANGELOOSE] : re[HYPHENRANGE] - range = range.replace(hr, hyphenReplace) - debug('hyphen replace', range) - // `> 1.2.3 < 1.2.5` => `>1.2.3 <1.2.5` - range = range.replace(re[COMPARATORTRIM], comparatorTrimReplace) - debug('comparator trim', range, re[COMPARATORTRIM]) - - // `~ 1.2.3` => `~1.2.3` - range = range.replace(re[TILDETRIM], tildeTrimReplace) - - // `^ 1.2.3` => `^1.2.3` - range = range.replace(re[CARETTRIM], caretTrimReplace) - - // normalize spaces - range = range.split(/\s+/).join(' ') - - // At this point, the range is completely trimmed and - // ready to be split into comparators. - - var compRe = loose ? re[COMPARATORLOOSE] : re[COMPARATOR] - var set = range.split(' ').map(function (comp) { - return parseComparator(comp, this.options) - }, this).join(' ').split(/\s+/) - if (this.options.loose) { - // in loose mode, throw out any that are not valid comparators - set = set.filter(function (comp) { - return !!comp.match(compRe) - }) - } - set = set.map(function (comp) { - return new Comparator(comp, this.options) - }, this) - - return set -} - -Range.prototype.intersects = function (range, options) { - if (!(range instanceof Range)) { - throw new TypeError('a Range is required') - } - - return this.set.some(function (thisComparators) { - return thisComparators.every(function (thisComparator) { - return range.set.some(function (rangeComparators) { - return rangeComparators.every(function (rangeComparator) { - return thisComparator.intersects(rangeComparator, options) - }) - }) - }) - }) -} - -// Mostly just for testing and legacy API reasons -exports.toComparators = toComparators -function toComparators (range, options) { - return new Range(range, options).set.map(function (comp) { - return comp.map(function (c) { - return c.value - }).join(' ').trim().split(' ') - }) -} - -// comprised of xranges, tildes, stars, and gtlt's at this point. -// already replaced the hyphen ranges -// turn into a set of JUST comparators. -function parseComparator (comp, options) { - debug('comp', comp, options) - comp = replaceCarets(comp, options) - debug('caret', comp) - comp = replaceTildes(comp, options) - debug('tildes', comp) - comp = replaceXRanges(comp, options) - debug('xrange', comp) - comp = replaceStars(comp, options) - debug('stars', comp) - return comp -} - -function isX (id) { - return !id || id.toLowerCase() === 'x' || id === '*' -} - -// ~, ~> --> * (any, kinda silly) -// ~2, ~2.x, ~2.x.x, ~>2, ~>2.x ~>2.x.x --> >=2.0.0 <3.0.0 -// ~2.0, ~2.0.x, ~>2.0, ~>2.0.x --> >=2.0.0 <2.1.0 -// ~1.2, ~1.2.x, ~>1.2, ~>1.2.x --> >=1.2.0 <1.3.0 -// ~1.2.3, ~>1.2.3 --> >=1.2.3 <1.3.0 -// ~1.2.0, ~>1.2.0 --> >=1.2.0 <1.3.0 -function replaceTildes (comp, options) { - return comp.trim().split(/\s+/).map(function (comp) { - return replaceTilde(comp, options) - }).join(' ') -} - -function replaceTilde (comp, options) { - var r = options.loose ? re[TILDELOOSE] : re[TILDE] - return comp.replace(r, function (_, M, m, p, pr) { - debug('tilde', comp, _, M, m, p, pr) - var ret - - if (isX(M)) { - ret = '' - } else if (isX(m)) { - ret = '>=' + M + '.0.0 <' + (+M + 1) + '.0.0' - } else if (isX(p)) { - // ~1.2 == >=1.2.0 <1.3.0 - ret = '>=' + M + '.' + m + '.0 <' + M + '.' + (+m + 1) + '.0' - } else if (pr) { - debug('replaceTilde pr', pr) - ret = '>=' + M + '.' + m + '.' + p + '-' + pr + - ' <' + M + '.' + (+m + 1) + '.0' - } else { - // ~1.2.3 == >=1.2.3 <1.3.0 - ret = '>=' + M + '.' + m + '.' + p + - ' <' + M + '.' + (+m + 1) + '.0' - } - - debug('tilde return', ret) - return ret - }) -} - -// ^ --> * (any, kinda silly) -// ^2, ^2.x, ^2.x.x --> >=2.0.0 <3.0.0 -// ^2.0, ^2.0.x --> >=2.0.0 <3.0.0 -// ^1.2, ^1.2.x --> >=1.2.0 <2.0.0 -// ^1.2.3 --> >=1.2.3 <2.0.0 -// ^1.2.0 --> >=1.2.0 <2.0.0 -function replaceCarets (comp, options) { - return comp.trim().split(/\s+/).map(function (comp) { - return replaceCaret(comp, options) - }).join(' ') -} - -function replaceCaret (comp, options) { - debug('caret', comp, options) - var r = options.loose ? re[CARETLOOSE] : re[CARET] - return comp.replace(r, function (_, M, m, p, pr) { - debug('caret', comp, _, M, m, p, pr) - var ret - - if (isX(M)) { - ret = '' - } else if (isX(m)) { - ret = '>=' + M + '.0.0 <' + (+M + 1) + '.0.0' - } else if (isX(p)) { - if (M === '0') { - ret = '>=' + M + '.' + m + '.0 <' + M + '.' + (+m + 1) + '.0' - } else { - ret = '>=' + M + '.' + m + '.0 <' + (+M + 1) + '.0.0' - } - } else if (pr) { - debug('replaceCaret pr', pr) - if (M === '0') { - if (m === '0') { - ret = '>=' + M + '.' + m + '.' + p + '-' + pr + - ' <' + M + '.' + m + '.' + (+p + 1) - } else { - ret = '>=' + M + '.' + m + '.' + p + '-' + pr + - ' <' + M + '.' + (+m + 1) + '.0' - } - } else { - ret = '>=' + M + '.' + m + '.' + p + '-' + pr + - ' <' + (+M + 1) + '.0.0' - } - } else { - debug('no pr') - if (M === '0') { - if (m === '0') { - ret = '>=' + M + '.' + m + '.' + p + - ' <' + M + '.' + m + '.' + (+p + 1) - } else { - ret = '>=' + M + '.' + m + '.' + p + - ' <' + M + '.' + (+m + 1) + '.0' - } - } else { - ret = '>=' + M + '.' + m + '.' + p + - ' <' + (+M + 1) + '.0.0' - } - } - - debug('caret return', ret) - return ret - }) -} - -function replaceXRanges (comp, options) { - debug('replaceXRanges', comp, options) - return comp.split(/\s+/).map(function (comp) { - return replaceXRange(comp, options) - }).join(' ') -} - -function replaceXRange (comp, options) { - comp = comp.trim() - var r = options.loose ? re[XRANGELOOSE] : re[XRANGE] - return comp.replace(r, function (ret, gtlt, M, m, p, pr) { - debug('xRange', comp, ret, gtlt, M, m, p, pr) - var xM = isX(M) - var xm = xM || isX(m) - var xp = xm || isX(p) - var anyX = xp - - if (gtlt === '=' && anyX) { - gtlt = '' - } - - if (xM) { - if (gtlt === '>' || gtlt === '<') { - // nothing is allowed - ret = '<0.0.0' - } else { - // nothing is forbidden - ret = '*' - } - } else if (gtlt && anyX) { - // we know patch is an x, because we have any x at all. - // replace X with 0 - if (xm) { - m = 0 - } - p = 0 - - if (gtlt === '>') { - // >1 => >=2.0.0 - // >1.2 => >=1.3.0 - // >1.2.3 => >= 1.2.4 - gtlt = '>=' - if (xm) { - M = +M + 1 - m = 0 - p = 0 - } else { - m = +m + 1 - p = 0 - } - } else if (gtlt === '<=') { - // <=0.7.x is actually <0.8.0, since any 0.7.x should - // pass. Similarly, <=7.x is actually <8.0.0, etc. - gtlt = '<' - if (xm) { - M = +M + 1 - } else { - m = +m + 1 - } - } - - ret = gtlt + M + '.' + m + '.' + p - } else if (xm) { - ret = '>=' + M + '.0.0 <' + (+M + 1) + '.0.0' - } else if (xp) { - ret = '>=' + M + '.' + m + '.0 <' + M + '.' + (+m + 1) + '.0' - } - - debug('xRange return', ret) - - return ret - }) -} - -// Because * is AND-ed with everything else in the comparator, -// and '' means "any version", just remove the *s entirely. -function replaceStars (comp, options) { - debug('replaceStars', comp, options) - // Looseness is ignored here. star is always as loose as it gets! - return comp.trim().replace(re[STAR], '') -} - -// This function is passed to string.replace(re[HYPHENRANGE]) -// M, m, patch, prerelease, build -// 1.2 - 3.4.5 => >=1.2.0 <=3.4.5 -// 1.2.3 - 3.4 => >=1.2.0 <3.5.0 Any 3.4.x will do -// 1.2 - 3.4 => >=1.2.0 <3.5.0 -function hyphenReplace ($0, - from, fM, fm, fp, fpr, fb, - to, tM, tm, tp, tpr, tb) { - if (isX(fM)) { - from = '' - } else if (isX(fm)) { - from = '>=' + fM + '.0.0' - } else if (isX(fp)) { - from = '>=' + fM + '.' + fm + '.0' - } else { - from = '>=' + from - } - - if (isX(tM)) { - to = '' - } else if (isX(tm)) { - to = '<' + (+tM + 1) + '.0.0' - } else if (isX(tp)) { - to = '<' + tM + '.' + (+tm + 1) + '.0' - } else if (tpr) { - to = '<=' + tM + '.' + tm + '.' + tp + '-' + tpr - } else { - to = '<=' + to - } - - return (from + ' ' + to).trim() -} - -// if ANY of the sets match ALL of its comparators, then pass -Range.prototype.test = function (version) { - if (!version) { - return false - } - - if (typeof version === 'string') { - version = new SemVer(version, this.options) - } - - for (var i = 0; i < this.set.length; i++) { - if (testSet(this.set[i], version, this.options)) { - return true - } - } - return false -} - -function testSet (set, version, options) { - for (var i = 0; i < set.length; i++) { - if (!set[i].test(version)) { - return false - } - } - - if (version.prerelease.length && !options.includePrerelease) { - // Find the set of versions that are allowed to have prereleases - // For example, ^1.2.3-pr.1 desugars to >=1.2.3-pr.1 <2.0.0 - // That should allow `1.2.3-pr.2` to pass. - // However, `1.2.4-alpha.notready` should NOT be allowed, - // even though it's within the range set by the comparators. - for (i = 0; i < set.length; i++) { - debug(set[i].semver) - if (set[i].semver === ANY) { - continue - } - - if (set[i].semver.prerelease.length > 0) { - var allowed = set[i].semver - if (allowed.major === version.major && - allowed.minor === version.minor && - allowed.patch === version.patch) { - return true - } - } - } - - // Version has a -pre, but it's not one of the ones we like. - return false - } - - return true -} - -exports.satisfies = satisfies -function satisfies (version, range, options) { - try { - range = new Range(range, options) - } catch (er) { - return false - } - return range.test(version) -} - -exports.maxSatisfying = maxSatisfying -function maxSatisfying (versions, range, options) { - var max = null - var maxSV = null - try { - var rangeObj = new Range(range, options) - } catch (er) { - return null - } - versions.forEach(function (v) { - if (rangeObj.test(v)) { - // satisfies(v, range, options) - if (!max || maxSV.compare(v) === -1) { - // compare(max, v, true) - max = v - maxSV = new SemVer(max, options) - } - } - }) - return max -} - -exports.minSatisfying = minSatisfying -function minSatisfying (versions, range, options) { - var min = null - var minSV = null - try { - var rangeObj = new Range(range, options) - } catch (er) { - return null - } - versions.forEach(function (v) { - if (rangeObj.test(v)) { - // satisfies(v, range, options) - if (!min || minSV.compare(v) === 1) { - // compare(min, v, true) - min = v - minSV = new SemVer(min, options) - } - } - }) - return min -} - -exports.minVersion = minVersion -function minVersion (range, loose) { - range = new Range(range, loose) - - var minver = new SemVer('0.0.0') - if (range.test(minver)) { - return minver - } - - minver = new SemVer('0.0.0-0') - if (range.test(minver)) { - return minver - } - - minver = null - for (var i = 0; i < range.set.length; ++i) { - var comparators = range.set[i] - - comparators.forEach(function (comparator) { - // Clone to avoid manipulating the comparator's semver object. - var compver = new SemVer(comparator.semver.version) - switch (comparator.operator) { - case '>': - if (compver.prerelease.length === 0) { - compver.patch++ - } else { - compver.prerelease.push(0) - } - compver.raw = compver.format() - /* fallthrough */ - case '': - case '>=': - if (!minver || gt(minver, compver)) { - minver = compver - } - break - case '<': - case '<=': - /* Ignore maximum versions */ - break - /* istanbul ignore next */ - default: - throw new Error('Unexpected operation: ' + comparator.operator) - } - }) - } - - if (minver && range.test(minver)) { - return minver - } - - return null -} - -exports.validRange = validRange -function validRange (range, options) { - try { - // Return '*' instead of '' so that truthiness works. - // This will throw if it's invalid anyway - return new Range(range, options).range || '*' - } catch (er) { - return null - } -} - -// Determine if version is less than all the versions possible in the range -exports.ltr = ltr -function ltr (version, range, options) { - return outside(version, range, '<', options) -} - -// Determine if version is greater than all the versions possible in the range. -exports.gtr = gtr -function gtr (version, range, options) { - return outside(version, range, '>', options) -} - -exports.outside = outside -function outside (version, range, hilo, options) { - version = new SemVer(version, options) - range = new Range(range, options) - - var gtfn, ltefn, ltfn, comp, ecomp - switch (hilo) { - case '>': - gtfn = gt - ltefn = lte - ltfn = lt - comp = '>' - ecomp = '>=' - break - case '<': - gtfn = lt - ltefn = gte - ltfn = gt - comp = '<' - ecomp = '<=' - break - default: - throw new TypeError('Must provide a hilo val of "<" or ">"') - } - - // If it satisifes the range it is not outside - if (satisfies(version, range, options)) { - return false - } - - // From now on, variable terms are as if we're in "gtr" mode. - // but note that everything is flipped for the "ltr" function. - - for (var i = 0; i < range.set.length; ++i) { - var comparators = range.set[i] - - var high = null - var low = null - - comparators.forEach(function (comparator) { - if (comparator.semver === ANY) { - comparator = new Comparator('>=0.0.0') - } - high = high || comparator - low = low || comparator - if (gtfn(comparator.semver, high.semver, options)) { - high = comparator - } else if (ltfn(comparator.semver, low.semver, options)) { - low = comparator - } - }) - - // If the edge version comparator has a operator then our version - // isn't outside it - if (high.operator === comp || high.operator === ecomp) { - return false - } - - // If the lowest version comparator has an operator and our version - // is less than it then it isn't higher than the range - if ((!low.operator || low.operator === comp) && - ltefn(version, low.semver)) { - return false - } else if (low.operator === ecomp && ltfn(version, low.semver)) { - return false - } - } - return true -} - -exports.prerelease = prerelease -function prerelease (version, options) { - var parsed = parse(version, options) - return (parsed && parsed.prerelease.length) ? parsed.prerelease : null -} - -exports.intersects = intersects -function intersects (r1, r2, options) { - r1 = new Range(r1, options) - r2 = new Range(r2, options) - return r1.intersects(r2) -} - -exports.coerce = coerce -function coerce (version) { - if (version instanceof SemVer) { - return version - } - - if (typeof version !== 'string') { - return null - } - - var match = version.match(re[COERCE]) - - if (match == null) { - return null - } - - return parse(match[1] + - '.' + (match[2] || '0') + - '.' + (match[3] || '0')) -} diff --git a/node_modules/cross-spawn/package.json b/node_modules/cross-spawn/package.json deleted file mode 100644 index d62f2dd..0000000 --- a/node_modules/cross-spawn/package.json +++ /dev/null @@ -1,111 +0,0 @@ -{ - "_args": [ - [ - "cross-spawn@6.0.5", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "cross-spawn@6.0.5", - "_id": "cross-spawn@6.0.5", - "_inBundle": false, - "_integrity": "sha512-eTVLrBSt7fjbDygz805pMnstIs2VTBNkRm0qxZd+M7A5XDdxVRWO5MxGBXZhjY4cqLYLdtrGqRf8mBPmzwSpWQ==", - "_location": "/cross-spawn", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "cross-spawn@6.0.5", - "name": "cross-spawn", - "escapedName": "cross-spawn", - "rawSpec": "6.0.5", - "saveSpec": null, - "fetchSpec": "6.0.5" - }, - "_requiredBy": [ - "/execa" - ], - "_resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.5.tgz", - "_spec": "6.0.5", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "André Cruz", - "email": "andre@moxy.studio" - }, - "bugs": { - "url": "https://github.com/moxystudio/node-cross-spawn/issues" - }, - "commitlint": { - "extends": [ - "@commitlint/config-conventional" - ] - }, - "dependencies": { - "nice-try": "^1.0.4", - "path-key": "^2.0.1", - "semver": "^5.5.0", - "shebang-command": "^1.2.0", - "which": "^1.2.9" - }, - "description": "Cross platform child_process#spawn and child_process#spawnSync", - "devDependencies": { - "@commitlint/cli": "^6.0.0", - "@commitlint/config-conventional": "^6.0.2", - "babel-core": "^6.26.0", - "babel-jest": "^22.1.0", - "babel-preset-moxy": "^2.2.1", - "eslint": "^4.3.0", - "eslint-config-moxy": "^5.0.0", - "husky": "^0.14.3", - "jest": "^22.0.0", - "lint-staged": "^7.0.0", - "mkdirp": "^0.5.1", - "regenerator-runtime": "^0.11.1", - "rimraf": "^2.6.2", - "standard-version": "^4.2.0" - }, - "engines": { - "node": ">=4.8" - }, - "files": [ - "lib" - ], - "homepage": "https://github.com/moxystudio/node-cross-spawn", - "keywords": [ - "spawn", - "spawnSync", - "windows", - "cross-platform", - "path-ext", - "shebang", - "cmd", - "execute" - ], - "license": "MIT", - "lint-staged": { - "*.js": [ - "eslint --fix", - "git add" - ] - }, - "main": "index.js", - "name": "cross-spawn", - "repository": { - "type": "git", - "url": "git+ssh://git@github.com/moxystudio/node-cross-spawn.git" - }, - "scripts": { - "commitmsg": "commitlint -e $GIT_PARAMS", - "lint": "eslint .", - "precommit": "lint-staged", - "prerelease": "npm t && npm run lint", - "release": "standard-version", - "test": "jest --env node --coverage" - }, - "standard-version": { - "scripts": { - "posttag": "git push --follow-tags origin master && npm publish" - } - }, - "version": "6.0.5" -} diff --git a/node_modules/deprecation/package.json b/node_modules/deprecation/package.json index 67cda34..0ca0592 100644 --- a/node_modules/deprecation/package.json +++ b/node_modules/deprecation/package.json @@ -1,35 +1,38 @@ { - "_from": "deprecation@^2.0.0", + "_args": [ + [ + "deprecation@2.3.1", + "." + ] + ], + "_from": "deprecation@2.3.1", "_id": "deprecation@2.3.1", "_inBundle": false, "_integrity": "sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ==", "_location": "/deprecation", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "deprecation@^2.0.0", + "raw": "deprecation@2.3.1", "name": "deprecation", "escapedName": "deprecation", - "rawSpec": "^2.0.0", + "rawSpec": "2.3.1", "saveSpec": null, - "fetchSpec": "^2.0.0" + "fetchSpec": "2.3.1" }, "_requiredBy": [ + "/@octokit/plugin-rest-endpoint-methods", "/@octokit/request", - "/@octokit/request-error", - "/@octokit/rest" + "/@octokit/request-error" ], "_resolved": "https://registry.npmjs.org/deprecation/-/deprecation-2.3.1.tgz", - "_shasum": "6368cbdb40abf3373b525ac87e4a260c3a700919", - "_spec": "deprecation@^2.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/request", + "_spec": "2.3.1", + "_where": ".", "bugs": { "url": "https://github.com/gr2m/deprecation/issues" }, - "bundleDependencies": false, "dependencies": {}, - "deprecated": false, "description": "Log a deprecation message with stack", "devDependencies": { "@pika/pack": "^0.3.7", diff --git a/node_modules/end-of-stream/README.md b/node_modules/end-of-stream/README.md deleted file mode 100644 index f2560c9..0000000 --- a/node_modules/end-of-stream/README.md +++ /dev/null @@ -1,52 +0,0 @@ -# end-of-stream - -A node module that calls a callback when a readable/writable/duplex stream has completed or failed. - - npm install end-of-stream - -## Usage - -Simply pass a stream and a callback to the `eos`. -Both legacy streams, streams2 and stream3 are supported. - -``` js -var eos = require('end-of-stream'); - -eos(readableStream, function(err) { - // this will be set to the stream instance - if (err) return console.log('stream had an error or closed early'); - console.log('stream has ended', this === readableStream); -}); - -eos(writableStream, function(err) { - if (err) return console.log('stream had an error or closed early'); - console.log('stream has finished', this === writableStream); -}); - -eos(duplexStream, function(err) { - if (err) return console.log('stream had an error or closed early'); - console.log('stream has ended and finished', this === duplexStream); -}); - -eos(duplexStream, {readable:false}, function(err) { - if (err) return console.log('stream had an error or closed early'); - console.log('stream has finished but might still be readable'); -}); - -eos(duplexStream, {writable:false}, function(err) { - if (err) return console.log('stream had an error or closed early'); - console.log('stream has ended but might still be writable'); -}); - -eos(readableStream, {error:false}, function(err) { - // do not treat emit('error', err) as a end-of-stream -}); -``` - -## License - -MIT - -## Related - -`end-of-stream` is part of the [mississippi stream utility collection](https://github.com/maxogden/mississippi) which includes more useful stream modules similar to this one. diff --git a/node_modules/end-of-stream/index.js b/node_modules/end-of-stream/index.js deleted file mode 100644 index be426c2..0000000 --- a/node_modules/end-of-stream/index.js +++ /dev/null @@ -1,87 +0,0 @@ -var once = require('once'); - -var noop = function() {}; - -var isRequest = function(stream) { - return stream.setHeader && typeof stream.abort === 'function'; -}; - -var isChildProcess = function(stream) { - return stream.stdio && Array.isArray(stream.stdio) && stream.stdio.length === 3 -}; - -var eos = function(stream, opts, callback) { - if (typeof opts === 'function') return eos(stream, null, opts); - if (!opts) opts = {}; - - callback = once(callback || noop); - - var ws = stream._writableState; - var rs = stream._readableState; - var readable = opts.readable || (opts.readable !== false && stream.readable); - var writable = opts.writable || (opts.writable !== false && stream.writable); - - var onlegacyfinish = function() { - if (!stream.writable) onfinish(); - }; - - var onfinish = function() { - writable = false; - if (!readable) callback.call(stream); - }; - - var onend = function() { - readable = false; - if (!writable) callback.call(stream); - }; - - var onexit = function(exitCode) { - callback.call(stream, exitCode ? new Error('exited with error code: ' + exitCode) : null); - }; - - var onerror = function(err) { - callback.call(stream, err); - }; - - var onclose = function() { - if (readable && !(rs && rs.ended)) return callback.call(stream, new Error('premature close')); - if (writable && !(ws && ws.ended)) return callback.call(stream, new Error('premature close')); - }; - - var onrequest = function() { - stream.req.on('finish', onfinish); - }; - - if (isRequest(stream)) { - stream.on('complete', onfinish); - stream.on('abort', onclose); - if (stream.req) onrequest(); - else stream.on('request', onrequest); - } else if (writable && !ws) { // legacy streams - stream.on('end', onlegacyfinish); - stream.on('close', onlegacyfinish); - } - - if (isChildProcess(stream)) stream.on('exit', onexit); - - stream.on('end', onend); - stream.on('finish', onfinish); - if (opts.error !== false) stream.on('error', onerror); - stream.on('close', onclose); - - return function() { - stream.removeListener('complete', onfinish); - stream.removeListener('abort', onclose); - stream.removeListener('request', onrequest); - if (stream.req) stream.req.removeListener('finish', onfinish); - stream.removeListener('end', onlegacyfinish); - stream.removeListener('close', onlegacyfinish); - stream.removeListener('finish', onfinish); - stream.removeListener('exit', onexit); - stream.removeListener('end', onend); - stream.removeListener('error', onerror); - stream.removeListener('close', onclose); - }; -}; - -module.exports = eos; diff --git a/node_modules/end-of-stream/package.json b/node_modules/end-of-stream/package.json deleted file mode 100644 index c176b23..0000000 --- a/node_modules/end-of-stream/package.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "_args": [ - [ - "end-of-stream@1.4.1", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "end-of-stream@1.4.1", - "_id": "end-of-stream@1.4.1", - "_inBundle": false, - "_integrity": "sha512-1MkrZNvWTKCaigbn+W15elq2BB/L22nqrSY5DKlo3X6+vclJm8Bb5djXJBmEX6fS3+zCh/F4VBK5Z2KxJt4s2Q==", - "_location": "/end-of-stream", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "end-of-stream@1.4.1", - "name": "end-of-stream", - "escapedName": "end-of-stream", - "rawSpec": "1.4.1", - "saveSpec": null, - "fetchSpec": "1.4.1" - }, - "_requiredBy": [ - "/pump" - ], - "_resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.1.tgz", - "_spec": "1.4.1", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Mathias Buus", - "email": "mathiasbuus@gmail.com" - }, - "bugs": { - "url": "https://github.com/mafintosh/end-of-stream/issues" - }, - "dependencies": { - "once": "^1.4.0" - }, - "description": "Call a callback when a readable/writable/duplex stream has completed or failed.", - "files": [ - "index.js" - ], - "homepage": "https://github.com/mafintosh/end-of-stream", - "keywords": [ - "stream", - "streams", - "callback", - "finish", - "close", - "end", - "wait" - ], - "license": "MIT", - "main": "index.js", - "name": "end-of-stream", - "repository": { - "type": "git", - "url": "git://github.com/mafintosh/end-of-stream.git" - }, - "scripts": { - "test": "node test.js" - }, - "version": "1.4.1" -} diff --git a/node_modules/execa/index.js b/node_modules/execa/index.js deleted file mode 100644 index aad9ac8..0000000 --- a/node_modules/execa/index.js +++ /dev/null @@ -1,361 +0,0 @@ -'use strict'; -const path = require('path'); -const childProcess = require('child_process'); -const crossSpawn = require('cross-spawn'); -const stripEof = require('strip-eof'); -const npmRunPath = require('npm-run-path'); -const isStream = require('is-stream'); -const _getStream = require('get-stream'); -const pFinally = require('p-finally'); -const onExit = require('signal-exit'); -const errname = require('./lib/errname'); -const stdio = require('./lib/stdio'); - -const TEN_MEGABYTES = 1000 * 1000 * 10; - -function handleArgs(cmd, args, opts) { - let parsed; - - opts = Object.assign({ - extendEnv: true, - env: {} - }, opts); - - if (opts.extendEnv) { - opts.env = Object.assign({}, process.env, opts.env); - } - - if (opts.__winShell === true) { - delete opts.__winShell; - parsed = { - command: cmd, - args, - options: opts, - file: cmd, - original: { - cmd, - args - } - }; - } else { - parsed = crossSpawn._parse(cmd, args, opts); - } - - opts = Object.assign({ - maxBuffer: TEN_MEGABYTES, - buffer: true, - stripEof: true, - preferLocal: true, - localDir: parsed.options.cwd || process.cwd(), - encoding: 'utf8', - reject: true, - cleanup: true - }, parsed.options); - - opts.stdio = stdio(opts); - - if (opts.preferLocal) { - opts.env = npmRunPath.env(Object.assign({}, opts, {cwd: opts.localDir})); - } - - if (opts.detached) { - // #115 - opts.cleanup = false; - } - - if (process.platform === 'win32' && path.basename(parsed.command) === 'cmd.exe') { - // #116 - parsed.args.unshift('/q'); - } - - return { - cmd: parsed.command, - args: parsed.args, - opts, - parsed - }; -} - -function handleInput(spawned, input) { - if (input === null || input === undefined) { - return; - } - - if (isStream(input)) { - input.pipe(spawned.stdin); - } else { - spawned.stdin.end(input); - } -} - -function handleOutput(opts, val) { - if (val && opts.stripEof) { - val = stripEof(val); - } - - return val; -} - -function handleShell(fn, cmd, opts) { - let file = '/bin/sh'; - let args = ['-c', cmd]; - - opts = Object.assign({}, opts); - - if (process.platform === 'win32') { - opts.__winShell = true; - file = process.env.comspec || 'cmd.exe'; - args = ['/s', '/c', `"${cmd}"`]; - opts.windowsVerbatimArguments = true; - } - - if (opts.shell) { - file = opts.shell; - delete opts.shell; - } - - return fn(file, args, opts); -} - -function getStream(process, stream, {encoding, buffer, maxBuffer}) { - if (!process[stream]) { - return null; - } - - let ret; - - if (!buffer) { - // TODO: Use `ret = util.promisify(stream.finished)(process[stream]);` when targeting Node.js 10 - ret = new Promise((resolve, reject) => { - process[stream] - .once('end', resolve) - .once('error', reject); - }); - } else if (encoding) { - ret = _getStream(process[stream], { - encoding, - maxBuffer - }); - } else { - ret = _getStream.buffer(process[stream], {maxBuffer}); - } - - return ret.catch(err => { - err.stream = stream; - err.message = `${stream} ${err.message}`; - throw err; - }); -} - -function makeError(result, options) { - const {stdout, stderr} = result; - - let err = result.error; - const {code, signal} = result; - - const {parsed, joinedCmd} = options; - const timedOut = options.timedOut || false; - - if (!err) { - let output = ''; - - if (Array.isArray(parsed.opts.stdio)) { - if (parsed.opts.stdio[2] !== 'inherit') { - output += output.length > 0 ? stderr : `\n${stderr}`; - } - - if (parsed.opts.stdio[1] !== 'inherit') { - output += `\n${stdout}`; - } - } else if (parsed.opts.stdio !== 'inherit') { - output = `\n${stderr}${stdout}`; - } - - err = new Error(`Command failed: ${joinedCmd}${output}`); - err.code = code < 0 ? errname(code) : code; - } - - err.stdout = stdout; - err.stderr = stderr; - err.failed = true; - err.signal = signal || null; - err.cmd = joinedCmd; - err.timedOut = timedOut; - - return err; -} - -function joinCmd(cmd, args) { - let joinedCmd = cmd; - - if (Array.isArray(args) && args.length > 0) { - joinedCmd += ' ' + args.join(' '); - } - - return joinedCmd; -} - -module.exports = (cmd, args, opts) => { - const parsed = handleArgs(cmd, args, opts); - const {encoding, buffer, maxBuffer} = parsed.opts; - const joinedCmd = joinCmd(cmd, args); - - let spawned; - try { - spawned = childProcess.spawn(parsed.cmd, parsed.args, parsed.opts); - } catch (err) { - return Promise.reject(err); - } - - let removeExitHandler; - if (parsed.opts.cleanup) { - removeExitHandler = onExit(() => { - spawned.kill(); - }); - } - - let timeoutId = null; - let timedOut = false; - - const cleanup = () => { - if (timeoutId) { - clearTimeout(timeoutId); - timeoutId = null; - } - - if (removeExitHandler) { - removeExitHandler(); - } - }; - - if (parsed.opts.timeout > 0) { - timeoutId = setTimeout(() => { - timeoutId = null; - timedOut = true; - spawned.kill(parsed.opts.killSignal); - }, parsed.opts.timeout); - } - - const processDone = new Promise(resolve => { - spawned.on('exit', (code, signal) => { - cleanup(); - resolve({code, signal}); - }); - - spawned.on('error', err => { - cleanup(); - resolve({error: err}); - }); - - if (spawned.stdin) { - spawned.stdin.on('error', err => { - cleanup(); - resolve({error: err}); - }); - } - }); - - function destroy() { - if (spawned.stdout) { - spawned.stdout.destroy(); - } - - if (spawned.stderr) { - spawned.stderr.destroy(); - } - } - - const handlePromise = () => pFinally(Promise.all([ - processDone, - getStream(spawned, 'stdout', {encoding, buffer, maxBuffer}), - getStream(spawned, 'stderr', {encoding, buffer, maxBuffer}) - ]).then(arr => { - const result = arr[0]; - result.stdout = arr[1]; - result.stderr = arr[2]; - - if (result.error || result.code !== 0 || result.signal !== null) { - const err = makeError(result, { - joinedCmd, - parsed, - timedOut - }); - - // TODO: missing some timeout logic for killed - // https://github.com/nodejs/node/blob/master/lib/child_process.js#L203 - // err.killed = spawned.killed || killed; - err.killed = err.killed || spawned.killed; - - if (!parsed.opts.reject) { - return err; - } - - throw err; - } - - return { - stdout: handleOutput(parsed.opts, result.stdout), - stderr: handleOutput(parsed.opts, result.stderr), - code: 0, - failed: false, - killed: false, - signal: null, - cmd: joinedCmd, - timedOut: false - }; - }), destroy); - - crossSpawn._enoent.hookChildProcess(spawned, parsed.parsed); - - handleInput(spawned, parsed.opts.input); - - spawned.then = (onfulfilled, onrejected) => handlePromise().then(onfulfilled, onrejected); - spawned.catch = onrejected => handlePromise().catch(onrejected); - - return spawned; -}; - -// TODO: set `stderr: 'ignore'` when that option is implemented -module.exports.stdout = (...args) => module.exports(...args).then(x => x.stdout); - -// TODO: set `stdout: 'ignore'` when that option is implemented -module.exports.stderr = (...args) => module.exports(...args).then(x => x.stderr); - -module.exports.shell = (cmd, opts) => handleShell(module.exports, cmd, opts); - -module.exports.sync = (cmd, args, opts) => { - const parsed = handleArgs(cmd, args, opts); - const joinedCmd = joinCmd(cmd, args); - - if (isStream(parsed.opts.input)) { - throw new TypeError('The `input` option cannot be a stream in sync mode'); - } - - const result = childProcess.spawnSync(parsed.cmd, parsed.args, parsed.opts); - result.code = result.status; - - if (result.error || result.status !== 0 || result.signal !== null) { - const err = makeError(result, { - joinedCmd, - parsed - }); - - if (!parsed.opts.reject) { - return err; - } - - throw err; - } - - return { - stdout: handleOutput(parsed.opts, result.stdout), - stderr: handleOutput(parsed.opts, result.stderr), - code: 0, - failed: false, - signal: null, - cmd: joinedCmd, - timedOut: false - }; -}; - -module.exports.shellSync = (cmd, opts) => handleShell(module.exports.sync, cmd, opts); diff --git a/node_modules/execa/lib/errname.js b/node_modules/execa/lib/errname.js deleted file mode 100644 index e367837..0000000 --- a/node_modules/execa/lib/errname.js +++ /dev/null @@ -1,39 +0,0 @@ -'use strict'; -// Older verions of Node.js might not have `util.getSystemErrorName()`. -// In that case, fall back to a deprecated internal. -const util = require('util'); - -let uv; - -if (typeof util.getSystemErrorName === 'function') { - module.exports = util.getSystemErrorName; -} else { - try { - uv = process.binding('uv'); - - if (typeof uv.errname !== 'function') { - throw new TypeError('uv.errname is not a function'); - } - } catch (err) { - console.error('execa/lib/errname: unable to establish process.binding(\'uv\')', err); - uv = null; - } - - module.exports = code => errname(uv, code); -} - -// Used for testing the fallback behavior -module.exports.__test__ = errname; - -function errname(uv, code) { - if (uv) { - return uv.errname(code); - } - - if (!(code < 0)) { - throw new Error('err >= 0'); - } - - return `Unknown system error ${code}`; -} - diff --git a/node_modules/execa/lib/stdio.js b/node_modules/execa/lib/stdio.js deleted file mode 100644 index a82d468..0000000 --- a/node_modules/execa/lib/stdio.js +++ /dev/null @@ -1,41 +0,0 @@ -'use strict'; -const alias = ['stdin', 'stdout', 'stderr']; - -const hasAlias = opts => alias.some(x => Boolean(opts[x])); - -module.exports = opts => { - if (!opts) { - return null; - } - - if (opts.stdio && hasAlias(opts)) { - throw new Error(`It's not possible to provide \`stdio\` in combination with one of ${alias.map(x => `\`${x}\``).join(', ')}`); - } - - if (typeof opts.stdio === 'string') { - return opts.stdio; - } - - const stdio = opts.stdio || []; - - if (!Array.isArray(stdio)) { - throw new TypeError(`Expected \`stdio\` to be of type \`string\` or \`Array\`, got \`${typeof stdio}\``); - } - - const result = []; - const len = Math.max(stdio.length, alias.length); - - for (let i = 0; i < len; i++) { - let value = null; - - if (stdio[i] !== undefined) { - value = stdio[i]; - } else if (opts[alias[i]] !== undefined) { - value = opts[alias[i]]; - } - - result[i] = value; - } - - return result; -}; diff --git a/node_modules/execa/package.json b/node_modules/execa/package.json deleted file mode 100644 index f15255f..0000000 --- a/node_modules/execa/package.json +++ /dev/null @@ -1,107 +0,0 @@ -{ - "_args": [ - [ - "execa@1.0.0", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "execa@1.0.0", - "_id": "execa@1.0.0", - "_inBundle": false, - "_integrity": "sha512-adbxcyWV46qiHyvSp50TKt05tB4tK3HcmF7/nxfAdhnox83seTDbwnaqKO4sXRy7roHAIFqJP/Rw/AuEbX61LA==", - "_location": "/execa", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "execa@1.0.0", - "name": "execa", - "escapedName": "execa", - "rawSpec": "1.0.0", - "saveSpec": null, - "fetchSpec": "1.0.0" - }, - "_requiredBy": [ - "/jest-changed-files", - "/os-locale", - "/sane" - ], - "_resolved": "https://registry.npmjs.org/execa/-/execa-1.0.0.tgz", - "_spec": "1.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Sindre Sorhus", - "email": "sindresorhus@gmail.com", - "url": "sindresorhus.com" - }, - "bugs": { - "url": "https://github.com/sindresorhus/execa/issues" - }, - "dependencies": { - "cross-spawn": "^6.0.0", - "get-stream": "^4.0.0", - "is-stream": "^1.1.0", - "npm-run-path": "^2.0.0", - "p-finally": "^1.0.0", - "signal-exit": "^3.0.0", - "strip-eof": "^1.0.0" - }, - "description": "A better `child_process`", - "devDependencies": { - "ava": "*", - "cat-names": "^1.0.2", - "coveralls": "^3.0.1", - "delay": "^3.0.0", - "is-running": "^2.0.0", - "nyc": "^13.0.1", - "tempfile": "^2.0.0", - "xo": "*" - }, - "engines": { - "node": ">=6" - }, - "files": [ - "index.js", - "lib" - ], - "homepage": "https://github.com/sindresorhus/execa#readme", - "keywords": [ - "exec", - "child", - "process", - "execute", - "fork", - "execfile", - "spawn", - "file", - "shell", - "bin", - "binary", - "binaries", - "npm", - "path", - "local" - ], - "license": "MIT", - "name": "execa", - "nyc": { - "reporter": [ - "text", - "lcov" - ], - "exclude": [ - "**/fixtures/**", - "**/test.js", - "**/test/**" - ] - }, - "repository": { - "type": "git", - "url": "git+https://github.com/sindresorhus/execa.git" - }, - "scripts": { - "test": "xo && nyc ava" - }, - "version": "1.0.0" -} diff --git a/node_modules/execa/readme.md b/node_modules/execa/readme.md deleted file mode 100644 index f3f533d..0000000 --- a/node_modules/execa/readme.md +++ /dev/null @@ -1,327 +0,0 @@ -# execa [![Build Status: Linux](https://travis-ci.org/sindresorhus/execa.svg?branch=master)](https://travis-ci.org/sindresorhus/execa) [![Build status: Windows](https://ci.appveyor.com/api/projects/status/x5ajamxtjtt93cqv/branch/master?svg=true)](https://ci.appveyor.com/project/sindresorhus/execa/branch/master) [![Coverage Status](https://coveralls.io/repos/github/sindresorhus/execa/badge.svg?branch=master)](https://coveralls.io/github/sindresorhus/execa?branch=master) - -> A better [`child_process`](https://nodejs.org/api/child_process.html) - - -## Why - -- Promise interface. -- [Strips EOF](https://github.com/sindresorhus/strip-eof) from the output so you don't have to `stdout.trim()`. -- Supports [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) binaries cross-platform. -- [Improved Windows support.](https://github.com/IndigoUnited/node-cross-spawn#why) -- Higher max buffer. 10 MB instead of 200 KB. -- [Executes locally installed binaries by name.](#preferlocal) -- [Cleans up spawned processes when the parent process dies.](#cleanup) - - -## Install - -``` -$ npm install execa -``` - - - - - - -## Usage - -```js -const execa = require('execa'); - -(async () => { - const {stdout} = await execa('echo', ['unicorns']); - console.log(stdout); - //=> 'unicorns' -})(); -``` - -Additional examples: - -```js -const execa = require('execa'); - -(async () => { - // Pipe the child process stdout to the current stdout - execa('echo', ['unicorns']).stdout.pipe(process.stdout); - - - // Run a shell command - const {stdout} = await execa.shell('echo unicorns'); - //=> 'unicorns' - - - // Catching an error - try { - await execa.shell('exit 3'); - } catch (error) { - console.log(error); - /* - { - message: 'Command failed: /bin/sh -c exit 3' - killed: false, - code: 3, - signal: null, - cmd: '/bin/sh -c exit 3', - stdout: '', - stderr: '', - timedOut: false - } - */ - } -})(); - -// Catching an error with a sync method -try { - execa.shellSync('exit 3'); -} catch (error) { - console.log(error); - /* - { - message: 'Command failed: /bin/sh -c exit 3' - code: 3, - signal: null, - cmd: '/bin/sh -c exit 3', - stdout: '', - stderr: '', - timedOut: false - } - */ -} -``` - - -## API - -### execa(file, [arguments], [options]) - -Execute a file. - -Think of this as a mix of `child_process.execFile` and `child_process.spawn`. - -Returns a [`child_process` instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess), which is enhanced to also be a `Promise` for a result `Object` with `stdout` and `stderr` properties. - -### execa.stdout(file, [arguments], [options]) - -Same as `execa()`, but returns only `stdout`. - -### execa.stderr(file, [arguments], [options]) - -Same as `execa()`, but returns only `stderr`. - -### execa.shell(command, [options]) - -Execute a command through the system shell. Prefer `execa()` whenever possible, as it's both faster and safer. - -Returns a [`child_process` instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess). - -The `child_process` instance is enhanced to also be promise for a result object with `stdout` and `stderr` properties. - -### execa.sync(file, [arguments], [options]) - -Execute a file synchronously. - -Returns the same result object as [`child_process.spawnSync`](https://nodejs.org/api/child_process.html#child_process_child_process_spawnsync_command_args_options). - -This method throws an `Error` if the command fails. - -### execa.shellSync(file, [options]) - -Execute a command synchronously through the system shell. - -Returns the same result object as [`child_process.spawnSync`](https://nodejs.org/api/child_process.html#child_process_child_process_spawnsync_command_args_options). - -### options - -Type: `Object` - -#### cwd - -Type: `string`
-Default: `process.cwd()` - -Current working directory of the child process. - -#### env - -Type: `Object`
-Default: `process.env` - -Environment key-value pairs. Extends automatically from `process.env`. Set `extendEnv` to `false` if you don't want this. - -#### extendEnv - -Type: `boolean`
-Default: `true` - -Set to `false` if you don't want to extend the environment variables when providing the `env` property. - -#### argv0 - -Type: `string` - -Explicitly set the value of `argv[0]` sent to the child process. This will be set to `command` or `file` if not specified. - -#### stdio - -Type: `string[]` `string`
-Default: `pipe` - -Child's [stdio](https://nodejs.org/api/child_process.html#child_process_options_stdio) configuration. - -#### detached - -Type: `boolean` - -Prepare child to run independently of its parent process. Specific behavior [depends on the platform](https://nodejs.org/api/child_process.html#child_process_options_detached). - -#### uid - -Type: `number` - -Sets the user identity of the process. - -#### gid - -Type: `number` - -Sets the group identity of the process. - -#### shell - -Type: `boolean` `string`
-Default: `false` - -If `true`, runs `command` inside of a shell. Uses `/bin/sh` on UNIX and `cmd.exe` on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX or `/d /s /c` on Windows. - -#### stripEof - -Type: `boolean`
-Default: `true` - -[Strip EOF](https://github.com/sindresorhus/strip-eof) (last newline) from the output. - -#### preferLocal - -Type: `boolean`
-Default: `true` - -Prefer locally installed binaries when looking for a binary to execute.
-If you `$ npm install foo`, you can then `execa('foo')`. - -#### localDir - -Type: `string`
-Default: `process.cwd()` - -Preferred path to find locally installed binaries in (use with `preferLocal`). - -#### input - -Type: `string` `Buffer` `stream.Readable` - -Write some input to the `stdin` of your binary.
-Streams are not allowed when using the synchronous methods. - -#### reject - -Type: `boolean`
-Default: `true` - -Setting this to `false` resolves the promise with the error instead of rejecting it. - -#### cleanup - -Type: `boolean`
-Default: `true` - -Keep track of the spawned process and `kill` it when the parent process exits. - -#### encoding - -Type: `string`
-Default: `utf8` - -Specify the character encoding used to decode the `stdout` and `stderr` output. - -#### timeout - -Type: `number`
-Default: `0` - -If timeout is greater than `0`, the parent will send the signal identified by the `killSignal` property (the default is `SIGTERM`) if the child runs longer than timeout milliseconds. - -#### buffer - -Type: `boolean`
-Default: `true` - -Buffer the output from the spawned process. When buffering is disabled you must consume the output of the `stdout` and `stderr` streams because the promise will not be resolved/rejected until they have completed. - -#### maxBuffer - -Type: `number`
-Default: `10000000` (10MB) - -Largest amount of data in bytes allowed on `stdout` or `stderr`. - -#### killSignal - -Type: `string` `number`
-Default: `SIGTERM` - -Signal value to be used when the spawned process will be killed. - -#### stdin - -Type: `string` `number` `Stream` `undefined` `null`
-Default: `pipe` - -Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio). - -#### stdout - -Type: `string` `number` `Stream` `undefined` `null`
-Default: `pipe` - -Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio). - -#### stderr - -Type: `string` `number` `Stream` `undefined` `null`
-Default: `pipe` - -Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio). - -#### windowsVerbatimArguments - -Type: `boolean`
-Default: `false` - -If `true`, no quoting or escaping of arguments is done on Windows. Ignored on other platforms. This is set to `true` automatically when the `shell` option is `true`. - - -## Tips - -### Save and pipe output from a child process - -Let's say you want to show the output of a child process in real-time while also saving it to a variable. - -```js -const execa = require('execa'); -const getStream = require('get-stream'); - -const stream = execa('echo', ['foo']).stdout; - -stream.pipe(process.stdout); - -getStream(stream).then(value => { - console.log('child output:', value); -}); -``` - - -## License - -MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/get-stream/buffer-stream.js b/node_modules/get-stream/buffer-stream.js deleted file mode 100644 index 4121c8e..0000000 --- a/node_modules/get-stream/buffer-stream.js +++ /dev/null @@ -1,51 +0,0 @@ -'use strict'; -const {PassThrough} = require('stream'); - -module.exports = options => { - options = Object.assign({}, options); - - const {array} = options; - let {encoding} = options; - const buffer = encoding === 'buffer'; - let objectMode = false; - - if (array) { - objectMode = !(encoding || buffer); - } else { - encoding = encoding || 'utf8'; - } - - if (buffer) { - encoding = null; - } - - let len = 0; - const ret = []; - const stream = new PassThrough({objectMode}); - - if (encoding) { - stream.setEncoding(encoding); - } - - stream.on('data', chunk => { - ret.push(chunk); - - if (objectMode) { - len = ret.length; - } else { - len += chunk.length; - } - }); - - stream.getBufferedValue = () => { - if (array) { - return ret; - } - - return buffer ? Buffer.concat(ret, len) : ret.join(''); - }; - - stream.getBufferedLength = () => len; - - return stream; -}; diff --git a/node_modules/get-stream/index.js b/node_modules/get-stream/index.js deleted file mode 100644 index 7e5584a..0000000 --- a/node_modules/get-stream/index.js +++ /dev/null @@ -1,50 +0,0 @@ -'use strict'; -const pump = require('pump'); -const bufferStream = require('./buffer-stream'); - -class MaxBufferError extends Error { - constructor() { - super('maxBuffer exceeded'); - this.name = 'MaxBufferError'; - } -} - -function getStream(inputStream, options) { - if (!inputStream) { - return Promise.reject(new Error('Expected a stream')); - } - - options = Object.assign({maxBuffer: Infinity}, options); - - const {maxBuffer} = options; - - let stream; - return new Promise((resolve, reject) => { - const rejectPromise = error => { - if (error) { // A null check - error.bufferedData = stream.getBufferedValue(); - } - reject(error); - }; - - stream = pump(inputStream, bufferStream(options), error => { - if (error) { - rejectPromise(error); - return; - } - - resolve(); - }); - - stream.on('data', () => { - if (stream.getBufferedLength() > maxBuffer) { - rejectPromise(new MaxBufferError()); - } - }); - }).then(() => stream.getBufferedValue()); -} - -module.exports = getStream; -module.exports.buffer = (stream, options) => getStream(stream, Object.assign({}, options, {encoding: 'buffer'})); -module.exports.array = (stream, options) => getStream(stream, Object.assign({}, options, {array: true})); -module.exports.MaxBufferError = MaxBufferError; diff --git a/node_modules/get-stream/package.json b/node_modules/get-stream/package.json deleted file mode 100644 index d49f696..0000000 --- a/node_modules/get-stream/package.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "_args": [ - [ - "get-stream@4.1.0", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "get-stream@4.1.0", - "_id": "get-stream@4.1.0", - "_inBundle": false, - "_integrity": "sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==", - "_location": "/get-stream", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "get-stream@4.1.0", - "name": "get-stream", - "escapedName": "get-stream", - "rawSpec": "4.1.0", - "saveSpec": null, - "fetchSpec": "4.1.0" - }, - "_requiredBy": [ - "/execa" - ], - "_resolved": "https://registry.npmjs.org/get-stream/-/get-stream-4.1.0.tgz", - "_spec": "4.1.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Sindre Sorhus", - "email": "sindresorhus@gmail.com", - "url": "sindresorhus.com" - }, - "bugs": { - "url": "https://github.com/sindresorhus/get-stream/issues" - }, - "dependencies": { - "pump": "^3.0.0" - }, - "description": "Get a stream as a string, buffer, or array", - "devDependencies": { - "ava": "*", - "into-stream": "^3.0.0", - "xo": "*" - }, - "engines": { - "node": ">=6" - }, - "files": [ - "index.js", - "buffer-stream.js" - ], - "homepage": "https://github.com/sindresorhus/get-stream#readme", - "keywords": [ - "get", - "stream", - "promise", - "concat", - "string", - "text", - "buffer", - "read", - "data", - "consume", - "readable", - "readablestream", - "array", - "object" - ], - "license": "MIT", - "name": "get-stream", - "repository": { - "type": "git", - "url": "git+https://github.com/sindresorhus/get-stream.git" - }, - "scripts": { - "test": "xo && ava" - }, - "version": "4.1.0" -} diff --git a/node_modules/get-stream/readme.md b/node_modules/get-stream/readme.md deleted file mode 100644 index b87a4d3..0000000 --- a/node_modules/get-stream/readme.md +++ /dev/null @@ -1,123 +0,0 @@ -# get-stream [![Build Status](https://travis-ci.org/sindresorhus/get-stream.svg?branch=master)](https://travis-ci.org/sindresorhus/get-stream) - -> Get a stream as a string, buffer, or array - - -## Install - -``` -$ npm install get-stream -``` - - -## Usage - -```js -const fs = require('fs'); -const getStream = require('get-stream'); - -(async () => { - const stream = fs.createReadStream('unicorn.txt'); - - console.log(await getStream(stream)); - /* - ,,))))))));, - __)))))))))))))), - \|/ -\(((((''''((((((((. - -*-==//////(('' . `)))))), - /|\ ))| o ;-. '((((( ,(, - ( `| / ) ;))))' ,_))^;(~ - | | | ,))((((_ _____------~~~-. %,;(;(>';'~ - o_); ; )))(((` ~---~ `:: \ %%~~)(v;(`('~ - ; ''''```` `: `:::|\,__,%% );`'; ~ - | _ ) / `:|`----' `-' - ______/\/~ | / / - /~;;.____/;;' / ___--,-( `;;;/ - / // _;______;'------~~~~~ /;;/\ / - // | | / ; \;;,\ - (<_ | ; /',/-----' _> - \_| ||_ //~;~~~~~~~~~ - `\_| (,~~ - \~\ - ~~ - */ -})(); -``` - - -## API - -The methods returns a promise that resolves when the `end` event fires on the stream, indicating that there is no more data to be read. The stream is switched to flowing mode. - -### getStream(stream, [options]) - -Get the `stream` as a string. - -#### options - -Type: `Object` - -##### encoding - -Type: `string`
-Default: `utf8` - -[Encoding](https://nodejs.org/api/buffer.html#buffer_buffer) of the incoming stream. - -##### maxBuffer - -Type: `number`
-Default: `Infinity` - -Maximum length of the returned string. If it exceeds this value before the stream ends, the promise will be rejected with a `getStream.MaxBufferError` error. - -### getStream.buffer(stream, [options]) - -Get the `stream` as a buffer. - -It honors the `maxBuffer` option as above, but it refers to byte length rather than string length. - -### getStream.array(stream, [options]) - -Get the `stream` as an array of values. - -It honors both the `maxBuffer` and `encoding` options. The behavior changes slightly based on the encoding chosen: - -- When `encoding` is unset, it assumes an [object mode stream](https://nodesource.com/blog/understanding-object-streams/) and collects values emitted from `stream` unmodified. In this case `maxBuffer` refers to the number of items in the array (not the sum of their sizes). - -- When `encoding` is set to `buffer`, it collects an array of buffers. `maxBuffer` refers to the summed byte lengths of every buffer in the array. - -- When `encoding` is set to anything else, it collects an array of strings. `maxBuffer` refers to the summed character lengths of every string in the array. - - -## Errors - -If the input stream emits an `error` event, the promise will be rejected with the error. The buffered data will be attached to the `bufferedData` property of the error. - -```js -(async () => { - try { - await getStream(streamThatErrorsAtTheEnd('unicorn')); - } catch (error) { - console.log(error.bufferedData); - //=> 'unicorn' - } -})() -``` - - -## FAQ - -### How is this different from [`concat-stream`](https://github.com/maxogden/concat-stream)? - -This module accepts a stream instead of being one and returns a promise instead of using a callback. The API is simpler and it only supports returning a string, buffer, or array. It doesn't have a fragile type inference. You explicitly choose what you want. And it doesn't depend on the huge `readable-stream` package. - - -## Related - -- [get-stdin](https://github.com/sindresorhus/get-stdin) - Get stdin as a string or buffer - - -## License - -MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/is-plain-object/README.md b/node_modules/is-plain-object/README.md index 60b7b59..5c074ab 100644 --- a/node_modules/is-plain-object/README.md +++ b/node_modules/is-plain-object/README.md @@ -1,6 +1,6 @@ # is-plain-object [![NPM version](https://img.shields.io/npm/v/is-plain-object.svg?style=flat)](https://www.npmjs.com/package/is-plain-object) [![NPM monthly downloads](https://img.shields.io/npm/dm/is-plain-object.svg?style=flat)](https://npmjs.org/package/is-plain-object) [![NPM total downloads](https://img.shields.io/npm/dt/is-plain-object.svg?style=flat)](https://npmjs.org/package/is-plain-object) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/is-plain-object.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/is-plain-object) -> Returns true if an object was created by the `Object` constructor. +> Returns true if an object was created by the `Object` constructor, or Object.create(null). Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. @@ -16,11 +16,17 @@ Use [isobject](https://github.com/jonschlinkert/isobject) if you only want to ch ## Usage +with es modules ```js -import isPlainObject from 'is-plain-object'; +import { isPlainObject } from 'is-plain-object'; ``` -**true** when created by the `Object` constructor. +or with commonjs +```js +const { isPlainObject } = require('is-plain-object'); +``` + +**true** when created by the `Object` constructor, or Object.create(null). ```js isPlainObject(Object.create({})); @@ -31,6 +37,8 @@ isPlainObject({foo: 'bar'}); //=> true isPlainObject({}); //=> true +isPlainObject(null); +//=> true ``` **false** when not created by the `Object` constructor. @@ -44,8 +52,6 @@ isPlainObject([]); //=> false isPlainObject(new Foo); //=> false -isPlainObject(null); -//=> false isPlainObject(Object.create(null)); //=> false ``` @@ -116,4 +122,4 @@ Released under the [MIT License](LICENSE). *** -_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on April 28, 2019._ \ No newline at end of file +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on April 28, 2019._ diff --git a/node_modules/is-plain-object/dist/is-plain-object.js b/node_modules/is-plain-object/dist/is-plain-object.js new file mode 100644 index 0000000..d134e4f --- /dev/null +++ b/node_modules/is-plain-object/dist/is-plain-object.js @@ -0,0 +1,38 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +/*! + * is-plain-object + * + * Copyright (c) 2014-2017, Jon Schlinkert. + * Released under the MIT License. + */ + +function isObject(o) { + return Object.prototype.toString.call(o) === '[object Object]'; +} + +function isPlainObject(o) { + var ctor,prot; + + if (isObject(o) === false) return false; + + // If has modified constructor + ctor = o.constructor; + if (ctor === undefined) return true; + + // If has modified prototype + prot = ctor.prototype; + if (isObject(prot) === false) return false; + + // If constructor does not have an Object-specific method + if (prot.hasOwnProperty('isPrototypeOf') === false) { + return false; + } + + // Most likely a plain Object + return true; +} + +exports.isPlainObject = isPlainObject; diff --git a/node_modules/is-plain-object/index.js b/node_modules/is-plain-object/dist/is-plain-object.mjs similarity index 58% rename from node_modules/is-plain-object/index.js rename to node_modules/is-plain-object/dist/is-plain-object.mjs index 565ce9e..c2d9f35 100644 --- a/node_modules/is-plain-object/index.js +++ b/node_modules/is-plain-object/dist/is-plain-object.mjs @@ -5,25 +5,22 @@ * Released under the MIT License. */ -import isObject from 'isobject'; - -function isObjectObject(o) { - return isObject(o) === true - && Object.prototype.toString.call(o) === '[object Object]'; +function isObject(o) { + return Object.prototype.toString.call(o) === '[object Object]'; } -export default function isPlainObject(o) { +function isPlainObject(o) { var ctor,prot; - if (isObjectObject(o) === false) return false; + if (isObject(o) === false) return false; // If has modified constructor ctor = o.constructor; - if (typeof ctor !== 'function') return false; + if (ctor === undefined) return true; // If has modified prototype prot = ctor.prototype; - if (isObjectObject(prot) === false) return false; + if (isObject(prot) === false) return false; // If constructor does not have an Object-specific method if (prot.hasOwnProperty('isPrototypeOf') === false) { @@ -32,4 +29,6 @@ export default function isPlainObject(o) { // Most likely a plain Object return true; -}; +} + +export { isPlainObject }; diff --git a/node_modules/is-plain-object/index.cjs.js b/node_modules/is-plain-object/index.cjs.js deleted file mode 100644 index d7dda95..0000000 --- a/node_modules/is-plain-object/index.cjs.js +++ /dev/null @@ -1,48 +0,0 @@ -'use strict'; - -/*! - * isobject - * - * Copyright (c) 2014-2017, Jon Schlinkert. - * Released under the MIT License. - */ - -function isObject(val) { - return val != null && typeof val === 'object' && Array.isArray(val) === false; -} - -/*! - * is-plain-object - * - * Copyright (c) 2014-2017, Jon Schlinkert. - * Released under the MIT License. - */ - -function isObjectObject(o) { - return isObject(o) === true - && Object.prototype.toString.call(o) === '[object Object]'; -} - -function isPlainObject(o) { - var ctor,prot; - - if (isObjectObject(o) === false) return false; - - // If has modified constructor - ctor = o.constructor; - if (typeof ctor !== 'function') return false; - - // If has modified prototype - prot = ctor.prototype; - if (isObjectObject(prot) === false) return false; - - // If constructor does not have an Object-specific method - if (prot.hasOwnProperty('isPrototypeOf') === false) { - return false; - } - - // Most likely a plain Object - return true; -} - -module.exports = isPlainObject; diff --git a/node_modules/is-plain-object/index.d.ts b/node_modules/is-plain-object/index.d.ts deleted file mode 100644 index fd131f0..0000000 --- a/node_modules/is-plain-object/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -declare function isPlainObject(o: any): boolean; - -export default isPlainObject; diff --git a/node_modules/is-plain-object/is-plain-object.d.ts b/node_modules/is-plain-object/is-plain-object.d.ts new file mode 100644 index 0000000..a359940 --- /dev/null +++ b/node_modules/is-plain-object/is-plain-object.d.ts @@ -0,0 +1 @@ +export function isPlainObject(o: any): boolean; diff --git a/node_modules/is-plain-object/package.json b/node_modules/is-plain-object/package.json index e8fad44..5067784 100644 --- a/node_modules/is-plain-object/package.json +++ b/node_modules/is-plain-object/package.json @@ -1,28 +1,33 @@ { - "_from": "is-plain-object@^3.0.0", - "_id": "is-plain-object@3.0.0", + "_args": [ + [ + "is-plain-object@5.0.0", + "." + ] + ], + "_from": "is-plain-object@5.0.0", + "_id": "is-plain-object@5.0.0", "_inBundle": false, - "_integrity": "sha512-tZIpofR+P05k8Aocp7UI/2UTa9lTJSebCXpFFoR9aibpokDj/uXBsJ8luUu0tTVYKkMU6URDUuOfJZ7koewXvg==", + "_integrity": "sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q==", "_location": "/is-plain-object", "_phantomChildren": {}, "_requested": { - "type": "range", + "type": "version", "registry": true, - "raw": "is-plain-object@^3.0.0", + "raw": "is-plain-object@5.0.0", "name": "is-plain-object", "escapedName": "is-plain-object", - "rawSpec": "^3.0.0", + "rawSpec": "5.0.0", "saveSpec": null, - "fetchSpec": "^3.0.0" + "fetchSpec": "5.0.0" }, "_requiredBy": [ "/@octokit/endpoint", "/@octokit/request" ], - "_resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-3.0.0.tgz", - "_shasum": "47bfc5da1b5d50d64110806c199359482e75a928", - "_spec": "is-plain-object@^3.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/request", + "_resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-5.0.0.tgz", + "_spec": "5.0.0", + "_where": ".", "author": { "name": "Jon Schlinkert", "url": "https://github.com/jonschlinkert" @@ -30,7 +35,6 @@ "bugs": { "url": "https://github.com/jonschlinkert/is-plain-object/issues" }, - "bundleDependencies": false, "contributors": [ { "name": "Jon Schlinkert", @@ -46,29 +50,34 @@ }, { "url": "https://github.com/wtgtybhertgeghgtwtg" + }, + { + "name": "Bogdan Chadkin", + "url": "https://github.com/TrySound" } ], - "dependencies": { - "isobject": "^4.0.0" - }, - "deprecated": false, - "description": "Returns true if an object was created by the `Object` constructor.", + "description": "Returns true if an object was created by the `Object` constructor, or Object.create(null).", "devDependencies": { "chai": "^4.2.0", "esm": "^3.2.22", "gulp-format-md": "^1.0.0", "mocha": "^6.1.4", - "mocha-headless-chrome": "^2.0.2", - "rollup": "^1.10.1", - "rollup-plugin-node-resolve": "^4.2.3" + "mocha-headless-chrome": "^3.1.0", + "rollup": "^2.22.1" }, "engines": { "node": ">=0.10.0" }, + "exports": { + ".": { + "import": "./dist/is-plain-object.mjs", + "require": "./dist/is-plain-object.js" + }, + "./package.json": "./package.json" + }, "files": [ - "index.d.ts", - "index.js", - "index.cjs.js" + "is-plain-object.d.ts", + "dist" ], "homepage": "https://github.com/jonschlinkert/is-plain-object", "keywords": [ @@ -86,8 +95,8 @@ "value" ], "license": "MIT", - "main": "index.cjs.js", - "module": "index.js", + "main": "dist/is-plain-object.js", + "module": "dist/is-plain-object.mjs", "name": "is-plain-object", "repository": { "type": "git", @@ -100,7 +109,7 @@ "test_browser": "mocha-headless-chrome --args=disable-web-security -f test/browser.html", "test_node": "mocha -r esm" }, - "types": "index.d.ts", + "types": "is-plain-object.d.ts", "verb": { "toc": false, "layout": "default", @@ -121,5 +130,5 @@ "reflinks": true } }, - "version": "3.0.0" + "version": "5.0.0" } diff --git a/node_modules/is-stream/index.js b/node_modules/is-stream/index.js deleted file mode 100644 index 6f7ec91..0000000 --- a/node_modules/is-stream/index.js +++ /dev/null @@ -1,21 +0,0 @@ -'use strict'; - -var isStream = module.exports = function (stream) { - return stream !== null && typeof stream === 'object' && typeof stream.pipe === 'function'; -}; - -isStream.writable = function (stream) { - return isStream(stream) && stream.writable !== false && typeof stream._write === 'function' && typeof stream._writableState === 'object'; -}; - -isStream.readable = function (stream) { - return isStream(stream) && stream.readable !== false && typeof stream._read === 'function' && typeof stream._readableState === 'object'; -}; - -isStream.duplex = function (stream) { - return isStream.writable(stream) && isStream.readable(stream); -}; - -isStream.transform = function (stream) { - return isStream.duplex(stream) && typeof stream._transform === 'function' && typeof stream._transformState === 'object'; -}; diff --git a/node_modules/is-stream/license b/node_modules/is-stream/license deleted file mode 100644 index 654d0bf..0000000 --- a/node_modules/is-stream/license +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) Sindre Sorhus (sindresorhus.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/node_modules/is-stream/package.json b/node_modules/is-stream/package.json deleted file mode 100644 index b6805dc..0000000 --- a/node_modules/is-stream/package.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "_args": [ - [ - "is-stream@1.1.0", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "is-stream@1.1.0", - "_id": "is-stream@1.1.0", - "_inBundle": false, - "_integrity": "sha1-EtSj3U5o4Lec6428hBc66A2RykQ=", - "_location": "/is-stream", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "is-stream@1.1.0", - "name": "is-stream", - "escapedName": "is-stream", - "rawSpec": "1.1.0", - "saveSpec": null, - "fetchSpec": "1.1.0" - }, - "_requiredBy": [ - "/execa" - ], - "_resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz", - "_spec": "1.1.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Sindre Sorhus", - "email": "sindresorhus@gmail.com", - "url": "sindresorhus.com" - }, - "bugs": { - "url": "https://github.com/sindresorhus/is-stream/issues" - }, - "description": "Check if something is a Node.js stream", - "devDependencies": { - "ava": "*", - "tempfile": "^1.1.0", - "xo": "*" - }, - "engines": { - "node": ">=0.10.0" - }, - "files": [ - "index.js" - ], - "homepage": "https://github.com/sindresorhus/is-stream#readme", - "keywords": [ - "stream", - "type", - "streams", - "writable", - "readable", - "duplex", - "transform", - "check", - "detect", - "is" - ], - "license": "MIT", - "name": "is-stream", - "repository": { - "type": "git", - "url": "git+https://github.com/sindresorhus/is-stream.git" - }, - "scripts": { - "test": "xo && ava" - }, - "version": "1.1.0" -} diff --git a/node_modules/is-stream/readme.md b/node_modules/is-stream/readme.md deleted file mode 100644 index d8afce8..0000000 --- a/node_modules/is-stream/readme.md +++ /dev/null @@ -1,42 +0,0 @@ -# is-stream [![Build Status](https://travis-ci.org/sindresorhus/is-stream.svg?branch=master)](https://travis-ci.org/sindresorhus/is-stream) - -> Check if something is a [Node.js stream](https://nodejs.org/api/stream.html) - - -## Install - -``` -$ npm install --save is-stream -``` - - -## Usage - -```js -const fs = require('fs'); -const isStream = require('is-stream'); - -isStream(fs.createReadStream('unicorn.png')); -//=> true - -isStream({}); -//=> false -``` - - -## API - -### isStream(stream) - -#### isStream.writable(stream) - -#### isStream.readable(stream) - -#### isStream.duplex(stream) - -#### isStream.transform(stream) - - -## License - -MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/isexe/.npmignore b/node_modules/isexe/.npmignore deleted file mode 100644 index c1cb757..0000000 --- a/node_modules/isexe/.npmignore +++ /dev/null @@ -1,2 +0,0 @@ -.nyc_output/ -coverage/ diff --git a/node_modules/isexe/LICENSE b/node_modules/isexe/LICENSE deleted file mode 100644 index 19129e3..0000000 --- a/node_modules/isexe/LICENSE +++ /dev/null @@ -1,15 +0,0 @@ -The ISC License - -Copyright (c) Isaac Z. Schlueter and Contributors - -Permission to use, copy, modify, and/or distribute this software for any -purpose with or without fee is hereby granted, provided that the above -copyright notice and this permission notice appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR -IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/isexe/README.md b/node_modules/isexe/README.md deleted file mode 100644 index 35769e8..0000000 --- a/node_modules/isexe/README.md +++ /dev/null @@ -1,51 +0,0 @@ -# isexe - -Minimal module to check if a file is executable, and a normal file. - -Uses `fs.stat` and tests against the `PATHEXT` environment variable on -Windows. - -## USAGE - -```javascript -var isexe = require('isexe') -isexe('some-file-name', function (err, isExe) { - if (err) { - console.error('probably file does not exist or something', err) - } else if (isExe) { - console.error('this thing can be run') - } else { - console.error('cannot be run') - } -}) - -// same thing but synchronous, throws errors -var isExe = isexe.sync('some-file-name') - -// treat errors as just "not executable" -isexe('maybe-missing-file', { ignoreErrors: true }, callback) -var isExe = isexe.sync('maybe-missing-file', { ignoreErrors: true }) -``` - -## API - -### `isexe(path, [options], [callback])` - -Check if the path is executable. If no callback provided, and a -global `Promise` object is available, then a Promise will be returned. - -Will raise whatever errors may be raised by `fs.stat`, unless -`options.ignoreErrors` is set to true. - -### `isexe.sync(path, [options])` - -Same as `isexe` but returns the value and throws any errors raised. - -### Options - -* `ignoreErrors` Treat all errors as "no, this is not executable", but - don't raise them. -* `uid` Number to use as the user id -* `gid` Number to use as the group id -* `pathExt` List of path extensions to use instead of `PATHEXT` - environment variable on Windows. diff --git a/node_modules/isexe/index.js b/node_modules/isexe/index.js deleted file mode 100644 index 553fb32..0000000 --- a/node_modules/isexe/index.js +++ /dev/null @@ -1,57 +0,0 @@ -var fs = require('fs') -var core -if (process.platform === 'win32' || global.TESTING_WINDOWS) { - core = require('./windows.js') -} else { - core = require('./mode.js') -} - -module.exports = isexe -isexe.sync = sync - -function isexe (path, options, cb) { - if (typeof options === 'function') { - cb = options - options = {} - } - - if (!cb) { - if (typeof Promise !== 'function') { - throw new TypeError('callback not provided') - } - - return new Promise(function (resolve, reject) { - isexe(path, options || {}, function (er, is) { - if (er) { - reject(er) - } else { - resolve(is) - } - }) - }) - } - - core(path, options || {}, function (er, is) { - // ignore EACCES because that just means we aren't allowed to run it - if (er) { - if (er.code === 'EACCES' || options && options.ignoreErrors) { - er = null - is = false - } - } - cb(er, is) - }) -} - -function sync (path, options) { - // my kingdom for a filtered catch - try { - return core.sync(path, options || {}) - } catch (er) { - if (options && options.ignoreErrors || er.code === 'EACCES') { - return false - } else { - throw er - } - } -} diff --git a/node_modules/isexe/mode.js b/node_modules/isexe/mode.js deleted file mode 100644 index 1995ea4..0000000 --- a/node_modules/isexe/mode.js +++ /dev/null @@ -1,41 +0,0 @@ -module.exports = isexe -isexe.sync = sync - -var fs = require('fs') - -function isexe (path, options, cb) { - fs.stat(path, function (er, stat) { - cb(er, er ? false : checkStat(stat, options)) - }) -} - -function sync (path, options) { - return checkStat(fs.statSync(path), options) -} - -function checkStat (stat, options) { - return stat.isFile() && checkMode(stat, options) -} - -function checkMode (stat, options) { - var mod = stat.mode - var uid = stat.uid - var gid = stat.gid - - var myUid = options.uid !== undefined ? - options.uid : process.getuid && process.getuid() - var myGid = options.gid !== undefined ? - options.gid : process.getgid && process.getgid() - - var u = parseInt('100', 8) - var g = parseInt('010', 8) - var o = parseInt('001', 8) - var ug = u | g - - var ret = (mod & o) || - (mod & g) && gid === myGid || - (mod & u) && uid === myUid || - (mod & ug) && myUid === 0 - - return ret -} diff --git a/node_modules/isexe/package.json b/node_modules/isexe/package.json deleted file mode 100644 index ba05ba8..0000000 --- a/node_modules/isexe/package.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "_args": [ - [ - "isexe@2.0.0", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "isexe@2.0.0", - "_id": "isexe@2.0.0", - "_inBundle": false, - "_integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", - "_location": "/isexe", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "isexe@2.0.0", - "name": "isexe", - "escapedName": "isexe", - "rawSpec": "2.0.0", - "saveSpec": null, - "fetchSpec": "2.0.0" - }, - "_requiredBy": [ - "/which" - ], - "_resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "_spec": "2.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Isaac Z. Schlueter", - "email": "i@izs.me", - "url": "http://blog.izs.me/" - }, - "bugs": { - "url": "https://github.com/isaacs/isexe/issues" - }, - "description": "Minimal module to check if a file is executable.", - "devDependencies": { - "mkdirp": "^0.5.1", - "rimraf": "^2.5.0", - "tap": "^10.3.0" - }, - "directories": { - "test": "test" - }, - "homepage": "https://github.com/isaacs/isexe#readme", - "keywords": [], - "license": "ISC", - "main": "index.js", - "name": "isexe", - "repository": { - "type": "git", - "url": "git+https://github.com/isaacs/isexe.git" - }, - "scripts": { - "postpublish": "git push origin --all; git push origin --tags", - "postversion": "npm publish", - "preversion": "npm test", - "test": "tap test/*.js --100" - }, - "version": "2.0.0" -} diff --git a/node_modules/isexe/test/basic.js b/node_modules/isexe/test/basic.js deleted file mode 100644 index d926df6..0000000 --- a/node_modules/isexe/test/basic.js +++ /dev/null @@ -1,221 +0,0 @@ -var t = require('tap') -var fs = require('fs') -var path = require('path') -var fixture = path.resolve(__dirname, 'fixtures') -var meow = fixture + '/meow.cat' -var mine = fixture + '/mine.cat' -var ours = fixture + '/ours.cat' -var fail = fixture + '/fail.false' -var noent = fixture + '/enoent.exe' -var mkdirp = require('mkdirp') -var rimraf = require('rimraf') - -var isWindows = process.platform === 'win32' -var hasAccess = typeof fs.access === 'function' -var winSkip = isWindows && 'windows' -var accessSkip = !hasAccess && 'no fs.access function' -var hasPromise = typeof Promise === 'function' -var promiseSkip = !hasPromise && 'no global Promise' - -function reset () { - delete require.cache[require.resolve('../')] - return require('../') -} - -t.test('setup fixtures', function (t) { - rimraf.sync(fixture) - mkdirp.sync(fixture) - fs.writeFileSync(meow, '#!/usr/bin/env cat\nmeow\n') - fs.chmodSync(meow, parseInt('0755', 8)) - fs.writeFileSync(fail, '#!/usr/bin/env false\n') - fs.chmodSync(fail, parseInt('0644', 8)) - fs.writeFileSync(mine, '#!/usr/bin/env cat\nmine\n') - fs.chmodSync(mine, parseInt('0744', 8)) - fs.writeFileSync(ours, '#!/usr/bin/env cat\nours\n') - fs.chmodSync(ours, parseInt('0754', 8)) - t.end() -}) - -t.test('promise', { skip: promiseSkip }, function (t) { - var isexe = reset() - t.test('meow async', function (t) { - isexe(meow).then(function (is) { - t.ok(is) - t.end() - }) - }) - t.test('fail async', function (t) { - isexe(fail).then(function (is) { - t.notOk(is) - t.end() - }) - }) - t.test('noent async', function (t) { - isexe(noent).catch(function (er) { - t.ok(er) - t.end() - }) - }) - t.test('noent ignore async', function (t) { - isexe(noent, { ignoreErrors: true }).then(function (is) { - t.notOk(is) - t.end() - }) - }) - t.end() -}) - -t.test('no promise', function (t) { - global.Promise = null - var isexe = reset() - t.throws('try to meow a promise', function () { - isexe(meow) - }) - t.end() -}) - -t.test('access', { skip: accessSkip || winSkip }, function (t) { - runTest(t) -}) - -t.test('mode', { skip: winSkip }, function (t) { - delete fs.access - delete fs.accessSync - var isexe = reset() - t.ok(isexe.sync(ours, { uid: 0, gid: 0 })) - t.ok(isexe.sync(mine, { uid: 0, gid: 0 })) - runTest(t) -}) - -t.test('windows', function (t) { - global.TESTING_WINDOWS = true - var pathExt = '.EXE;.CAT;.CMD;.COM' - t.test('pathExt option', function (t) { - runTest(t, { pathExt: '.EXE;.CAT;.CMD;.COM' }) - }) - t.test('pathExt env', function (t) { - process.env.PATHEXT = pathExt - runTest(t) - }) - t.test('no pathExt', function (t) { - // with a pathExt of '', any filename is fine. - // so the "fail" one would still pass. - runTest(t, { pathExt: '', skipFail: true }) - }) - t.test('pathext with empty entry', function (t) { - // with a pathExt of '', any filename is fine. - // so the "fail" one would still pass. - runTest(t, { pathExt: ';' + pathExt, skipFail: true }) - }) - t.end() -}) - -t.test('cleanup', function (t) { - rimraf.sync(fixture) - t.end() -}) - -function runTest (t, options) { - var isexe = reset() - - var optionsIgnore = Object.create(options || {}) - optionsIgnore.ignoreErrors = true - - if (!options || !options.skipFail) { - t.notOk(isexe.sync(fail, options)) - } - t.notOk(isexe.sync(noent, optionsIgnore)) - if (!options) { - t.ok(isexe.sync(meow)) - } else { - t.ok(isexe.sync(meow, options)) - } - - t.ok(isexe.sync(mine, options)) - t.ok(isexe.sync(ours, options)) - t.throws(function () { - isexe.sync(noent, options) - }) - - t.test('meow async', function (t) { - if (!options) { - isexe(meow, function (er, is) { - if (er) { - throw er - } - t.ok(is) - t.end() - }) - } else { - isexe(meow, options, function (er, is) { - if (er) { - throw er - } - t.ok(is) - t.end() - }) - } - }) - - t.test('mine async', function (t) { - isexe(mine, options, function (er, is) { - if (er) { - throw er - } - t.ok(is) - t.end() - }) - }) - - t.test('ours async', function (t) { - isexe(ours, options, function (er, is) { - if (er) { - throw er - } - t.ok(is) - t.end() - }) - }) - - if (!options || !options.skipFail) { - t.test('fail async', function (t) { - isexe(fail, options, function (er, is) { - if (er) { - throw er - } - t.notOk(is) - t.end() - }) - }) - } - - t.test('noent async', function (t) { - isexe(noent, options, function (er, is) { - t.ok(er) - t.notOk(is) - t.end() - }) - }) - - t.test('noent ignore async', function (t) { - isexe(noent, optionsIgnore, function (er, is) { - if (er) { - throw er - } - t.notOk(is) - t.end() - }) - }) - - t.test('directory is not executable', function (t) { - isexe(__dirname, options, function (er, is) { - if (er) { - throw er - } - t.notOk(is) - t.end() - }) - }) - - t.end() -} diff --git a/node_modules/isexe/windows.js b/node_modules/isexe/windows.js deleted file mode 100644 index 3499673..0000000 --- a/node_modules/isexe/windows.js +++ /dev/null @@ -1,42 +0,0 @@ -module.exports = isexe -isexe.sync = sync - -var fs = require('fs') - -function checkPathExt (path, options) { - var pathext = options.pathExt !== undefined ? - options.pathExt : process.env.PATHEXT - - if (!pathext) { - return true - } - - pathext = pathext.split(';') - if (pathext.indexOf('') !== -1) { - return true - } - for (var i = 0; i < pathext.length; i++) { - var p = pathext[i].toLowerCase() - if (p && path.substr(-p.length).toLowerCase() === p) { - return true - } - } - return false -} - -function checkStat (stat, path, options) { - if (!stat.isSymbolicLink() && !stat.isFile()) { - return false - } - return checkPathExt(path, options) -} - -function isexe (path, options, cb) { - fs.stat(path, function (er, stat) { - cb(er, er ? false : checkStat(stat, path, options)) - }) -} - -function sync (path, options) { - return checkStat(fs.statSync(path), path, options) -} diff --git a/node_modules/isobject/LICENSE b/node_modules/isobject/LICENSE deleted file mode 100644 index 943e71d..0000000 --- a/node_modules/isobject/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2014-2017, Jon Schlinkert. - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. \ No newline at end of file diff --git a/node_modules/isobject/README.md b/node_modules/isobject/README.md deleted file mode 100644 index 1c6e21f..0000000 --- a/node_modules/isobject/README.md +++ /dev/null @@ -1,127 +0,0 @@ -# isobject [![NPM version](https://img.shields.io/npm/v/isobject.svg?style=flat)](https://www.npmjs.com/package/isobject) [![NPM monthly downloads](https://img.shields.io/npm/dm/isobject.svg?style=flat)](https://npmjs.org/package/isobject) [![NPM total downloads](https://img.shields.io/npm/dt/isobject.svg?style=flat)](https://npmjs.org/package/isobject) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/isobject.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/isobject) - -> Returns true if the value is an object and not an array or null. - -Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. - -## Install - -Install with [npm](https://www.npmjs.com/): - -```sh -$ npm install --save isobject -``` - -Use [is-plain-object](https://github.com/jonschlinkert/is-plain-object) if you want only objects that are created by the `Object` constructor. - -## Install - -Install with [npm](https://www.npmjs.com/): - -```sh -$ npm install isobject -``` - -## Usage - -```js -import isObject from 'isobject'; -``` - -**True** - -All of the following return `true`: - -```js -isObject({}); -isObject(Object.create({})); -isObject(Object.create(Object.prototype)); -isObject(Object.create(null)); -isObject({}); -isObject(new Foo); -isObject(/foo/); -``` - -**False** - -All of the following return `false`: - -```js -isObject(); -isObject(function () {}); -isObject(1); -isObject([]); -isObject(undefined); -isObject(null); -``` - -## About - -
-Contributing - -Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). - -
- -
-Running Tests - -Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: - -```sh -$ npm install && npm test -``` - -
- -
-Building docs - -_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ - -To generate the readme, run the following command: - -```sh -$ npm install -g verbose/verb#dev verb-generate-readme && verb -``` - -
- -### Related projects - -You might also be interested in these projects: - -* [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow "Extend an object with the properties of additional objects. node.js/javascript util.") -* [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object "Returns true if an object was created by the `Object` constructor.") -* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of "Get the native type of a value.") -* [merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep "Recursively merge values in a javascript object.") - -### Contributors - -| **Commits** | **Contributor** | -| --- | --- | -| 30 | [jonschlinkert](https://github.com/jonschlinkert) | -| 8 | [doowb](https://github.com/doowb) | -| 7 | [TrySound](https://github.com/TrySound) | -| 3 | [onokumus](https://github.com/onokumus) | -| 1 | [LeSuisse](https://github.com/LeSuisse) | -| 1 | [tmcw](https://github.com/tmcw) | -| 1 | [ZhouHansen](https://github.com/ZhouHansen) | - -### Author - -**Jon Schlinkert** - -* [GitHub Profile](https://github.com/jonschlinkert) -* [Twitter Profile](https://twitter.com/jonschlinkert) -* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert) - -### License - -Copyright © 2019, [Jon Schlinkert](https://github.com/jonschlinkert). -Released under the [MIT License](LICENSE). - -*** - -_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on April 28, 2019._ \ No newline at end of file diff --git a/node_modules/isobject/index.cjs.js b/node_modules/isobject/index.cjs.js deleted file mode 100644 index 49debe7..0000000 --- a/node_modules/isobject/index.cjs.js +++ /dev/null @@ -1,14 +0,0 @@ -'use strict'; - -/*! - * isobject - * - * Copyright (c) 2014-2017, Jon Schlinkert. - * Released under the MIT License. - */ - -function isObject(val) { - return val != null && typeof val === 'object' && Array.isArray(val) === false; -} - -module.exports = isObject; diff --git a/node_modules/isobject/index.d.ts b/node_modules/isobject/index.d.ts deleted file mode 100644 index c471c71..0000000 --- a/node_modules/isobject/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -declare function isObject(val: any): boolean; - -export default isObject; diff --git a/node_modules/isobject/index.js b/node_modules/isobject/index.js deleted file mode 100644 index e9f0382..0000000 --- a/node_modules/isobject/index.js +++ /dev/null @@ -1,10 +0,0 @@ -/*! - * isobject - * - * Copyright (c) 2014-2017, Jon Schlinkert. - * Released under the MIT License. - */ - -export default function isObject(val) { - return val != null && typeof val === 'object' && Array.isArray(val) === false; -}; diff --git a/node_modules/isobject/package.json b/node_modules/isobject/package.json deleted file mode 100644 index b20e4a5..0000000 --- a/node_modules/isobject/package.json +++ /dev/null @@ -1,125 +0,0 @@ -{ - "_from": "isobject@^4.0.0", - "_id": "isobject@4.0.0", - "_inBundle": false, - "_integrity": "sha512-S/2fF5wH8SJA/kmwr6HYhK/RI/OkhD84k8ntalo0iJjZikgq1XFvR5M8NPT1x5F7fBwCG3qHfnzeP/Vh/ZxCUA==", - "_location": "/isobject", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "isobject@^4.0.0", - "name": "isobject", - "escapedName": "isobject", - "rawSpec": "^4.0.0", - "saveSpec": null, - "fetchSpec": "^4.0.0" - }, - "_requiredBy": [ - "/is-plain-object" - ], - "_resolved": "https://registry.npmjs.org/isobject/-/isobject-4.0.0.tgz", - "_shasum": "3f1c9155e73b192022a80819bacd0343711697b0", - "_spec": "isobject@^4.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/is-plain-object", - "author": { - "name": "Jon Schlinkert", - "url": "https://github.com/jonschlinkert" - }, - "bugs": { - "url": "https://github.com/jonschlinkert/isobject/issues" - }, - "bundleDependencies": false, - "contributors": [ - { - "url": "https://github.com/LeSuisse" - }, - { - "name": "Brian Woodward", - "url": "https://twitter.com/doowb" - }, - { - "name": "Jon Schlinkert", - "url": "http://twitter.com/jonschlinkert" - }, - { - "name": "Magnús Dæhlen", - "url": "https://github.com/magnudae" - }, - { - "name": "Tom MacWright", - "url": "https://macwright.org" - } - ], - "dependencies": {}, - "deprecated": false, - "description": "Returns true if the value is an object and not an array or null.", - "devDependencies": { - "esm": "^3.2.22", - "gulp-format-md": "^0.1.9", - "mocha": "^2.4.5", - "rollup": "^1.10.1" - }, - "engines": { - "node": ">=0.10.0" - }, - "files": [ - "index.d.ts", - "index.cjs.js", - "index.js" - ], - "homepage": "https://github.com/jonschlinkert/isobject", - "keywords": [ - "check", - "is", - "is-object", - "isobject", - "kind", - "kind-of", - "kindof", - "native", - "object", - "type", - "typeof", - "value" - ], - "license": "MIT", - "main": "index.cjs.js", - "module": "index.js", - "name": "isobject", - "repository": { - "type": "git", - "url": "git+https://github.com/jonschlinkert/isobject.git" - }, - "scripts": { - "build": "rollup -i index.js -o index.cjs.js -f cjs", - "prepublish": "npm run build", - "test": "mocha -r esm" - }, - "types": "index.d.ts", - "verb": { - "related": { - "list": [ - "extend-shallow", - "is-plain-object", - "kind-of", - "merge-deep" - ] - }, - "toc": false, - "layout": "default", - "tasks": [ - "readme" - ], - "plugins": [ - "gulp-format-md" - ], - "lint": { - "reflinks": true - }, - "reflinks": [ - "verb" - ] - }, - "version": "4.0.0" -} diff --git a/node_modules/lodash.get/LICENSE b/node_modules/lodash.get/LICENSE deleted file mode 100644 index e0c69d5..0000000 --- a/node_modules/lodash.get/LICENSE +++ /dev/null @@ -1,47 +0,0 @@ -Copyright jQuery Foundation and other contributors - -Based on Underscore.js, copyright Jeremy Ashkenas, -DocumentCloud and Investigative Reporters & Editors - -This software consists of voluntary contributions made by many -individuals. For exact contribution history, see the revision history -available at https://github.com/lodash/lodash - -The following license applies to all parts of this software except as -documented below: - -==== - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -==== - -Copyright and related rights for sample code are waived via CC0. Sample -code is defined as all source code displayed within the prose of the -documentation. - -CC0: http://creativecommons.org/publicdomain/zero/1.0/ - -==== - -Files located in the node_modules and vendor directories are externally -maintained libraries used by this software which have their own -licenses; we recommend you read them, as their terms may differ from the -terms above. diff --git a/node_modules/lodash.get/README.md b/node_modules/lodash.get/README.md deleted file mode 100644 index 9079614..0000000 --- a/node_modules/lodash.get/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# lodash.get v4.4.2 - -The [lodash](https://lodash.com/) method `_.get` exported as a [Node.js](https://nodejs.org/) module. - -## Installation - -Using npm: -```bash -$ {sudo -H} npm i -g npm -$ npm i --save lodash.get -``` - -In Node.js: -```js -var get = require('lodash.get'); -``` - -See the [documentation](https://lodash.com/docs#get) or [package source](https://github.com/lodash/lodash/blob/4.4.2-npm-packages/lodash.get) for more details. diff --git a/node_modules/lodash.get/index.js b/node_modules/lodash.get/index.js deleted file mode 100644 index 0eaadec..0000000 --- a/node_modules/lodash.get/index.js +++ /dev/null @@ -1,931 +0,0 @@ -/** - * lodash (Custom Build) - * Build: `lodash modularize exports="npm" -o ./` - * Copyright jQuery Foundation and other contributors - * Released under MIT license - * Based on Underscore.js 1.8.3 - * Copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors - */ - -/** Used as the `TypeError` message for "Functions" methods. */ -var FUNC_ERROR_TEXT = 'Expected a function'; - -/** Used to stand-in for `undefined` hash values. */ -var HASH_UNDEFINED = '__lodash_hash_undefined__'; - -/** Used as references for various `Number` constants. */ -var INFINITY = 1 / 0; - -/** `Object#toString` result references. */ -var funcTag = '[object Function]', - genTag = '[object GeneratorFunction]', - symbolTag = '[object Symbol]'; - -/** Used to match property names within property paths. */ -var reIsDeepProp = /\.|\[(?:[^[\]]*|(["'])(?:(?!\1)[^\\]|\\.)*?\1)\]/, - reIsPlainProp = /^\w*$/, - reLeadingDot = /^\./, - rePropName = /[^.[\]]+|\[(?:(-?\d+(?:\.\d+)?)|(["'])((?:(?!\2)[^\\]|\\.)*?)\2)\]|(?=(?:\.|\[\])(?:\.|\[\]|$))/g; - -/** - * Used to match `RegExp` - * [syntax characters](http://ecma-international.org/ecma-262/7.0/#sec-patterns). - */ -var reRegExpChar = /[\\^$.*+?()[\]{}|]/g; - -/** Used to match backslashes in property paths. */ -var reEscapeChar = /\\(\\)?/g; - -/** Used to detect host constructors (Safari). */ -var reIsHostCtor = /^\[object .+?Constructor\]$/; - -/** Detect free variable `global` from Node.js. */ -var freeGlobal = typeof global == 'object' && global && global.Object === Object && global; - -/** Detect free variable `self`. */ -var freeSelf = typeof self == 'object' && self && self.Object === Object && self; - -/** Used as a reference to the global object. */ -var root = freeGlobal || freeSelf || Function('return this')(); - -/** - * Gets the value at `key` of `object`. - * - * @private - * @param {Object} [object] The object to query. - * @param {string} key The key of the property to get. - * @returns {*} Returns the property value. - */ -function getValue(object, key) { - return object == null ? undefined : object[key]; -} - -/** - * Checks if `value` is a host object in IE < 9. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a host object, else `false`. - */ -function isHostObject(value) { - // Many host objects are `Object` objects that can coerce to strings - // despite having improperly defined `toString` methods. - var result = false; - if (value != null && typeof value.toString != 'function') { - try { - result = !!(value + ''); - } catch (e) {} - } - return result; -} - -/** Used for built-in method references. */ -var arrayProto = Array.prototype, - funcProto = Function.prototype, - objectProto = Object.prototype; - -/** Used to detect overreaching core-js shims. */ -var coreJsData = root['__core-js_shared__']; - -/** Used to detect methods masquerading as native. */ -var maskSrcKey = (function() { - var uid = /[^.]+$/.exec(coreJsData && coreJsData.keys && coreJsData.keys.IE_PROTO || ''); - return uid ? ('Symbol(src)_1.' + uid) : ''; -}()); - -/** Used to resolve the decompiled source of functions. */ -var funcToString = funcProto.toString; - -/** Used to check objects for own properties. */ -var hasOwnProperty = objectProto.hasOwnProperty; - -/** - * Used to resolve the - * [`toStringTag`](http://ecma-international.org/ecma-262/7.0/#sec-object.prototype.tostring) - * of values. - */ -var objectToString = objectProto.toString; - -/** Used to detect if a method is native. */ -var reIsNative = RegExp('^' + - funcToString.call(hasOwnProperty).replace(reRegExpChar, '\\$&') - .replace(/hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g, '$1.*?') + '$' -); - -/** Built-in value references. */ -var Symbol = root.Symbol, - splice = arrayProto.splice; - -/* Built-in method references that are verified to be native. */ -var Map = getNative(root, 'Map'), - nativeCreate = getNative(Object, 'create'); - -/** Used to convert symbols to primitives and strings. */ -var symbolProto = Symbol ? Symbol.prototype : undefined, - symbolToString = symbolProto ? symbolProto.toString : undefined; - -/** - * Creates a hash object. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ -function Hash(entries) { - var index = -1, - length = entries ? entries.length : 0; - - this.clear(); - while (++index < length) { - var entry = entries[index]; - this.set(entry[0], entry[1]); - } -} - -/** - * Removes all key-value entries from the hash. - * - * @private - * @name clear - * @memberOf Hash - */ -function hashClear() { - this.__data__ = nativeCreate ? nativeCreate(null) : {}; -} - -/** - * Removes `key` and its value from the hash. - * - * @private - * @name delete - * @memberOf Hash - * @param {Object} hash The hash to modify. - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ -function hashDelete(key) { - return this.has(key) && delete this.__data__[key]; -} - -/** - * Gets the hash value for `key`. - * - * @private - * @name get - * @memberOf Hash - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ -function hashGet(key) { - var data = this.__data__; - if (nativeCreate) { - var result = data[key]; - return result === HASH_UNDEFINED ? undefined : result; - } - return hasOwnProperty.call(data, key) ? data[key] : undefined; -} - -/** - * Checks if a hash value for `key` exists. - * - * @private - * @name has - * @memberOf Hash - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ -function hashHas(key) { - var data = this.__data__; - return nativeCreate ? data[key] !== undefined : hasOwnProperty.call(data, key); -} - -/** - * Sets the hash `key` to `value`. - * - * @private - * @name set - * @memberOf Hash - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the hash instance. - */ -function hashSet(key, value) { - var data = this.__data__; - data[key] = (nativeCreate && value === undefined) ? HASH_UNDEFINED : value; - return this; -} - -// Add methods to `Hash`. -Hash.prototype.clear = hashClear; -Hash.prototype['delete'] = hashDelete; -Hash.prototype.get = hashGet; -Hash.prototype.has = hashHas; -Hash.prototype.set = hashSet; - -/** - * Creates an list cache object. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ -function ListCache(entries) { - var index = -1, - length = entries ? entries.length : 0; - - this.clear(); - while (++index < length) { - var entry = entries[index]; - this.set(entry[0], entry[1]); - } -} - -/** - * Removes all key-value entries from the list cache. - * - * @private - * @name clear - * @memberOf ListCache - */ -function listCacheClear() { - this.__data__ = []; -} - -/** - * Removes `key` and its value from the list cache. - * - * @private - * @name delete - * @memberOf ListCache - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ -function listCacheDelete(key) { - var data = this.__data__, - index = assocIndexOf(data, key); - - if (index < 0) { - return false; - } - var lastIndex = data.length - 1; - if (index == lastIndex) { - data.pop(); - } else { - splice.call(data, index, 1); - } - return true; -} - -/** - * Gets the list cache value for `key`. - * - * @private - * @name get - * @memberOf ListCache - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ -function listCacheGet(key) { - var data = this.__data__, - index = assocIndexOf(data, key); - - return index < 0 ? undefined : data[index][1]; -} - -/** - * Checks if a list cache value for `key` exists. - * - * @private - * @name has - * @memberOf ListCache - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ -function listCacheHas(key) { - return assocIndexOf(this.__data__, key) > -1; -} - -/** - * Sets the list cache `key` to `value`. - * - * @private - * @name set - * @memberOf ListCache - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the list cache instance. - */ -function listCacheSet(key, value) { - var data = this.__data__, - index = assocIndexOf(data, key); - - if (index < 0) { - data.push([key, value]); - } else { - data[index][1] = value; - } - return this; -} - -// Add methods to `ListCache`. -ListCache.prototype.clear = listCacheClear; -ListCache.prototype['delete'] = listCacheDelete; -ListCache.prototype.get = listCacheGet; -ListCache.prototype.has = listCacheHas; -ListCache.prototype.set = listCacheSet; - -/** - * Creates a map cache object to store key-value pairs. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ -function MapCache(entries) { - var index = -1, - length = entries ? entries.length : 0; - - this.clear(); - while (++index < length) { - var entry = entries[index]; - this.set(entry[0], entry[1]); - } -} - -/** - * Removes all key-value entries from the map. - * - * @private - * @name clear - * @memberOf MapCache - */ -function mapCacheClear() { - this.__data__ = { - 'hash': new Hash, - 'map': new (Map || ListCache), - 'string': new Hash - }; -} - -/** - * Removes `key` and its value from the map. - * - * @private - * @name delete - * @memberOf MapCache - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ -function mapCacheDelete(key) { - return getMapData(this, key)['delete'](key); -} - -/** - * Gets the map value for `key`. - * - * @private - * @name get - * @memberOf MapCache - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ -function mapCacheGet(key) { - return getMapData(this, key).get(key); -} - -/** - * Checks if a map value for `key` exists. - * - * @private - * @name has - * @memberOf MapCache - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ -function mapCacheHas(key) { - return getMapData(this, key).has(key); -} - -/** - * Sets the map `key` to `value`. - * - * @private - * @name set - * @memberOf MapCache - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the map cache instance. - */ -function mapCacheSet(key, value) { - getMapData(this, key).set(key, value); - return this; -} - -// Add methods to `MapCache`. -MapCache.prototype.clear = mapCacheClear; -MapCache.prototype['delete'] = mapCacheDelete; -MapCache.prototype.get = mapCacheGet; -MapCache.prototype.has = mapCacheHas; -MapCache.prototype.set = mapCacheSet; - -/** - * Gets the index at which the `key` is found in `array` of key-value pairs. - * - * @private - * @param {Array} array The array to inspect. - * @param {*} key The key to search for. - * @returns {number} Returns the index of the matched value, else `-1`. - */ -function assocIndexOf(array, key) { - var length = array.length; - while (length--) { - if (eq(array[length][0], key)) { - return length; - } - } - return -1; -} - -/** - * The base implementation of `_.get` without support for default values. - * - * @private - * @param {Object} object The object to query. - * @param {Array|string} path The path of the property to get. - * @returns {*} Returns the resolved value. - */ -function baseGet(object, path) { - path = isKey(path, object) ? [path] : castPath(path); - - var index = 0, - length = path.length; - - while (object != null && index < length) { - object = object[toKey(path[index++])]; - } - return (index && index == length) ? object : undefined; -} - -/** - * The base implementation of `_.isNative` without bad shim checks. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a native function, - * else `false`. - */ -function baseIsNative(value) { - if (!isObject(value) || isMasked(value)) { - return false; - } - var pattern = (isFunction(value) || isHostObject(value)) ? reIsNative : reIsHostCtor; - return pattern.test(toSource(value)); -} - -/** - * The base implementation of `_.toString` which doesn't convert nullish - * values to empty strings. - * - * @private - * @param {*} value The value to process. - * @returns {string} Returns the string. - */ -function baseToString(value) { - // Exit early for strings to avoid a performance hit in some environments. - if (typeof value == 'string') { - return value; - } - if (isSymbol(value)) { - return symbolToString ? symbolToString.call(value) : ''; - } - var result = (value + ''); - return (result == '0' && (1 / value) == -INFINITY) ? '-0' : result; -} - -/** - * Casts `value` to a path array if it's not one. - * - * @private - * @param {*} value The value to inspect. - * @returns {Array} Returns the cast property path array. - */ -function castPath(value) { - return isArray(value) ? value : stringToPath(value); -} - -/** - * Gets the data for `map`. - * - * @private - * @param {Object} map The map to query. - * @param {string} key The reference key. - * @returns {*} Returns the map data. - */ -function getMapData(map, key) { - var data = map.__data__; - return isKeyable(key) - ? data[typeof key == 'string' ? 'string' : 'hash'] - : data.map; -} - -/** - * Gets the native function at `key` of `object`. - * - * @private - * @param {Object} object The object to query. - * @param {string} key The key of the method to get. - * @returns {*} Returns the function if it's native, else `undefined`. - */ -function getNative(object, key) { - var value = getValue(object, key); - return baseIsNative(value) ? value : undefined; -} - -/** - * Checks if `value` is a property name and not a property path. - * - * @private - * @param {*} value The value to check. - * @param {Object} [object] The object to query keys on. - * @returns {boolean} Returns `true` if `value` is a property name, else `false`. - */ -function isKey(value, object) { - if (isArray(value)) { - return false; - } - var type = typeof value; - if (type == 'number' || type == 'symbol' || type == 'boolean' || - value == null || isSymbol(value)) { - return true; - } - return reIsPlainProp.test(value) || !reIsDeepProp.test(value) || - (object != null && value in Object(object)); -} - -/** - * Checks if `value` is suitable for use as unique object key. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is suitable, else `false`. - */ -function isKeyable(value) { - var type = typeof value; - return (type == 'string' || type == 'number' || type == 'symbol' || type == 'boolean') - ? (value !== '__proto__') - : (value === null); -} - -/** - * Checks if `func` has its source masked. - * - * @private - * @param {Function} func The function to check. - * @returns {boolean} Returns `true` if `func` is masked, else `false`. - */ -function isMasked(func) { - return !!maskSrcKey && (maskSrcKey in func); -} - -/** - * Converts `string` to a property path array. - * - * @private - * @param {string} string The string to convert. - * @returns {Array} Returns the property path array. - */ -var stringToPath = memoize(function(string) { - string = toString(string); - - var result = []; - if (reLeadingDot.test(string)) { - result.push(''); - } - string.replace(rePropName, function(match, number, quote, string) { - result.push(quote ? string.replace(reEscapeChar, '$1') : (number || match)); - }); - return result; -}); - -/** - * Converts `value` to a string key if it's not a string or symbol. - * - * @private - * @param {*} value The value to inspect. - * @returns {string|symbol} Returns the key. - */ -function toKey(value) { - if (typeof value == 'string' || isSymbol(value)) { - return value; - } - var result = (value + ''); - return (result == '0' && (1 / value) == -INFINITY) ? '-0' : result; -} - -/** - * Converts `func` to its source code. - * - * @private - * @param {Function} func The function to process. - * @returns {string} Returns the source code. - */ -function toSource(func) { - if (func != null) { - try { - return funcToString.call(func); - } catch (e) {} - try { - return (func + ''); - } catch (e) {} - } - return ''; -} - -/** - * Creates a function that memoizes the result of `func`. If `resolver` is - * provided, it determines the cache key for storing the result based on the - * arguments provided to the memoized function. By default, the first argument - * provided to the memoized function is used as the map cache key. The `func` - * is invoked with the `this` binding of the memoized function. - * - * **Note:** The cache is exposed as the `cache` property on the memoized - * function. Its creation may be customized by replacing the `_.memoize.Cache` - * constructor with one whose instances implement the - * [`Map`](http://ecma-international.org/ecma-262/7.0/#sec-properties-of-the-map-prototype-object) - * method interface of `delete`, `get`, `has`, and `set`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Function - * @param {Function} func The function to have its output memoized. - * @param {Function} [resolver] The function to resolve the cache key. - * @returns {Function} Returns the new memoized function. - * @example - * - * var object = { 'a': 1, 'b': 2 }; - * var other = { 'c': 3, 'd': 4 }; - * - * var values = _.memoize(_.values); - * values(object); - * // => [1, 2] - * - * values(other); - * // => [3, 4] - * - * object.a = 2; - * values(object); - * // => [1, 2] - * - * // Modify the result cache. - * values.cache.set(object, ['a', 'b']); - * values(object); - * // => ['a', 'b'] - * - * // Replace `_.memoize.Cache`. - * _.memoize.Cache = WeakMap; - */ -function memoize(func, resolver) { - if (typeof func != 'function' || (resolver && typeof resolver != 'function')) { - throw new TypeError(FUNC_ERROR_TEXT); - } - var memoized = function() { - var args = arguments, - key = resolver ? resolver.apply(this, args) : args[0], - cache = memoized.cache; - - if (cache.has(key)) { - return cache.get(key); - } - var result = func.apply(this, args); - memoized.cache = cache.set(key, result); - return result; - }; - memoized.cache = new (memoize.Cache || MapCache); - return memoized; -} - -// Assign cache to `_.memoize`. -memoize.Cache = MapCache; - -/** - * Performs a - * [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * comparison between two values to determine if they are equivalent. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @returns {boolean} Returns `true` if the values are equivalent, else `false`. - * @example - * - * var object = { 'a': 1 }; - * var other = { 'a': 1 }; - * - * _.eq(object, object); - * // => true - * - * _.eq(object, other); - * // => false - * - * _.eq('a', 'a'); - * // => true - * - * _.eq('a', Object('a')); - * // => false - * - * _.eq(NaN, NaN); - * // => true - */ -function eq(value, other) { - return value === other || (value !== value && other !== other); -} - -/** - * Checks if `value` is classified as an `Array` object. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an array, else `false`. - * @example - * - * _.isArray([1, 2, 3]); - * // => true - * - * _.isArray(document.body.children); - * // => false - * - * _.isArray('abc'); - * // => false - * - * _.isArray(_.noop); - * // => false - */ -var isArray = Array.isArray; - -/** - * Checks if `value` is classified as a `Function` object. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a function, else `false`. - * @example - * - * _.isFunction(_); - * // => true - * - * _.isFunction(/abc/); - * // => false - */ -function isFunction(value) { - // The use of `Object#toString` avoids issues with the `typeof` operator - // in Safari 8-9 which returns 'object' for typed array and other constructors. - var tag = isObject(value) ? objectToString.call(value) : ''; - return tag == funcTag || tag == genTag; -} - -/** - * Checks if `value` is the - * [language type](http://www.ecma-international.org/ecma-262/7.0/#sec-ecmascript-language-types) - * of `Object`. (e.g. arrays, functions, objects, regexes, `new Number(0)`, and `new String('')`) - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an object, else `false`. - * @example - * - * _.isObject({}); - * // => true - * - * _.isObject([1, 2, 3]); - * // => true - * - * _.isObject(_.noop); - * // => true - * - * _.isObject(null); - * // => false - */ -function isObject(value) { - var type = typeof value; - return !!value && (type == 'object' || type == 'function'); -} - -/** - * Checks if `value` is object-like. A value is object-like if it's not `null` - * and has a `typeof` result of "object". - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is object-like, else `false`. - * @example - * - * _.isObjectLike({}); - * // => true - * - * _.isObjectLike([1, 2, 3]); - * // => true - * - * _.isObjectLike(_.noop); - * // => false - * - * _.isObjectLike(null); - * // => false - */ -function isObjectLike(value) { - return !!value && typeof value == 'object'; -} - -/** - * Checks if `value` is classified as a `Symbol` primitive or object. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a symbol, else `false`. - * @example - * - * _.isSymbol(Symbol.iterator); - * // => true - * - * _.isSymbol('abc'); - * // => false - */ -function isSymbol(value) { - return typeof value == 'symbol' || - (isObjectLike(value) && objectToString.call(value) == symbolTag); -} - -/** - * Converts `value` to a string. An empty string is returned for `null` - * and `undefined` values. The sign of `-0` is preserved. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to process. - * @returns {string} Returns the string. - * @example - * - * _.toString(null); - * // => '' - * - * _.toString(-0); - * // => '-0' - * - * _.toString([1, 2, 3]); - * // => '1,2,3' - */ -function toString(value) { - return value == null ? '' : baseToString(value); -} - -/** - * Gets the value at `path` of `object`. If the resolved value is - * `undefined`, the `defaultValue` is returned in its place. - * - * @static - * @memberOf _ - * @since 3.7.0 - * @category Object - * @param {Object} object The object to query. - * @param {Array|string} path The path of the property to get. - * @param {*} [defaultValue] The value returned for `undefined` resolved values. - * @returns {*} Returns the resolved value. - * @example - * - * var object = { 'a': [{ 'b': { 'c': 3 } }] }; - * - * _.get(object, 'a[0].b.c'); - * // => 3 - * - * _.get(object, ['a', '0', 'b', 'c']); - * // => 3 - * - * _.get(object, 'a.b.c', 'default'); - * // => 'default' - */ -function get(object, path, defaultValue) { - var result = object == null ? undefined : baseGet(object, path); - return result === undefined ? defaultValue : result; -} - -module.exports = get; diff --git a/node_modules/lodash.get/package.json b/node_modules/lodash.get/package.json deleted file mode 100644 index 1616c66..0000000 --- a/node_modules/lodash.get/package.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "_from": "lodash.get@^4.4.2", - "_id": "lodash.get@4.4.2", - "_inBundle": false, - "_integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", - "_location": "/lodash.get", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "lodash.get@^4.4.2", - "name": "lodash.get", - "escapedName": "lodash.get", - "rawSpec": "^4.4.2", - "saveSpec": null, - "fetchSpec": "^4.4.2" - }, - "_requiredBy": [ - "/@octokit/rest" - ], - "_resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", - "_shasum": "2d177f652fa31e939b4438d5341499dfa3825e99", - "_spec": "lodash.get@^4.4.2", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/rest", - "author": { - "name": "John-David Dalton", - "email": "john.david.dalton@gmail.com", - "url": "http://allyoucanleet.com/" - }, - "bugs": { - "url": "https://github.com/lodash/lodash/issues" - }, - "bundleDependencies": false, - "contributors": [ - { - "name": "John-David Dalton", - "email": "john.david.dalton@gmail.com", - "url": "http://allyoucanleet.com/" - }, - { - "name": "Blaine Bublitz", - "email": "blaine.bublitz@gmail.com", - "url": "https://github.com/phated" - }, - { - "name": "Mathias Bynens", - "email": "mathias@qiwi.be", - "url": "https://mathiasbynens.be/" - } - ], - "deprecated": false, - "description": "The lodash method `_.get` exported as a module.", - "homepage": "https://lodash.com/", - "icon": "https://lodash.com/icon.svg", - "keywords": [ - "lodash-modularized", - "get" - ], - "license": "MIT", - "name": "lodash.get", - "repository": { - "type": "git", - "url": "git+https://github.com/lodash/lodash.git" - }, - "scripts": { - "test": "echo \"See https://travis-ci.org/lodash/lodash-cli for testing details.\"" - }, - "version": "4.4.2" -} diff --git a/node_modules/lodash.set/LICENSE b/node_modules/lodash.set/LICENSE deleted file mode 100644 index e0c69d5..0000000 --- a/node_modules/lodash.set/LICENSE +++ /dev/null @@ -1,47 +0,0 @@ -Copyright jQuery Foundation and other contributors - -Based on Underscore.js, copyright Jeremy Ashkenas, -DocumentCloud and Investigative Reporters & Editors - -This software consists of voluntary contributions made by many -individuals. For exact contribution history, see the revision history -available at https://github.com/lodash/lodash - -The following license applies to all parts of this software except as -documented below: - -==== - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -==== - -Copyright and related rights for sample code are waived via CC0. Sample -code is defined as all source code displayed within the prose of the -documentation. - -CC0: http://creativecommons.org/publicdomain/zero/1.0/ - -==== - -Files located in the node_modules and vendor directories are externally -maintained libraries used by this software which have their own -licenses; we recommend you read them, as their terms may differ from the -terms above. diff --git a/node_modules/lodash.set/README.md b/node_modules/lodash.set/README.md deleted file mode 100644 index 1f530bc..0000000 --- a/node_modules/lodash.set/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# lodash.set v4.3.2 - -The [lodash](https://lodash.com/) method `_.set` exported as a [Node.js](https://nodejs.org/) module. - -## Installation - -Using npm: -```bash -$ {sudo -H} npm i -g npm -$ npm i --save lodash.set -``` - -In Node.js: -```js -var set = require('lodash.set'); -``` - -See the [documentation](https://lodash.com/docs#set) or [package source](https://github.com/lodash/lodash/blob/4.3.2-npm-packages/lodash.set) for more details. diff --git a/node_modules/lodash.set/index.js b/node_modules/lodash.set/index.js deleted file mode 100644 index 9f3ed6b..0000000 --- a/node_modules/lodash.set/index.js +++ /dev/null @@ -1,990 +0,0 @@ -/** - * lodash (Custom Build) - * Build: `lodash modularize exports="npm" -o ./` - * Copyright jQuery Foundation and other contributors - * Released under MIT license - * Based on Underscore.js 1.8.3 - * Copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors - */ - -/** Used as the `TypeError` message for "Functions" methods. */ -var FUNC_ERROR_TEXT = 'Expected a function'; - -/** Used to stand-in for `undefined` hash values. */ -var HASH_UNDEFINED = '__lodash_hash_undefined__'; - -/** Used as references for various `Number` constants. */ -var INFINITY = 1 / 0, - MAX_SAFE_INTEGER = 9007199254740991; - -/** `Object#toString` result references. */ -var funcTag = '[object Function]', - genTag = '[object GeneratorFunction]', - symbolTag = '[object Symbol]'; - -/** Used to match property names within property paths. */ -var reIsDeepProp = /\.|\[(?:[^[\]]*|(["'])(?:(?!\1)[^\\]|\\.)*?\1)\]/, - reIsPlainProp = /^\w*$/, - reLeadingDot = /^\./, - rePropName = /[^.[\]]+|\[(?:(-?\d+(?:\.\d+)?)|(["'])((?:(?!\2)[^\\]|\\.)*?)\2)\]|(?=(?:\.|\[\])(?:\.|\[\]|$))/g; - -/** - * Used to match `RegExp` - * [syntax characters](http://ecma-international.org/ecma-262/7.0/#sec-patterns). - */ -var reRegExpChar = /[\\^$.*+?()[\]{}|]/g; - -/** Used to match backslashes in property paths. */ -var reEscapeChar = /\\(\\)?/g; - -/** Used to detect host constructors (Safari). */ -var reIsHostCtor = /^\[object .+?Constructor\]$/; - -/** Used to detect unsigned integer values. */ -var reIsUint = /^(?:0|[1-9]\d*)$/; - -/** Detect free variable `global` from Node.js. */ -var freeGlobal = typeof global == 'object' && global && global.Object === Object && global; - -/** Detect free variable `self`. */ -var freeSelf = typeof self == 'object' && self && self.Object === Object && self; - -/** Used as a reference to the global object. */ -var root = freeGlobal || freeSelf || Function('return this')(); - -/** - * Gets the value at `key` of `object`. - * - * @private - * @param {Object} [object] The object to query. - * @param {string} key The key of the property to get. - * @returns {*} Returns the property value. - */ -function getValue(object, key) { - return object == null ? undefined : object[key]; -} - -/** - * Checks if `value` is a host object in IE < 9. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a host object, else `false`. - */ -function isHostObject(value) { - // Many host objects are `Object` objects that can coerce to strings - // despite having improperly defined `toString` methods. - var result = false; - if (value != null && typeof value.toString != 'function') { - try { - result = !!(value + ''); - } catch (e) {} - } - return result; -} - -/** Used for built-in method references. */ -var arrayProto = Array.prototype, - funcProto = Function.prototype, - objectProto = Object.prototype; - -/** Used to detect overreaching core-js shims. */ -var coreJsData = root['__core-js_shared__']; - -/** Used to detect methods masquerading as native. */ -var maskSrcKey = (function() { - var uid = /[^.]+$/.exec(coreJsData && coreJsData.keys && coreJsData.keys.IE_PROTO || ''); - return uid ? ('Symbol(src)_1.' + uid) : ''; -}()); - -/** Used to resolve the decompiled source of functions. */ -var funcToString = funcProto.toString; - -/** Used to check objects for own properties. */ -var hasOwnProperty = objectProto.hasOwnProperty; - -/** - * Used to resolve the - * [`toStringTag`](http://ecma-international.org/ecma-262/7.0/#sec-object.prototype.tostring) - * of values. - */ -var objectToString = objectProto.toString; - -/** Used to detect if a method is native. */ -var reIsNative = RegExp('^' + - funcToString.call(hasOwnProperty).replace(reRegExpChar, '\\$&') - .replace(/hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g, '$1.*?') + '$' -); - -/** Built-in value references. */ -var Symbol = root.Symbol, - splice = arrayProto.splice; - -/* Built-in method references that are verified to be native. */ -var Map = getNative(root, 'Map'), - nativeCreate = getNative(Object, 'create'); - -/** Used to convert symbols to primitives and strings. */ -var symbolProto = Symbol ? Symbol.prototype : undefined, - symbolToString = symbolProto ? symbolProto.toString : undefined; - -/** - * Creates a hash object. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ -function Hash(entries) { - var index = -1, - length = entries ? entries.length : 0; - - this.clear(); - while (++index < length) { - var entry = entries[index]; - this.set(entry[0], entry[1]); - } -} - -/** - * Removes all key-value entries from the hash. - * - * @private - * @name clear - * @memberOf Hash - */ -function hashClear() { - this.__data__ = nativeCreate ? nativeCreate(null) : {}; -} - -/** - * Removes `key` and its value from the hash. - * - * @private - * @name delete - * @memberOf Hash - * @param {Object} hash The hash to modify. - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ -function hashDelete(key) { - return this.has(key) && delete this.__data__[key]; -} - -/** - * Gets the hash value for `key`. - * - * @private - * @name get - * @memberOf Hash - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ -function hashGet(key) { - var data = this.__data__; - if (nativeCreate) { - var result = data[key]; - return result === HASH_UNDEFINED ? undefined : result; - } - return hasOwnProperty.call(data, key) ? data[key] : undefined; -} - -/** - * Checks if a hash value for `key` exists. - * - * @private - * @name has - * @memberOf Hash - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ -function hashHas(key) { - var data = this.__data__; - return nativeCreate ? data[key] !== undefined : hasOwnProperty.call(data, key); -} - -/** - * Sets the hash `key` to `value`. - * - * @private - * @name set - * @memberOf Hash - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the hash instance. - */ -function hashSet(key, value) { - var data = this.__data__; - data[key] = (nativeCreate && value === undefined) ? HASH_UNDEFINED : value; - return this; -} - -// Add methods to `Hash`. -Hash.prototype.clear = hashClear; -Hash.prototype['delete'] = hashDelete; -Hash.prototype.get = hashGet; -Hash.prototype.has = hashHas; -Hash.prototype.set = hashSet; - -/** - * Creates an list cache object. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ -function ListCache(entries) { - var index = -1, - length = entries ? entries.length : 0; - - this.clear(); - while (++index < length) { - var entry = entries[index]; - this.set(entry[0], entry[1]); - } -} - -/** - * Removes all key-value entries from the list cache. - * - * @private - * @name clear - * @memberOf ListCache - */ -function listCacheClear() { - this.__data__ = []; -} - -/** - * Removes `key` and its value from the list cache. - * - * @private - * @name delete - * @memberOf ListCache - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ -function listCacheDelete(key) { - var data = this.__data__, - index = assocIndexOf(data, key); - - if (index < 0) { - return false; - } - var lastIndex = data.length - 1; - if (index == lastIndex) { - data.pop(); - } else { - splice.call(data, index, 1); - } - return true; -} - -/** - * Gets the list cache value for `key`. - * - * @private - * @name get - * @memberOf ListCache - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ -function listCacheGet(key) { - var data = this.__data__, - index = assocIndexOf(data, key); - - return index < 0 ? undefined : data[index][1]; -} - -/** - * Checks if a list cache value for `key` exists. - * - * @private - * @name has - * @memberOf ListCache - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ -function listCacheHas(key) { - return assocIndexOf(this.__data__, key) > -1; -} - -/** - * Sets the list cache `key` to `value`. - * - * @private - * @name set - * @memberOf ListCache - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the list cache instance. - */ -function listCacheSet(key, value) { - var data = this.__data__, - index = assocIndexOf(data, key); - - if (index < 0) { - data.push([key, value]); - } else { - data[index][1] = value; - } - return this; -} - -// Add methods to `ListCache`. -ListCache.prototype.clear = listCacheClear; -ListCache.prototype['delete'] = listCacheDelete; -ListCache.prototype.get = listCacheGet; -ListCache.prototype.has = listCacheHas; -ListCache.prototype.set = listCacheSet; - -/** - * Creates a map cache object to store key-value pairs. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ -function MapCache(entries) { - var index = -1, - length = entries ? entries.length : 0; - - this.clear(); - while (++index < length) { - var entry = entries[index]; - this.set(entry[0], entry[1]); - } -} - -/** - * Removes all key-value entries from the map. - * - * @private - * @name clear - * @memberOf MapCache - */ -function mapCacheClear() { - this.__data__ = { - 'hash': new Hash, - 'map': new (Map || ListCache), - 'string': new Hash - }; -} - -/** - * Removes `key` and its value from the map. - * - * @private - * @name delete - * @memberOf MapCache - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ -function mapCacheDelete(key) { - return getMapData(this, key)['delete'](key); -} - -/** - * Gets the map value for `key`. - * - * @private - * @name get - * @memberOf MapCache - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ -function mapCacheGet(key) { - return getMapData(this, key).get(key); -} - -/** - * Checks if a map value for `key` exists. - * - * @private - * @name has - * @memberOf MapCache - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ -function mapCacheHas(key) { - return getMapData(this, key).has(key); -} - -/** - * Sets the map `key` to `value`. - * - * @private - * @name set - * @memberOf MapCache - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the map cache instance. - */ -function mapCacheSet(key, value) { - getMapData(this, key).set(key, value); - return this; -} - -// Add methods to `MapCache`. -MapCache.prototype.clear = mapCacheClear; -MapCache.prototype['delete'] = mapCacheDelete; -MapCache.prototype.get = mapCacheGet; -MapCache.prototype.has = mapCacheHas; -MapCache.prototype.set = mapCacheSet; - -/** - * Assigns `value` to `key` of `object` if the existing value is not equivalent - * using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * for equality comparisons. - * - * @private - * @param {Object} object The object to modify. - * @param {string} key The key of the property to assign. - * @param {*} value The value to assign. - */ -function assignValue(object, key, value) { - var objValue = object[key]; - if (!(hasOwnProperty.call(object, key) && eq(objValue, value)) || - (value === undefined && !(key in object))) { - object[key] = value; - } -} - -/** - * Gets the index at which the `key` is found in `array` of key-value pairs. - * - * @private - * @param {Array} array The array to inspect. - * @param {*} key The key to search for. - * @returns {number} Returns the index of the matched value, else `-1`. - */ -function assocIndexOf(array, key) { - var length = array.length; - while (length--) { - if (eq(array[length][0], key)) { - return length; - } - } - return -1; -} - -/** - * The base implementation of `_.isNative` without bad shim checks. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a native function, - * else `false`. - */ -function baseIsNative(value) { - if (!isObject(value) || isMasked(value)) { - return false; - } - var pattern = (isFunction(value) || isHostObject(value)) ? reIsNative : reIsHostCtor; - return pattern.test(toSource(value)); -} - -/** - * The base implementation of `_.set`. - * - * @private - * @param {Object} object The object to modify. - * @param {Array|string} path The path of the property to set. - * @param {*} value The value to set. - * @param {Function} [customizer] The function to customize path creation. - * @returns {Object} Returns `object`. - */ -function baseSet(object, path, value, customizer) { - if (!isObject(object)) { - return object; - } - path = isKey(path, object) ? [path] : castPath(path); - - var index = -1, - length = path.length, - lastIndex = length - 1, - nested = object; - - while (nested != null && ++index < length) { - var key = toKey(path[index]), - newValue = value; - - if (index != lastIndex) { - var objValue = nested[key]; - newValue = customizer ? customizer(objValue, key, nested) : undefined; - if (newValue === undefined) { - newValue = isObject(objValue) - ? objValue - : (isIndex(path[index + 1]) ? [] : {}); - } - } - assignValue(nested, key, newValue); - nested = nested[key]; - } - return object; -} - -/** - * The base implementation of `_.toString` which doesn't convert nullish - * values to empty strings. - * - * @private - * @param {*} value The value to process. - * @returns {string} Returns the string. - */ -function baseToString(value) { - // Exit early for strings to avoid a performance hit in some environments. - if (typeof value == 'string') { - return value; - } - if (isSymbol(value)) { - return symbolToString ? symbolToString.call(value) : ''; - } - var result = (value + ''); - return (result == '0' && (1 / value) == -INFINITY) ? '-0' : result; -} - -/** - * Casts `value` to a path array if it's not one. - * - * @private - * @param {*} value The value to inspect. - * @returns {Array} Returns the cast property path array. - */ -function castPath(value) { - return isArray(value) ? value : stringToPath(value); -} - -/** - * Gets the data for `map`. - * - * @private - * @param {Object} map The map to query. - * @param {string} key The reference key. - * @returns {*} Returns the map data. - */ -function getMapData(map, key) { - var data = map.__data__; - return isKeyable(key) - ? data[typeof key == 'string' ? 'string' : 'hash'] - : data.map; -} - -/** - * Gets the native function at `key` of `object`. - * - * @private - * @param {Object} object The object to query. - * @param {string} key The key of the method to get. - * @returns {*} Returns the function if it's native, else `undefined`. - */ -function getNative(object, key) { - var value = getValue(object, key); - return baseIsNative(value) ? value : undefined; -} - -/** - * Checks if `value` is a valid array-like index. - * - * @private - * @param {*} value The value to check. - * @param {number} [length=MAX_SAFE_INTEGER] The upper bounds of a valid index. - * @returns {boolean} Returns `true` if `value` is a valid index, else `false`. - */ -function isIndex(value, length) { - length = length == null ? MAX_SAFE_INTEGER : length; - return !!length && - (typeof value == 'number' || reIsUint.test(value)) && - (value > -1 && value % 1 == 0 && value < length); -} - -/** - * Checks if `value` is a property name and not a property path. - * - * @private - * @param {*} value The value to check. - * @param {Object} [object] The object to query keys on. - * @returns {boolean} Returns `true` if `value` is a property name, else `false`. - */ -function isKey(value, object) { - if (isArray(value)) { - return false; - } - var type = typeof value; - if (type == 'number' || type == 'symbol' || type == 'boolean' || - value == null || isSymbol(value)) { - return true; - } - return reIsPlainProp.test(value) || !reIsDeepProp.test(value) || - (object != null && value in Object(object)); -} - -/** - * Checks if `value` is suitable for use as unique object key. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is suitable, else `false`. - */ -function isKeyable(value) { - var type = typeof value; - return (type == 'string' || type == 'number' || type == 'symbol' || type == 'boolean') - ? (value !== '__proto__') - : (value === null); -} - -/** - * Checks if `func` has its source masked. - * - * @private - * @param {Function} func The function to check. - * @returns {boolean} Returns `true` if `func` is masked, else `false`. - */ -function isMasked(func) { - return !!maskSrcKey && (maskSrcKey in func); -} - -/** - * Converts `string` to a property path array. - * - * @private - * @param {string} string The string to convert. - * @returns {Array} Returns the property path array. - */ -var stringToPath = memoize(function(string) { - string = toString(string); - - var result = []; - if (reLeadingDot.test(string)) { - result.push(''); - } - string.replace(rePropName, function(match, number, quote, string) { - result.push(quote ? string.replace(reEscapeChar, '$1') : (number || match)); - }); - return result; -}); - -/** - * Converts `value` to a string key if it's not a string or symbol. - * - * @private - * @param {*} value The value to inspect. - * @returns {string|symbol} Returns the key. - */ -function toKey(value) { - if (typeof value == 'string' || isSymbol(value)) { - return value; - } - var result = (value + ''); - return (result == '0' && (1 / value) == -INFINITY) ? '-0' : result; -} - -/** - * Converts `func` to its source code. - * - * @private - * @param {Function} func The function to process. - * @returns {string} Returns the source code. - */ -function toSource(func) { - if (func != null) { - try { - return funcToString.call(func); - } catch (e) {} - try { - return (func + ''); - } catch (e) {} - } - return ''; -} - -/** - * Creates a function that memoizes the result of `func`. If `resolver` is - * provided, it determines the cache key for storing the result based on the - * arguments provided to the memoized function. By default, the first argument - * provided to the memoized function is used as the map cache key. The `func` - * is invoked with the `this` binding of the memoized function. - * - * **Note:** The cache is exposed as the `cache` property on the memoized - * function. Its creation may be customized by replacing the `_.memoize.Cache` - * constructor with one whose instances implement the - * [`Map`](http://ecma-international.org/ecma-262/7.0/#sec-properties-of-the-map-prototype-object) - * method interface of `delete`, `get`, `has`, and `set`. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Function - * @param {Function} func The function to have its output memoized. - * @param {Function} [resolver] The function to resolve the cache key. - * @returns {Function} Returns the new memoized function. - * @example - * - * var object = { 'a': 1, 'b': 2 }; - * var other = { 'c': 3, 'd': 4 }; - * - * var values = _.memoize(_.values); - * values(object); - * // => [1, 2] - * - * values(other); - * // => [3, 4] - * - * object.a = 2; - * values(object); - * // => [1, 2] - * - * // Modify the result cache. - * values.cache.set(object, ['a', 'b']); - * values(object); - * // => ['a', 'b'] - * - * // Replace `_.memoize.Cache`. - * _.memoize.Cache = WeakMap; - */ -function memoize(func, resolver) { - if (typeof func != 'function' || (resolver && typeof resolver != 'function')) { - throw new TypeError(FUNC_ERROR_TEXT); - } - var memoized = function() { - var args = arguments, - key = resolver ? resolver.apply(this, args) : args[0], - cache = memoized.cache; - - if (cache.has(key)) { - return cache.get(key); - } - var result = func.apply(this, args); - memoized.cache = cache.set(key, result); - return result; - }; - memoized.cache = new (memoize.Cache || MapCache); - return memoized; -} - -// Assign cache to `_.memoize`. -memoize.Cache = MapCache; - -/** - * Performs a - * [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * comparison between two values to determine if they are equivalent. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @returns {boolean} Returns `true` if the values are equivalent, else `false`. - * @example - * - * var object = { 'a': 1 }; - * var other = { 'a': 1 }; - * - * _.eq(object, object); - * // => true - * - * _.eq(object, other); - * // => false - * - * _.eq('a', 'a'); - * // => true - * - * _.eq('a', Object('a')); - * // => false - * - * _.eq(NaN, NaN); - * // => true - */ -function eq(value, other) { - return value === other || (value !== value && other !== other); -} - -/** - * Checks if `value` is classified as an `Array` object. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an array, else `false`. - * @example - * - * _.isArray([1, 2, 3]); - * // => true - * - * _.isArray(document.body.children); - * // => false - * - * _.isArray('abc'); - * // => false - * - * _.isArray(_.noop); - * // => false - */ -var isArray = Array.isArray; - -/** - * Checks if `value` is classified as a `Function` object. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a function, else `false`. - * @example - * - * _.isFunction(_); - * // => true - * - * _.isFunction(/abc/); - * // => false - */ -function isFunction(value) { - // The use of `Object#toString` avoids issues with the `typeof` operator - // in Safari 8-9 which returns 'object' for typed array and other constructors. - var tag = isObject(value) ? objectToString.call(value) : ''; - return tag == funcTag || tag == genTag; -} - -/** - * Checks if `value` is the - * [language type](http://www.ecma-international.org/ecma-262/7.0/#sec-ecmascript-language-types) - * of `Object`. (e.g. arrays, functions, objects, regexes, `new Number(0)`, and `new String('')`) - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an object, else `false`. - * @example - * - * _.isObject({}); - * // => true - * - * _.isObject([1, 2, 3]); - * // => true - * - * _.isObject(_.noop); - * // => true - * - * _.isObject(null); - * // => false - */ -function isObject(value) { - var type = typeof value; - return !!value && (type == 'object' || type == 'function'); -} - -/** - * Checks if `value` is object-like. A value is object-like if it's not `null` - * and has a `typeof` result of "object". - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is object-like, else `false`. - * @example - * - * _.isObjectLike({}); - * // => true - * - * _.isObjectLike([1, 2, 3]); - * // => true - * - * _.isObjectLike(_.noop); - * // => false - * - * _.isObjectLike(null); - * // => false - */ -function isObjectLike(value) { - return !!value && typeof value == 'object'; -} - -/** - * Checks if `value` is classified as a `Symbol` primitive or object. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a symbol, else `false`. - * @example - * - * _.isSymbol(Symbol.iterator); - * // => true - * - * _.isSymbol('abc'); - * // => false - */ -function isSymbol(value) { - return typeof value == 'symbol' || - (isObjectLike(value) && objectToString.call(value) == symbolTag); -} - -/** - * Converts `value` to a string. An empty string is returned for `null` - * and `undefined` values. The sign of `-0` is preserved. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to process. - * @returns {string} Returns the string. - * @example - * - * _.toString(null); - * // => '' - * - * _.toString(-0); - * // => '-0' - * - * _.toString([1, 2, 3]); - * // => '1,2,3' - */ -function toString(value) { - return value == null ? '' : baseToString(value); -} - -/** - * Sets the value at `path` of `object`. If a portion of `path` doesn't exist, - * it's created. Arrays are created for missing index properties while objects - * are created for all other missing properties. Use `_.setWith` to customize - * `path` creation. - * - * **Note:** This method mutates `object`. - * - * @static - * @memberOf _ - * @since 3.7.0 - * @category Object - * @param {Object} object The object to modify. - * @param {Array|string} path The path of the property to set. - * @param {*} value The value to set. - * @returns {Object} Returns `object`. - * @example - * - * var object = { 'a': [{ 'b': { 'c': 3 } }] }; - * - * _.set(object, 'a[0].b.c', 4); - * console.log(object.a[0].b.c); - * // => 4 - * - * _.set(object, ['x', '0', 'y', 'z'], 5); - * console.log(object.x[0].y.z); - * // => 5 - */ -function set(object, path, value) { - return object == null ? object : baseSet(object, path, value); -} - -module.exports = set; diff --git a/node_modules/lodash.set/package.json b/node_modules/lodash.set/package.json deleted file mode 100644 index d0b0696..0000000 --- a/node_modules/lodash.set/package.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "_from": "lodash.set@^4.3.2", - "_id": "lodash.set@4.3.2", - "_inBundle": false, - "_integrity": "sha1-2HV7HagH3eJIFrDWqEvqGnYjCyM=", - "_location": "/lodash.set", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "lodash.set@^4.3.2", - "name": "lodash.set", - "escapedName": "lodash.set", - "rawSpec": "^4.3.2", - "saveSpec": null, - "fetchSpec": "^4.3.2" - }, - "_requiredBy": [ - "/@octokit/rest" - ], - "_resolved": "https://registry.npmjs.org/lodash.set/-/lodash.set-4.3.2.tgz", - "_shasum": "d8757b1da807dde24816b0d6a84bea1a76230b23", - "_spec": "lodash.set@^4.3.2", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/rest", - "author": { - "name": "John-David Dalton", - "email": "john.david.dalton@gmail.com", - "url": "http://allyoucanleet.com/" - }, - "bugs": { - "url": "https://github.com/lodash/lodash/issues" - }, - "bundleDependencies": false, - "contributors": [ - { - "name": "John-David Dalton", - "email": "john.david.dalton@gmail.com", - "url": "http://allyoucanleet.com/" - }, - { - "name": "Blaine Bublitz", - "email": "blaine.bublitz@gmail.com", - "url": "https://github.com/phated" - }, - { - "name": "Mathias Bynens", - "email": "mathias@qiwi.be", - "url": "https://mathiasbynens.be/" - } - ], - "deprecated": false, - "description": "The lodash method `_.set` exported as a module.", - "homepage": "https://lodash.com/", - "icon": "https://lodash.com/icon.svg", - "keywords": [ - "lodash-modularized", - "set" - ], - "license": "MIT", - "name": "lodash.set", - "repository": { - "type": "git", - "url": "git+https://github.com/lodash/lodash.git" - }, - "scripts": { - "test": "echo \"See https://travis-ci.org/lodash/lodash-cli for testing details.\"" - }, - "version": "4.3.2" -} diff --git a/node_modules/lodash.uniq/LICENSE b/node_modules/lodash.uniq/LICENSE deleted file mode 100644 index e0c69d5..0000000 --- a/node_modules/lodash.uniq/LICENSE +++ /dev/null @@ -1,47 +0,0 @@ -Copyright jQuery Foundation and other contributors - -Based on Underscore.js, copyright Jeremy Ashkenas, -DocumentCloud and Investigative Reporters & Editors - -This software consists of voluntary contributions made by many -individuals. For exact contribution history, see the revision history -available at https://github.com/lodash/lodash - -The following license applies to all parts of this software except as -documented below: - -==== - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -==== - -Copyright and related rights for sample code are waived via CC0. Sample -code is defined as all source code displayed within the prose of the -documentation. - -CC0: http://creativecommons.org/publicdomain/zero/1.0/ - -==== - -Files located in the node_modules and vendor directories are externally -maintained libraries used by this software which have their own -licenses; we recommend you read them, as their terms may differ from the -terms above. diff --git a/node_modules/lodash.uniq/README.md b/node_modules/lodash.uniq/README.md deleted file mode 100644 index a662a5e..0000000 --- a/node_modules/lodash.uniq/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# lodash.uniq v4.5.0 - -The [lodash](https://lodash.com/) method `_.uniq` exported as a [Node.js](https://nodejs.org/) module. - -## Installation - -Using npm: -```bash -$ {sudo -H} npm i -g npm -$ npm i --save lodash.uniq -``` - -In Node.js: -```js -var uniq = require('lodash.uniq'); -``` - -See the [documentation](https://lodash.com/docs#uniq) or [package source](https://github.com/lodash/lodash/blob/4.5.0-npm-packages/lodash.uniq) for more details. diff --git a/node_modules/lodash.uniq/index.js b/node_modules/lodash.uniq/index.js deleted file mode 100644 index 83fce2b..0000000 --- a/node_modules/lodash.uniq/index.js +++ /dev/null @@ -1,896 +0,0 @@ -/** - * lodash (Custom Build) - * Build: `lodash modularize exports="npm" -o ./` - * Copyright jQuery Foundation and other contributors - * Released under MIT license - * Based on Underscore.js 1.8.3 - * Copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors - */ - -/** Used as the size to enable large array optimizations. */ -var LARGE_ARRAY_SIZE = 200; - -/** Used to stand-in for `undefined` hash values. */ -var HASH_UNDEFINED = '__lodash_hash_undefined__'; - -/** Used as references for various `Number` constants. */ -var INFINITY = 1 / 0; - -/** `Object#toString` result references. */ -var funcTag = '[object Function]', - genTag = '[object GeneratorFunction]'; - -/** - * Used to match `RegExp` - * [syntax characters](http://ecma-international.org/ecma-262/7.0/#sec-patterns). - */ -var reRegExpChar = /[\\^$.*+?()[\]{}|]/g; - -/** Used to detect host constructors (Safari). */ -var reIsHostCtor = /^\[object .+?Constructor\]$/; - -/** Detect free variable `global` from Node.js. */ -var freeGlobal = typeof global == 'object' && global && global.Object === Object && global; - -/** Detect free variable `self`. */ -var freeSelf = typeof self == 'object' && self && self.Object === Object && self; - -/** Used as a reference to the global object. */ -var root = freeGlobal || freeSelf || Function('return this')(); - -/** - * A specialized version of `_.includes` for arrays without support for - * specifying an index to search from. - * - * @private - * @param {Array} [array] The array to inspect. - * @param {*} target The value to search for. - * @returns {boolean} Returns `true` if `target` is found, else `false`. - */ -function arrayIncludes(array, value) { - var length = array ? array.length : 0; - return !!length && baseIndexOf(array, value, 0) > -1; -} - -/** - * This function is like `arrayIncludes` except that it accepts a comparator. - * - * @private - * @param {Array} [array] The array to inspect. - * @param {*} target The value to search for. - * @param {Function} comparator The comparator invoked per element. - * @returns {boolean} Returns `true` if `target` is found, else `false`. - */ -function arrayIncludesWith(array, value, comparator) { - var index = -1, - length = array ? array.length : 0; - - while (++index < length) { - if (comparator(value, array[index])) { - return true; - } - } - return false; -} - -/** - * The base implementation of `_.findIndex` and `_.findLastIndex` without - * support for iteratee shorthands. - * - * @private - * @param {Array} array The array to inspect. - * @param {Function} predicate The function invoked per iteration. - * @param {number} fromIndex The index to search from. - * @param {boolean} [fromRight] Specify iterating from right to left. - * @returns {number} Returns the index of the matched value, else `-1`. - */ -function baseFindIndex(array, predicate, fromIndex, fromRight) { - var length = array.length, - index = fromIndex + (fromRight ? 1 : -1); - - while ((fromRight ? index-- : ++index < length)) { - if (predicate(array[index], index, array)) { - return index; - } - } - return -1; -} - -/** - * The base implementation of `_.indexOf` without `fromIndex` bounds checks. - * - * @private - * @param {Array} array The array to inspect. - * @param {*} value The value to search for. - * @param {number} fromIndex The index to search from. - * @returns {number} Returns the index of the matched value, else `-1`. - */ -function baseIndexOf(array, value, fromIndex) { - if (value !== value) { - return baseFindIndex(array, baseIsNaN, fromIndex); - } - var index = fromIndex - 1, - length = array.length; - - while (++index < length) { - if (array[index] === value) { - return index; - } - } - return -1; -} - -/** - * The base implementation of `_.isNaN` without support for number objects. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is `NaN`, else `false`. - */ -function baseIsNaN(value) { - return value !== value; -} - -/** - * Checks if a cache value for `key` exists. - * - * @private - * @param {Object} cache The cache to query. - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ -function cacheHas(cache, key) { - return cache.has(key); -} - -/** - * Gets the value at `key` of `object`. - * - * @private - * @param {Object} [object] The object to query. - * @param {string} key The key of the property to get. - * @returns {*} Returns the property value. - */ -function getValue(object, key) { - return object == null ? undefined : object[key]; -} - -/** - * Checks if `value` is a host object in IE < 9. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a host object, else `false`. - */ -function isHostObject(value) { - // Many host objects are `Object` objects that can coerce to strings - // despite having improperly defined `toString` methods. - var result = false; - if (value != null && typeof value.toString != 'function') { - try { - result = !!(value + ''); - } catch (e) {} - } - return result; -} - -/** - * Converts `set` to an array of its values. - * - * @private - * @param {Object} set The set to convert. - * @returns {Array} Returns the values. - */ -function setToArray(set) { - var index = -1, - result = Array(set.size); - - set.forEach(function(value) { - result[++index] = value; - }); - return result; -} - -/** Used for built-in method references. */ -var arrayProto = Array.prototype, - funcProto = Function.prototype, - objectProto = Object.prototype; - -/** Used to detect overreaching core-js shims. */ -var coreJsData = root['__core-js_shared__']; - -/** Used to detect methods masquerading as native. */ -var maskSrcKey = (function() { - var uid = /[^.]+$/.exec(coreJsData && coreJsData.keys && coreJsData.keys.IE_PROTO || ''); - return uid ? ('Symbol(src)_1.' + uid) : ''; -}()); - -/** Used to resolve the decompiled source of functions. */ -var funcToString = funcProto.toString; - -/** Used to check objects for own properties. */ -var hasOwnProperty = objectProto.hasOwnProperty; - -/** - * Used to resolve the - * [`toStringTag`](http://ecma-international.org/ecma-262/7.0/#sec-object.prototype.tostring) - * of values. - */ -var objectToString = objectProto.toString; - -/** Used to detect if a method is native. */ -var reIsNative = RegExp('^' + - funcToString.call(hasOwnProperty).replace(reRegExpChar, '\\$&') - .replace(/hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g, '$1.*?') + '$' -); - -/** Built-in value references. */ -var splice = arrayProto.splice; - -/* Built-in method references that are verified to be native. */ -var Map = getNative(root, 'Map'), - Set = getNative(root, 'Set'), - nativeCreate = getNative(Object, 'create'); - -/** - * Creates a hash object. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ -function Hash(entries) { - var index = -1, - length = entries ? entries.length : 0; - - this.clear(); - while (++index < length) { - var entry = entries[index]; - this.set(entry[0], entry[1]); - } -} - -/** - * Removes all key-value entries from the hash. - * - * @private - * @name clear - * @memberOf Hash - */ -function hashClear() { - this.__data__ = nativeCreate ? nativeCreate(null) : {}; -} - -/** - * Removes `key` and its value from the hash. - * - * @private - * @name delete - * @memberOf Hash - * @param {Object} hash The hash to modify. - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ -function hashDelete(key) { - return this.has(key) && delete this.__data__[key]; -} - -/** - * Gets the hash value for `key`. - * - * @private - * @name get - * @memberOf Hash - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ -function hashGet(key) { - var data = this.__data__; - if (nativeCreate) { - var result = data[key]; - return result === HASH_UNDEFINED ? undefined : result; - } - return hasOwnProperty.call(data, key) ? data[key] : undefined; -} - -/** - * Checks if a hash value for `key` exists. - * - * @private - * @name has - * @memberOf Hash - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ -function hashHas(key) { - var data = this.__data__; - return nativeCreate ? data[key] !== undefined : hasOwnProperty.call(data, key); -} - -/** - * Sets the hash `key` to `value`. - * - * @private - * @name set - * @memberOf Hash - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the hash instance. - */ -function hashSet(key, value) { - var data = this.__data__; - data[key] = (nativeCreate && value === undefined) ? HASH_UNDEFINED : value; - return this; -} - -// Add methods to `Hash`. -Hash.prototype.clear = hashClear; -Hash.prototype['delete'] = hashDelete; -Hash.prototype.get = hashGet; -Hash.prototype.has = hashHas; -Hash.prototype.set = hashSet; - -/** - * Creates an list cache object. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ -function ListCache(entries) { - var index = -1, - length = entries ? entries.length : 0; - - this.clear(); - while (++index < length) { - var entry = entries[index]; - this.set(entry[0], entry[1]); - } -} - -/** - * Removes all key-value entries from the list cache. - * - * @private - * @name clear - * @memberOf ListCache - */ -function listCacheClear() { - this.__data__ = []; -} - -/** - * Removes `key` and its value from the list cache. - * - * @private - * @name delete - * @memberOf ListCache - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ -function listCacheDelete(key) { - var data = this.__data__, - index = assocIndexOf(data, key); - - if (index < 0) { - return false; - } - var lastIndex = data.length - 1; - if (index == lastIndex) { - data.pop(); - } else { - splice.call(data, index, 1); - } - return true; -} - -/** - * Gets the list cache value for `key`. - * - * @private - * @name get - * @memberOf ListCache - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ -function listCacheGet(key) { - var data = this.__data__, - index = assocIndexOf(data, key); - - return index < 0 ? undefined : data[index][1]; -} - -/** - * Checks if a list cache value for `key` exists. - * - * @private - * @name has - * @memberOf ListCache - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ -function listCacheHas(key) { - return assocIndexOf(this.__data__, key) > -1; -} - -/** - * Sets the list cache `key` to `value`. - * - * @private - * @name set - * @memberOf ListCache - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the list cache instance. - */ -function listCacheSet(key, value) { - var data = this.__data__, - index = assocIndexOf(data, key); - - if (index < 0) { - data.push([key, value]); - } else { - data[index][1] = value; - } - return this; -} - -// Add methods to `ListCache`. -ListCache.prototype.clear = listCacheClear; -ListCache.prototype['delete'] = listCacheDelete; -ListCache.prototype.get = listCacheGet; -ListCache.prototype.has = listCacheHas; -ListCache.prototype.set = listCacheSet; - -/** - * Creates a map cache object to store key-value pairs. - * - * @private - * @constructor - * @param {Array} [entries] The key-value pairs to cache. - */ -function MapCache(entries) { - var index = -1, - length = entries ? entries.length : 0; - - this.clear(); - while (++index < length) { - var entry = entries[index]; - this.set(entry[0], entry[1]); - } -} - -/** - * Removes all key-value entries from the map. - * - * @private - * @name clear - * @memberOf MapCache - */ -function mapCacheClear() { - this.__data__ = { - 'hash': new Hash, - 'map': new (Map || ListCache), - 'string': new Hash - }; -} - -/** - * Removes `key` and its value from the map. - * - * @private - * @name delete - * @memberOf MapCache - * @param {string} key The key of the value to remove. - * @returns {boolean} Returns `true` if the entry was removed, else `false`. - */ -function mapCacheDelete(key) { - return getMapData(this, key)['delete'](key); -} - -/** - * Gets the map value for `key`. - * - * @private - * @name get - * @memberOf MapCache - * @param {string} key The key of the value to get. - * @returns {*} Returns the entry value. - */ -function mapCacheGet(key) { - return getMapData(this, key).get(key); -} - -/** - * Checks if a map value for `key` exists. - * - * @private - * @name has - * @memberOf MapCache - * @param {string} key The key of the entry to check. - * @returns {boolean} Returns `true` if an entry for `key` exists, else `false`. - */ -function mapCacheHas(key) { - return getMapData(this, key).has(key); -} - -/** - * Sets the map `key` to `value`. - * - * @private - * @name set - * @memberOf MapCache - * @param {string} key The key of the value to set. - * @param {*} value The value to set. - * @returns {Object} Returns the map cache instance. - */ -function mapCacheSet(key, value) { - getMapData(this, key).set(key, value); - return this; -} - -// Add methods to `MapCache`. -MapCache.prototype.clear = mapCacheClear; -MapCache.prototype['delete'] = mapCacheDelete; -MapCache.prototype.get = mapCacheGet; -MapCache.prototype.has = mapCacheHas; -MapCache.prototype.set = mapCacheSet; - -/** - * - * Creates an array cache object to store unique values. - * - * @private - * @constructor - * @param {Array} [values] The values to cache. - */ -function SetCache(values) { - var index = -1, - length = values ? values.length : 0; - - this.__data__ = new MapCache; - while (++index < length) { - this.add(values[index]); - } -} - -/** - * Adds `value` to the array cache. - * - * @private - * @name add - * @memberOf SetCache - * @alias push - * @param {*} value The value to cache. - * @returns {Object} Returns the cache instance. - */ -function setCacheAdd(value) { - this.__data__.set(value, HASH_UNDEFINED); - return this; -} - -/** - * Checks if `value` is in the array cache. - * - * @private - * @name has - * @memberOf SetCache - * @param {*} value The value to search for. - * @returns {number} Returns `true` if `value` is found, else `false`. - */ -function setCacheHas(value) { - return this.__data__.has(value); -} - -// Add methods to `SetCache`. -SetCache.prototype.add = SetCache.prototype.push = setCacheAdd; -SetCache.prototype.has = setCacheHas; - -/** - * Gets the index at which the `key` is found in `array` of key-value pairs. - * - * @private - * @param {Array} array The array to inspect. - * @param {*} key The key to search for. - * @returns {number} Returns the index of the matched value, else `-1`. - */ -function assocIndexOf(array, key) { - var length = array.length; - while (length--) { - if (eq(array[length][0], key)) { - return length; - } - } - return -1; -} - -/** - * The base implementation of `_.isNative` without bad shim checks. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a native function, - * else `false`. - */ -function baseIsNative(value) { - if (!isObject(value) || isMasked(value)) { - return false; - } - var pattern = (isFunction(value) || isHostObject(value)) ? reIsNative : reIsHostCtor; - return pattern.test(toSource(value)); -} - -/** - * The base implementation of `_.uniqBy` without support for iteratee shorthands. - * - * @private - * @param {Array} array The array to inspect. - * @param {Function} [iteratee] The iteratee invoked per element. - * @param {Function} [comparator] The comparator invoked per element. - * @returns {Array} Returns the new duplicate free array. - */ -function baseUniq(array, iteratee, comparator) { - var index = -1, - includes = arrayIncludes, - length = array.length, - isCommon = true, - result = [], - seen = result; - - if (comparator) { - isCommon = false; - includes = arrayIncludesWith; - } - else if (length >= LARGE_ARRAY_SIZE) { - var set = iteratee ? null : createSet(array); - if (set) { - return setToArray(set); - } - isCommon = false; - includes = cacheHas; - seen = new SetCache; - } - else { - seen = iteratee ? [] : result; - } - outer: - while (++index < length) { - var value = array[index], - computed = iteratee ? iteratee(value) : value; - - value = (comparator || value !== 0) ? value : 0; - if (isCommon && computed === computed) { - var seenIndex = seen.length; - while (seenIndex--) { - if (seen[seenIndex] === computed) { - continue outer; - } - } - if (iteratee) { - seen.push(computed); - } - result.push(value); - } - else if (!includes(seen, computed, comparator)) { - if (seen !== result) { - seen.push(computed); - } - result.push(value); - } - } - return result; -} - -/** - * Creates a set object of `values`. - * - * @private - * @param {Array} values The values to add to the set. - * @returns {Object} Returns the new set. - */ -var createSet = !(Set && (1 / setToArray(new Set([,-0]))[1]) == INFINITY) ? noop : function(values) { - return new Set(values); -}; - -/** - * Gets the data for `map`. - * - * @private - * @param {Object} map The map to query. - * @param {string} key The reference key. - * @returns {*} Returns the map data. - */ -function getMapData(map, key) { - var data = map.__data__; - return isKeyable(key) - ? data[typeof key == 'string' ? 'string' : 'hash'] - : data.map; -} - -/** - * Gets the native function at `key` of `object`. - * - * @private - * @param {Object} object The object to query. - * @param {string} key The key of the method to get. - * @returns {*} Returns the function if it's native, else `undefined`. - */ -function getNative(object, key) { - var value = getValue(object, key); - return baseIsNative(value) ? value : undefined; -} - -/** - * Checks if `value` is suitable for use as unique object key. - * - * @private - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is suitable, else `false`. - */ -function isKeyable(value) { - var type = typeof value; - return (type == 'string' || type == 'number' || type == 'symbol' || type == 'boolean') - ? (value !== '__proto__') - : (value === null); -} - -/** - * Checks if `func` has its source masked. - * - * @private - * @param {Function} func The function to check. - * @returns {boolean} Returns `true` if `func` is masked, else `false`. - */ -function isMasked(func) { - return !!maskSrcKey && (maskSrcKey in func); -} - -/** - * Converts `func` to its source code. - * - * @private - * @param {Function} func The function to process. - * @returns {string} Returns the source code. - */ -function toSource(func) { - if (func != null) { - try { - return funcToString.call(func); - } catch (e) {} - try { - return (func + ''); - } catch (e) {} - } - return ''; -} - -/** - * Creates a duplicate-free version of an array, using - * [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * for equality comparisons, in which only the first occurrence of each - * element is kept. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Array - * @param {Array} array The array to inspect. - * @returns {Array} Returns the new duplicate free array. - * @example - * - * _.uniq([2, 1, 2]); - * // => [2, 1] - */ -function uniq(array) { - return (array && array.length) - ? baseUniq(array) - : []; -} - -/** - * Performs a - * [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) - * comparison between two values to determine if they are equivalent. - * - * @static - * @memberOf _ - * @since 4.0.0 - * @category Lang - * @param {*} value The value to compare. - * @param {*} other The other value to compare. - * @returns {boolean} Returns `true` if the values are equivalent, else `false`. - * @example - * - * var object = { 'a': 1 }; - * var other = { 'a': 1 }; - * - * _.eq(object, object); - * // => true - * - * _.eq(object, other); - * // => false - * - * _.eq('a', 'a'); - * // => true - * - * _.eq('a', Object('a')); - * // => false - * - * _.eq(NaN, NaN); - * // => true - */ -function eq(value, other) { - return value === other || (value !== value && other !== other); -} - -/** - * Checks if `value` is classified as a `Function` object. - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is a function, else `false`. - * @example - * - * _.isFunction(_); - * // => true - * - * _.isFunction(/abc/); - * // => false - */ -function isFunction(value) { - // The use of `Object#toString` avoids issues with the `typeof` operator - // in Safari 8-9 which returns 'object' for typed array and other constructors. - var tag = isObject(value) ? objectToString.call(value) : ''; - return tag == funcTag || tag == genTag; -} - -/** - * Checks if `value` is the - * [language type](http://www.ecma-international.org/ecma-262/7.0/#sec-ecmascript-language-types) - * of `Object`. (e.g. arrays, functions, objects, regexes, `new Number(0)`, and `new String('')`) - * - * @static - * @memberOf _ - * @since 0.1.0 - * @category Lang - * @param {*} value The value to check. - * @returns {boolean} Returns `true` if `value` is an object, else `false`. - * @example - * - * _.isObject({}); - * // => true - * - * _.isObject([1, 2, 3]); - * // => true - * - * _.isObject(_.noop); - * // => true - * - * _.isObject(null); - * // => false - */ -function isObject(value) { - var type = typeof value; - return !!value && (type == 'object' || type == 'function'); -} - -/** - * This method returns `undefined`. - * - * @static - * @memberOf _ - * @since 2.3.0 - * @category Util - * @example - * - * _.times(2, _.noop); - * // => [undefined, undefined] - */ -function noop() { - // No operation performed. -} - -module.exports = uniq; diff --git a/node_modules/lodash.uniq/package.json b/node_modules/lodash.uniq/package.json deleted file mode 100644 index adf0b52..0000000 --- a/node_modules/lodash.uniq/package.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "_from": "lodash.uniq@^4.5.0", - "_id": "lodash.uniq@4.5.0", - "_inBundle": false, - "_integrity": "sha1-0CJTc662Uq3BvILklFM5qEJ1R3M=", - "_location": "/lodash.uniq", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "lodash.uniq@^4.5.0", - "name": "lodash.uniq", - "escapedName": "lodash.uniq", - "rawSpec": "^4.5.0", - "saveSpec": null, - "fetchSpec": "^4.5.0" - }, - "_requiredBy": [ - "/@octokit/rest" - ], - "_resolved": "https://registry.npmjs.org/lodash.uniq/-/lodash.uniq-4.5.0.tgz", - "_shasum": "d0225373aeb652adc1bc82e4945339a842754773", - "_spec": "lodash.uniq@^4.5.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/rest", - "author": { - "name": "John-David Dalton", - "email": "john.david.dalton@gmail.com", - "url": "http://allyoucanleet.com/" - }, - "bugs": { - "url": "https://github.com/lodash/lodash/issues" - }, - "bundleDependencies": false, - "contributors": [ - { - "name": "John-David Dalton", - "email": "john.david.dalton@gmail.com", - "url": "http://allyoucanleet.com/" - }, - { - "name": "Blaine Bublitz", - "email": "blaine.bublitz@gmail.com", - "url": "https://github.com/phated" - }, - { - "name": "Mathias Bynens", - "email": "mathias@qiwi.be", - "url": "https://mathiasbynens.be/" - } - ], - "deprecated": false, - "description": "The lodash method `_.uniq` exported as a module.", - "homepage": "https://lodash.com/", - "icon": "https://lodash.com/icon.svg", - "keywords": [ - "lodash-modularized", - "uniq" - ], - "license": "MIT", - "name": "lodash.uniq", - "repository": { - "type": "git", - "url": "git+https://github.com/lodash/lodash.git" - }, - "scripts": { - "test": "echo \"See https://travis-ci.org/lodash/lodash-cli for testing details.\"" - }, - "version": "4.5.0" -} diff --git a/node_modules/macos-release/index.d.ts b/node_modules/macos-release/index.d.ts deleted file mode 100644 index c4efcf4..0000000 --- a/node_modules/macos-release/index.d.ts +++ /dev/null @@ -1,36 +0,0 @@ -declare const macosRelease: { - /** - Get the name and version of a macOS release from the Darwin version. - - @param release - By default, the current operating system is used, but you can supply a custom [Darwin kernel version](http://en.wikipedia.org/wiki/Darwin_%28operating_system%29#Release_history), which is the output of [`os.release()`](https://nodejs.org/api/os.html#os_os_release). - - @example - ``` - import * as os from 'os'; - import macosRelease = require('macos-release'); - - // On a macOS Sierra system - - macosRelease(); - //=> {name: 'Sierra', version: '10.12'} - - os.release(); - //=> 13.2.0 - // This is the Darwin kernel version - - macosRelease(os.release()); - //=> {name: 'Sierra', version: '10.12'} - - macosRelease('14.0.0'); - //=> {name: 'Yosemite', version: '10.10'} - ``` - */ - (release?: string): string; - - // TODO: remove this in the next major version, refactor the whole definition to: - // declare function macosRelease(release?: string): string; - // export = macosRelease; - default: typeof macosRelease; -}; - -export = macosRelease; diff --git a/node_modules/macos-release/index.js b/node_modules/macos-release/index.js deleted file mode 100644 index b6eba6b..0000000 --- a/node_modules/macos-release/index.js +++ /dev/null @@ -1,32 +0,0 @@ -'use strict'; -const os = require('os'); - -const nameMap = new Map([ - [19, 'Catalina'], - [18, 'Mojave'], - [17, 'High Sierra'], - [16, 'Sierra'], - [15, 'El Capitan'], - [14, 'Yosemite'], - [13, 'Mavericks'], - [12, 'Mountain Lion'], - [11, 'Lion'], - [10, 'Snow Leopard'], - [9, 'Leopard'], - [8, 'Tiger'], - [7, 'Panther'], - [6, 'Jaguar'], - [5, 'Puma'] -]); - -const macosRelease = release => { - release = Number((release || os.release()).split('.')[0]); - return { - name: nameMap.get(release), - version: '10.' + (release - 4) - }; -}; - -module.exports = macosRelease; -// TODO: remove this in the next major version -module.exports.default = macosRelease; diff --git a/node_modules/macos-release/license b/node_modules/macos-release/license deleted file mode 100644 index e7af2f7..0000000 --- a/node_modules/macos-release/license +++ /dev/null @@ -1,9 +0,0 @@ -MIT License - -Copyright (c) Sindre Sorhus (sindresorhus.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/macos-release/package.json b/node_modules/macos-release/package.json deleted file mode 100644 index 9cbbf51..0000000 --- a/node_modules/macos-release/package.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "_from": "macos-release@^2.2.0", - "_id": "macos-release@2.3.0", - "_inBundle": false, - "_integrity": "sha512-OHhSbtcviqMPt7yfw5ef5aghS2jzFVKEFyCJndQt2YpSQ9qRVSEv2axSJI1paVThEu+FFGs584h/1YhxjVqajA==", - "_location": "/macos-release", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "macos-release@^2.2.0", - "name": "macos-release", - "escapedName": "macos-release", - "rawSpec": "^2.2.0", - "saveSpec": null, - "fetchSpec": "^2.2.0" - }, - "_requiredBy": [ - "/os-name" - ], - "_resolved": "https://registry.npmjs.org/macos-release/-/macos-release-2.3.0.tgz", - "_shasum": "eb1930b036c0800adebccd5f17bc4c12de8bb71f", - "_spec": "macos-release@^2.2.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/os-name", - "author": { - "name": "Sindre Sorhus", - "email": "sindresorhus@gmail.com", - "url": "sindresorhus.com" - }, - "bugs": { - "url": "https://github.com/sindresorhus/macos-release/issues" - }, - "bundleDependencies": false, - "deprecated": false, - "description": "Get the name and version of a macOS release from the Darwin version", - "devDependencies": { - "ava": "^1.4.1", - "tsd": "^0.7.1", - "xo": "^0.24.0" - }, - "engines": { - "node": ">=6" - }, - "files": [ - "index.js", - "index.d.ts" - ], - "homepage": "https://github.com/sindresorhus/macos-release#readme", - "keywords": [ - "macos", - "os", - "darwin", - "operating", - "system", - "platform", - "name", - "title", - "release", - "version" - ], - "license": "MIT", - "name": "macos-release", - "repository": { - "type": "git", - "url": "git+https://github.com/sindresorhus/macos-release.git" - }, - "scripts": { - "test": "xo && ava && tsd" - }, - "version": "2.3.0" -} diff --git a/node_modules/macos-release/readme.md b/node_modules/macos-release/readme.md deleted file mode 100644 index 2e7b907..0000000 --- a/node_modules/macos-release/readme.md +++ /dev/null @@ -1,57 +0,0 @@ -# macos-release [![Build Status](https://travis-ci.org/sindresorhus/macos-release.svg?branch=master)](https://travis-ci.org/sindresorhus/macos-release) - -> Get the name and version of a macOS release from the Darwin version
-> Example: `13.2.0` → `{name: 'Mavericks', version: '10.9'}` - - -## Install - -``` -$ npm install macos-release -``` - - -## Usage - -```js -const os = require('os'); -const macosRelease = require('macos-release'); - -// On a macOS Sierra system - -macosRelease(); -//=> {name: 'Sierra', version: '10.12'} - -os.release(); -//=> 13.2.0 -// This is the Darwin kernel version - -macosRelease(os.release()); -//=> {name: 'Sierra', version: '10.12'} - -macosRelease('14.0.0'); -//=> {name: 'Yosemite', version: '10.10'} -``` - - -## API - -### macosRelease([release]) - -#### release - -Type: `string` - -By default, the current operating system is used, but you can supply a custom [Darwin kernel version](http://en.wikipedia.org/wiki/Darwin_%28operating_system%29#Release_history), which is the output of [`os.release()`](http://nodejs.org/api/os.html#os_os_release). - - -## Related - -- [os-name](https://github.com/sindresorhus/os-name) - Get the name of the current operating system. Example: `macOS Sierra` -- [macos-version](https://github.com/sindresorhus/macos-version) - Get the macOS version of the current system. Example: `10.9.3` -- [win-release](https://github.com/sindresorhus/win-release) - Get the name of a Windows version from the release number: `5.1.2600` → `XP` - - -## License - -MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/nice-try/CHANGELOG.md b/node_modules/nice-try/CHANGELOG.md deleted file mode 100644 index 9e6baf2..0000000 --- a/node_modules/nice-try/CHANGELOG.md +++ /dev/null @@ -1,21 +0,0 @@ -# Changelog - -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). - -## [1.0.5] - 2018-08-25 - -### Changed - -- Removed `prepublish` script from `package.json` - -## [1.0.4] - 2017-08-08 - -### New - -- Added a changelog - -### Changed - -- Ignore `yarn.lock` and `package-lock.json` files \ No newline at end of file diff --git a/node_modules/nice-try/README.md b/node_modules/nice-try/README.md deleted file mode 100644 index 5b83b78..0000000 --- a/node_modules/nice-try/README.md +++ /dev/null @@ -1,32 +0,0 @@ -# nice-try - -[![Travis Build Status](https://travis-ci.org/electerious/nice-try.svg?branch=master)](https://travis-ci.org/electerious/nice-try) [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/8tqb09wrwci3xf8l?svg=true)](https://ci.appveyor.com/project/electerious/nice-try) [![Coverage Status](https://coveralls.io/repos/github/electerious/nice-try/badge.svg?branch=master)](https://coveralls.io/github/electerious/nice-try?branch=master) [![Dependencies](https://david-dm.org/electerious/nice-try.svg)](https://david-dm.org/electerious/nice-try#info=dependencies) [![Greenkeeper badge](https://badges.greenkeeper.io/electerious/nice-try.svg)](https://greenkeeper.io/) - -A function that tries to execute a function and discards any error that occurs. - -## Install - -``` -npm install nice-try -``` - -## Usage - -```js -const niceTry = require('nice-try') - -niceTry(() => JSON.parse('true')) // true -niceTry(() => JSON.parse('truee')) // undefined -niceTry() // undefined -niceTry(true) // undefined -``` - -## API - -### Parameters - -- `fn` `{Function}` Function that might or might not throw an error. - -### Returns - -- `{?*}` Return-value of the function when no error occurred. \ No newline at end of file diff --git a/node_modules/nice-try/package.json b/node_modules/nice-try/package.json deleted file mode 100644 index 96fd269..0000000 --- a/node_modules/nice-try/package.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "_args": [ - [ - "nice-try@1.0.5", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "nice-try@1.0.5", - "_id": "nice-try@1.0.5", - "_inBundle": false, - "_integrity": "sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ==", - "_location": "/nice-try", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "nice-try@1.0.5", - "name": "nice-try", - "escapedName": "nice-try", - "rawSpec": "1.0.5", - "saveSpec": null, - "fetchSpec": "1.0.5" - }, - "_requiredBy": [ - "/cross-spawn" - ], - "_resolved": "https://registry.npmjs.org/nice-try/-/nice-try-1.0.5.tgz", - "_spec": "1.0.5", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "authors": [ - "Tobias Reich " - ], - "bugs": { - "url": "https://github.com/electerious/nice-try/issues" - }, - "description": "Tries to execute a function and discards any error that occurs", - "devDependencies": { - "chai": "^4.1.2", - "coveralls": "^3.0.0", - "mocha": "^5.1.1", - "nyc": "^12.0.1" - }, - "files": [ - "src" - ], - "homepage": "https://github.com/electerious/nice-try", - "keywords": [ - "try", - "catch", - "error" - ], - "license": "MIT", - "main": "src/index.js", - "name": "nice-try", - "repository": { - "type": "git", - "url": "git+https://github.com/electerious/nice-try.git" - }, - "scripts": { - "coveralls": "nyc report --reporter=text-lcov | coveralls", - "test": "nyc node_modules/mocha/bin/_mocha" - }, - "version": "1.0.5" -} diff --git a/node_modules/nice-try/src/index.js b/node_modules/nice-try/src/index.js deleted file mode 100644 index 837506f..0000000 --- a/node_modules/nice-try/src/index.js +++ /dev/null @@ -1,12 +0,0 @@ -'use strict' - -/** - * Tries to execute a function and discards any error that occurs. - * @param {Function} fn - Function that might or might not throw an error. - * @returns {?*} Return-value of the function when no error occurred. - */ -module.exports = function(fn) { - - try { return fn() } catch (e) {} - -} \ No newline at end of file diff --git a/node_modules/node-fetch/CHANGELOG.md b/node_modules/node-fetch/CHANGELOG.md index 188fcd3..543d3d9 100644 --- a/node_modules/node-fetch/CHANGELOG.md +++ b/node_modules/node-fetch/CHANGELOG.md @@ -5,6 +5,12 @@ Changelog # 2.x release +## v2.6.1 + +**This is an important security release. It is strongly recommended to update as soon as possible.** + +- Fix: honor the `size` option after following a redirect. + ## v2.6.0 - Enhance: `options.agent`, it now accepts a function that returns custom http(s).Agent instance based on current URL, see readme for more information. diff --git a/node_modules/node-fetch/README.md b/node_modules/node-fetch/README.md index cb19901..2dde742 100644 --- a/node_modules/node-fetch/README.md +++ b/node_modules/node-fetch/README.md @@ -5,11 +5,14 @@ node-fetch [![build status][travis-image]][travis-url] [![coverage status][codecov-image]][codecov-url] [![install size][install-size-image]][install-size-url] +[![Discord][discord-image]][discord-url] A light-weight module that brings `window.fetch` to Node.js (We are looking for [v2 maintainers and collaborators](https://github.com/bitinn/node-fetch/issues/567)) +[![Backers][opencollective-image]][opencollective-url] + - [Motivation](#motivation) @@ -48,7 +51,7 @@ A light-weight module that brings `window.fetch` to Node.js ## Motivation -Instead of implementing `XMLHttpRequest` in Node.js to run browser-specific [Fetch polyfill](https://github.com/github/fetch), why not go from native `http` to `fetch` API directly? Hence `node-fetch`, minimal code for a `window.fetch` compatible API on Node.js runtime. +Instead of implementing `XMLHttpRequest` in Node.js to run browser-specific [Fetch polyfill](https://github.com/github/fetch), why not go from native `http` to `fetch` API directly? Hence, `node-fetch`, minimal code for a `window.fetch` compatible API on Node.js runtime. See Matt Andrews' [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch) or Leonardo Quixada's [cross-fetch](https://github.com/lquixada/cross-fetch) for isomorphic usage (exports `node-fetch` for server-side, `whatwg-fetch` for client-side). @@ -56,9 +59,9 @@ See Matt Andrews' [isomorphic-fetch](https://github.com/matthew-andrews/isomorph - Stay consistent with `window.fetch` API. - Make conscious trade-off when following [WHATWG fetch spec][whatwg-fetch] and [stream spec](https://streams.spec.whatwg.org/) implementation details, document known differences. -- Use native promise, but allow substituting it with [insert your favorite promise library]. -- Use native Node streams for body, on both request and response. -- Decode content encoding (gzip/deflate) properly, and convert string output (such as `res.text()` and `res.json()`) to UTF-8 automatically. +- Use native promise but allow substituting it with [insert your favorite promise library]. +- Use native Node streams for body on both request and response. +- Decode content encoding (gzip/deflate) properly and convert string output (such as `res.text()` and `res.json()`) to UTF-8 automatically. - Useful extensions such as timeout, redirect limit, response size limit, [explicit errors](ERROR-HANDLING.md) for troubleshooting. ## Difference from client-side fetch @@ -72,16 +75,16 @@ See Matt Andrews' [isomorphic-fetch](https://github.com/matthew-andrews/isomorph Current stable release (`2.x`) ```sh -$ npm install node-fetch --save +$ npm install node-fetch ``` ## Loading and configuring the module -We suggest you load the module via `require`, pending the stabalizing of es modules in node: +We suggest you load the module via `require` until the stabilization of ES modules in node: ```js const fetch = require('node-fetch'); ``` -If you are using a Promise library other than native, set it through fetch.Promise: +If you are using a Promise library other than native, set it through `fetch.Promise`: ```js const Bluebird = require('bluebird'); @@ -90,7 +93,7 @@ fetch.Promise = Bluebird; ## Common Usage -NOTE: The documentation below is up-to-date with `2.x` releases, [see `1.x` readme](https://github.com/bitinn/node-fetch/blob/1.x/README.md), [changelog](https://github.com/bitinn/node-fetch/blob/1.x/CHANGELOG.md) and [2.x upgrade guide](UPGRADE-GUIDE.md) for the differences. +NOTE: The documentation below is up-to-date with `2.x` releases; see the [`1.x` readme](https://github.com/bitinn/node-fetch/blob/1.x/README.md), [changelog](https://github.com/bitinn/node-fetch/blob/1.x/CHANGELOG.md) and [2.x upgrade guide](UPGRADE-GUIDE.md) for the differences. #### Plain text or HTML ```js @@ -146,9 +149,9 @@ fetch('https://httpbin.org/post', { method: 'POST', body: params }) ``` #### Handling exceptions -NOTE: 3xx-5xx responses are *NOT* exceptions, and should be handled in `then()`, see the next section. +NOTE: 3xx-5xx responses are *NOT* exceptions and should be handled in `then()`; see the next section for more information. -Adding a catch to the fetch promise chain will catch *all* exceptions, such as errors originating from node core libraries, like network errors, and operational errors which are instances of FetchError. See the [error handling document](ERROR-HANDLING.md) for more details. +Adding a catch to the fetch promise chain will catch *all* exceptions, such as errors originating from node core libraries, network errors and operational errors, which are instances of FetchError. See the [error handling document](ERROR-HANDLING.md) for more details. ```js fetch('https://domain.invalid/') @@ -186,7 +189,7 @@ fetch('https://assets-cdn.github.com/images/modules/logos_page/Octocat.png') ``` #### Buffer -If you prefer to cache binary data in full, use buffer(). (NOTE: buffer() is a `node-fetch` only API) +If you prefer to cache binary data in full, use buffer(). (NOTE: `buffer()` is a `node-fetch`-only API) ```js const fileType = require('file-type'); @@ -211,7 +214,7 @@ fetch('https://github.com/') #### Extract Set-Cookie Header -Unlike browsers, you can access raw `Set-Cookie` headers manually using `Headers.raw()`, this is a `node-fetch` only API. +Unlike browsers, you can access raw `Set-Cookie` headers manually using `Headers.raw()`. This is a `node-fetch` only API. ```js fetch(url).then(res => { @@ -263,11 +266,11 @@ fetch('https://httpbin.org/post', options) #### Request cancellation with AbortSignal -> NOTE: You may only cancel streamed requests on Node >= v8.0.0 +> NOTE: You may cancel streamed requests only on Node >= v8.0.0 You may cancel requests with `AbortController`. A suggested implementation is [`abort-controller`](https://www.npmjs.com/package/abort-controller). -An example of timing out a request after 150ms could be achieved as follows: +An example of timing out a request after 150ms could be achieved as the following: ```js import AbortController from 'abort-controller'; @@ -308,7 +311,7 @@ See [test cases](https://github.com/bitinn/node-fetch/blob/master/test/test.js) Perform an HTTP(S) fetch. -`url` should be an absolute url, such as `https://example.com/`. A path-relative URL (`/file/under/root`) or protocol-relative URL (`//can-be-http-or-https.com/`) will result in a rejected promise. +`url` should be an absolute url, such as `https://example.com/`. A path-relative URL (`/file/under/root`) or protocol-relative URL (`//can-be-http-or-https.com/`) will result in a rejected `Promise`. ### Options @@ -350,7 +353,7 @@ Note: when `body` is a `Stream`, `Content-Length` is not set automatically. ##### Custom Agent -The `agent` option allows you to specify networking related options that's out of the scope of Fetch. Including and not limit to: +The `agent` option allows you to specify networking related options which are out of the scope of Fetch, including and not limited to the following: - Support self-signed certificate - Use only IPv4 or IPv6 @@ -358,7 +361,7 @@ The `agent` option allows you to specify networking related options that's out o See [`http.Agent`](https://nodejs.org/api/http.html#http_new_agent_options) for more information. -In addition, `agent` option accepts a function that returns http(s).Agent instance given current [URL](https://nodejs.org/api/url.html), this is useful during a redirection chain across HTTP and HTTPS protocol. +In addition, the `agent` option accepts a function that returns `http`(s)`.Agent` instance given current [URL](https://nodejs.org/api/url.html), this is useful during a redirection chain across HTTP and HTTPS protocol. ```js const httpAgent = new http.Agent({ @@ -432,7 +435,7 @@ The following properties are not implemented in node-fetch at this moment: *(spec-compliant)* -- `body` A string or [Readable stream][node-readable] +- `body` A `String` or [`Readable` stream][node-readable] - `options` A [`ResponseInit`][response-init] options dictionary Constructs a new `Response` object. The constructor is identical to that in the [browser](https://developer.mozilla.org/en-US/docs/Web/API/Response/Response). @@ -462,7 +465,7 @@ This class allows manipulating and iterating over a set of HTTP headers. All met - `init` Optional argument to pre-fill the `Headers` object -Construct a new `Headers` object. `init` can be either `null`, a `Headers` object, an key-value map object, or any iterable object. +Construct a new `Headers` object. `init` can be either `null`, a `Headers` object, an key-value map object or any iterable object. ```js // Example adapted from https://fetch.spec.whatwg.org/#example-headers-class @@ -503,7 +506,7 @@ The following methods are not yet implemented in node-fetch at this moment: * Node.js [`Readable` stream][node-readable] -The data encapsulated in the `Body` object. Note that while the [Fetch Standard][whatwg-fetch] requires the property to always be a WHATWG `ReadableStream`, in node-fetch it is a Node.js [`Readable` stream][node-readable]. +Data are encapsulated in the `Body` object. Note that while the [Fetch Standard][whatwg-fetch] requires the property to always be a WHATWG `ReadableStream`, in node-fetch it is a Node.js [`Readable` stream][node-readable]. #### body.bodyUsed @@ -511,7 +514,7 @@ The data encapsulated in the `Body` object. Note that while the [Fetch Standard] * `Boolean` -A boolean property for if this body has been consumed. Per spec, a consumed body cannot be used again. +A boolean property for if this body has been consumed. Per the specs, a consumed body cannot be used again. #### body.arrayBuffer() #### body.blob() @@ -538,9 +541,9 @@ Consume the body and return a promise that will resolve to a Buffer. * Returns: Promise<String> -Identical to `body.text()`, except instead of always converting to UTF-8, encoding sniffing will be performed and text converted to UTF-8, if possible. +Identical to `body.text()`, except instead of always converting to UTF-8, encoding sniffing will be performed and text converted to UTF-8 if possible. -(This API requires an optional dependency on npm package [encoding](https://www.npmjs.com/package/encoding), which you need to install manually. `webpack` users may see [a warning message](https://github.com/bitinn/node-fetch/issues/412#issuecomment-379007792) due to this optional dependency.) +(This API requires an optional dependency of the npm package [encoding](https://www.npmjs.com/package/encoding), which you need to install manually. `webpack` users may see [a warning message](https://github.com/bitinn/node-fetch/issues/412#issuecomment-379007792) due to this optional dependency.) ### Class: FetchError @@ -574,6 +577,10 @@ MIT [codecov-url]: https://codecov.io/gh/bitinn/node-fetch [install-size-image]: https://flat.badgen.net/packagephobia/install/node-fetch [install-size-url]: https://packagephobia.now.sh/result?p=node-fetch +[discord-image]: https://img.shields.io/discord/619915844268326952?color=%237289DA&label=Discord&style=flat-square +[discord-url]: https://discord.gg/Zxbndcm +[opencollective-image]: https://opencollective.com/node-fetch/backers.svg +[opencollective-url]: https://opencollective.com/node-fetch [whatwg-fetch]: https://fetch.spec.whatwg.org/ [response-init]: https://fetch.spec.whatwg.org/#responseinit [node-readable]: https://nodejs.org/api/stream.html#stream_readable_streams diff --git a/node_modules/node-fetch/browser.js b/node_modules/node-fetch/browser.js index 0ad5de0..83c54c5 100644 --- a/node_modules/node-fetch/browser.js +++ b/node_modules/node-fetch/browser.js @@ -16,7 +16,9 @@ var global = getGlobal(); module.exports = exports = global.fetch; // Needed for TypeScript and Webpack. -exports.default = global.fetch.bind(global); +if (global.fetch) { + exports.default = global.fetch.bind(global); +} exports.Headers = global.Headers; exports.Request = global.Request; diff --git a/node_modules/node-fetch/lib/index.es.js b/node_modules/node-fetch/lib/index.es.js index 37d022c..61906c9 100644 --- a/node_modules/node-fetch/lib/index.es.js +++ b/node_modules/node-fetch/lib/index.es.js @@ -461,6 +461,12 @@ function convertBody(buffer, headers) { // html4 if (!res && str) { res = / { - opts = Object.assign({ - cwd: process.cwd(), - path: process.env[pathKey()] - }, opts); - - let prev; - let pth = path.resolve(opts.cwd); - const ret = []; - - while (prev !== pth) { - ret.push(path.join(pth, 'node_modules/.bin')); - prev = pth; - pth = path.resolve(pth, '..'); - } - - // ensure the running `node` binary is used - ret.push(path.dirname(process.execPath)); - - return ret.concat(opts.path).join(path.delimiter); -}; - -module.exports.env = opts => { - opts = Object.assign({ - env: process.env - }, opts); - - const env = Object.assign({}, opts.env); - const path = pathKey({env}); - - opts.path = env[path]; - env[path] = module.exports(opts); - - return env; -}; diff --git a/node_modules/npm-run-path/license b/node_modules/npm-run-path/license deleted file mode 100644 index 654d0bf..0000000 --- a/node_modules/npm-run-path/license +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) Sindre Sorhus (sindresorhus.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/node_modules/npm-run-path/package.json b/node_modules/npm-run-path/package.json deleted file mode 100644 index 0bae9e9..0000000 --- a/node_modules/npm-run-path/package.json +++ /dev/null @@ -1,81 +0,0 @@ -{ - "_args": [ - [ - "npm-run-path@2.0.2", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "npm-run-path@2.0.2", - "_id": "npm-run-path@2.0.2", - "_inBundle": false, - "_integrity": "sha1-NakjLfo11wZ7TLLd8jV7GHFTbF8=", - "_location": "/npm-run-path", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "npm-run-path@2.0.2", - "name": "npm-run-path", - "escapedName": "npm-run-path", - "rawSpec": "2.0.2", - "saveSpec": null, - "fetchSpec": "2.0.2" - }, - "_requiredBy": [ - "/execa" - ], - "_resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-2.0.2.tgz", - "_spec": "2.0.2", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Sindre Sorhus", - "email": "sindresorhus@gmail.com", - "url": "sindresorhus.com" - }, - "bugs": { - "url": "https://github.com/sindresorhus/npm-run-path/issues" - }, - "dependencies": { - "path-key": "^2.0.0" - }, - "description": "Get your PATH prepended with locally installed binaries", - "devDependencies": { - "ava": "*", - "xo": "*" - }, - "engines": { - "node": ">=4" - }, - "files": [ - "index.js" - ], - "homepage": "https://github.com/sindresorhus/npm-run-path#readme", - "keywords": [ - "npm", - "run", - "path", - "package", - "bin", - "binary", - "binaries", - "script", - "cli", - "command-line", - "execute", - "executable" - ], - "license": "MIT", - "name": "npm-run-path", - "repository": { - "type": "git", - "url": "git+https://github.com/sindresorhus/npm-run-path.git" - }, - "scripts": { - "test": "xo && ava" - }, - "version": "2.0.2", - "xo": { - "esnext": true - } -} diff --git a/node_modules/npm-run-path/readme.md b/node_modules/npm-run-path/readme.md deleted file mode 100644 index 4ff4722..0000000 --- a/node_modules/npm-run-path/readme.md +++ /dev/null @@ -1,81 +0,0 @@ -# npm-run-path [![Build Status](https://travis-ci.org/sindresorhus/npm-run-path.svg?branch=master)](https://travis-ci.org/sindresorhus/npm-run-path) - -> Get your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) prepended with locally installed binaries - -In [npm run scripts](https://docs.npmjs.com/cli/run-script) you can execute locally installed binaries by name. This enables the same outside npm. - - -## Install - -``` -$ npm install --save npm-run-path -``` - - -## Usage - -```js -const childProcess = require('child_process'); -const npmRunPath = require('npm-run-path'); - -console.log(process.env.PATH); -//=> '/usr/local/bin' - -console.log(npmRunPath()); -//=> '/Users/sindresorhus/dev/foo/node_modules/.bin:/Users/sindresorhus/dev/node_modules/.bin:/Users/sindresorhus/node_modules/.bin:/Users/node_modules/.bin:/node_modules/.bin:/usr/local/bin' - -// `foo` is a locally installed binary -childProcess.execFileSync('foo', { - env: npmRunPath.env() -}); -``` - - -## API - -### npmRunPath([options]) - -#### options - -##### cwd - -Type: `string`
-Default: `process.cwd()` - -Working directory. - -##### path - -Type: `string`
-Default: [`PATH`](https://github.com/sindresorhus/path-key) - -PATH to be appended.
-Set it to an empty string to exclude the default PATH. - -### npmRunPath.env([options]) - -#### options - -##### cwd - -Type: `string`
-Default: `process.cwd()` - -Working directory. - -##### env - -Type: `Object` - -Accepts an object of environment variables, like `process.env`, and modifies the PATH using the correct [PATH key](https://github.com/sindresorhus/path-key). Use this if you're modifying the PATH for use in the `child_process` options. - - -## Related - -- [npm-run-path-cli](https://github.com/sindresorhus/npm-run-path-cli) - CLI for this module -- [execa](https://github.com/sindresorhus/execa) - Execute a locally installed binary - - -## License - -MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/octokit-pagination-methods/.travis.yml b/node_modules/octokit-pagination-methods/.travis.yml deleted file mode 100644 index 7241e46..0000000 --- a/node_modules/octokit-pagination-methods/.travis.yml +++ /dev/null @@ -1,36 +0,0 @@ -language: node_js -cache: - directories: - - ~/.npm - -# Trigger a push build on master and greenkeeper branches + PRs build on every branches -# Avoid double build on PRs (See https://github.com/travis-ci/travis-ci/issues/1147) -branches: - only: - - master - - /^greenkeeper.*$/ - -branches: - except: - - /^v\d+\.\d+\.\d+$/ - -jobs: - include: - - stage: test - node_js: 6 - - node_js: 8 - install: npm ci - - node_js: 10 - install: npm ci - - node_js: lts/* - script: npm run coverage:upload - - stage: release - env: semantic-release - node_js: lts/* - install: npm ci - script: npm run semantic-release - -stages: - - test - - name: release - if: branch = master AND type IN (push) diff --git a/node_modules/octokit-pagination-methods/CODE_OF_CONDUCT.md b/node_modules/octokit-pagination-methods/CODE_OF_CONDUCT.md deleted file mode 100644 index 8124607..0000000 --- a/node_modules/octokit-pagination-methods/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,46 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at opensource+octokit@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ diff --git a/node_modules/octokit-pagination-methods/LICENSE b/node_modules/octokit-pagination-methods/LICENSE deleted file mode 100644 index 4c0d268..0000000 --- a/node_modules/octokit-pagination-methods/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -The MIT License - -Copyright (c) 2012 Cloud9 IDE, Inc. (Mike de Boer) -Copyright (c) 2017-2018 Octokit contributors - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/node_modules/octokit-pagination-methods/README.md b/node_modules/octokit-pagination-methods/README.md deleted file mode 100644 index 0dd6341..0000000 --- a/node_modules/octokit-pagination-methods/README.md +++ /dev/null @@ -1,42 +0,0 @@ -# octokit-pagination-methods - -> Legacy Octokit pagination methods from v15 - -[![Build Status](https://travis-ci.com/gr2m/octokit-pagination-methods.svg?branch=master)](https://travis-ci.com/gr2m/octokit-pagination-methods) -[![Coverage Status](https://coveralls.io/repos/gr2m/octokit-pagination-methods/badge.svg?branch=master)](https://coveralls.io/github/gr2m/octokit-pagination-methods?branch=master) -[![Greenkeeper badge](https://badges.greenkeeper.io/gr2m/octokit-pagination-methods.svg)](https://greenkeeper.io/) - -Several pagination methods such as `octokit.hasNextPage()` and `octokit.getNextPage()` have been removed from `@octokit/request` in v16.0.0 in favor of `octokit.paginate()`. This plugin brings back the methods to ease the upgrade to v16. - -## Usage - -```js -const Octokit = require('@octokit/rest') - .plugin('octokit-pagination-methods') -const octokit = new Octokit() - -octokit.issues.getForRepo() - - .then(async response => { - // returns true/false - octokit.hasNextPage(response) - octokit.hasPreviousPage(response) - octokit.hasFirstPage(response) - octokit.hasLastPage(response) - - // fetch other pages - const nextPage = await octokit.getNextPage(response) - const previousPage = await octokit.getPreviousPage(response) - const firstPage = await octokit.getFirstPage(response) - const lastPage = await octokit.getLastPage(response) - }) -``` - -## Credit - -These methods have originally been created for `node-github` by [@mikedeboer](https://github.com/mikedeboer) -while working at Cloud9 IDE, Inc. It was adopted and renamed by GitHub in 2017. - -## LICENSE - -[MIT](LICENSE) diff --git a/node_modules/octokit-pagination-methods/index.js b/node_modules/octokit-pagination-methods/index.js deleted file mode 100644 index f7474a7..0000000 --- a/node_modules/octokit-pagination-methods/index.js +++ /dev/null @@ -1,12 +0,0 @@ -module.exports = paginationMethodsPlugin - -function paginationMethodsPlugin (octokit) { - octokit.getFirstPage = require('./lib/get-first-page').bind(null, octokit) - octokit.getLastPage = require('./lib/get-last-page').bind(null, octokit) - octokit.getNextPage = require('./lib/get-next-page').bind(null, octokit) - octokit.getPreviousPage = require('./lib/get-previous-page').bind(null, octokit) - octokit.hasFirstPage = require('./lib/has-first-page') - octokit.hasLastPage = require('./lib/has-last-page') - octokit.hasNextPage = require('./lib/has-next-page') - octokit.hasPreviousPage = require('./lib/has-previous-page') -} diff --git a/node_modules/octokit-pagination-methods/lib/deprecate.js b/node_modules/octokit-pagination-methods/lib/deprecate.js deleted file mode 100644 index c56f7ab..0000000 --- a/node_modules/octokit-pagination-methods/lib/deprecate.js +++ /dev/null @@ -1,12 +0,0 @@ -module.exports = deprecate - -const loggedMessages = {} - -function deprecate (message) { - if (loggedMessages[message]) { - return - } - - console.warn(`DEPRECATED (@octokit/rest): ${message}`) - loggedMessages[message] = 1 -} diff --git a/node_modules/octokit-pagination-methods/lib/get-first-page.js b/node_modules/octokit-pagination-methods/lib/get-first-page.js deleted file mode 100644 index 5f2dff9..0000000 --- a/node_modules/octokit-pagination-methods/lib/get-first-page.js +++ /dev/null @@ -1,7 +0,0 @@ -module.exports = getFirstPage - -const getPage = require('./get-page') - -function getFirstPage (octokit, link, headers) { - return getPage(octokit, link, 'first', headers) -} diff --git a/node_modules/octokit-pagination-methods/lib/get-last-page.js b/node_modules/octokit-pagination-methods/lib/get-last-page.js deleted file mode 100644 index 9f86246..0000000 --- a/node_modules/octokit-pagination-methods/lib/get-last-page.js +++ /dev/null @@ -1,7 +0,0 @@ -module.exports = getLastPage - -const getPage = require('./get-page') - -function getLastPage (octokit, link, headers) { - return getPage(octokit, link, 'last', headers) -} diff --git a/node_modules/octokit-pagination-methods/lib/get-next-page.js b/node_modules/octokit-pagination-methods/lib/get-next-page.js deleted file mode 100644 index fbd5e94..0000000 --- a/node_modules/octokit-pagination-methods/lib/get-next-page.js +++ /dev/null @@ -1,7 +0,0 @@ -module.exports = getNextPage - -const getPage = require('./get-page') - -function getNextPage (octokit, link, headers) { - return getPage(octokit, link, 'next', headers) -} diff --git a/node_modules/octokit-pagination-methods/lib/get-page-links.js b/node_modules/octokit-pagination-methods/lib/get-page-links.js deleted file mode 100644 index 585eadb..0000000 --- a/node_modules/octokit-pagination-methods/lib/get-page-links.js +++ /dev/null @@ -1,15 +0,0 @@ -module.exports = getPageLinks - -function getPageLinks (link) { - link = link.link || link.headers.link || '' - - const links = {} - - // link format: - // '; rel="next", ; rel="last"' - link.replace(/<([^>]*)>;\s*rel="([\w]*)"/g, (m, uri, type) => { - links[type] = uri - }) - - return links -} diff --git a/node_modules/octokit-pagination-methods/lib/get-page.js b/node_modules/octokit-pagination-methods/lib/get-page.js deleted file mode 100644 index d60fe73..0000000 --- a/node_modules/octokit-pagination-methods/lib/get-page.js +++ /dev/null @@ -1,38 +0,0 @@ -module.exports = getPage - -const deprecate = require('./deprecate') -const getPageLinks = require('./get-page-links') -const HttpError = require('./http-error') - -function getPage (octokit, link, which, headers) { - deprecate(`octokit.get${which.charAt(0).toUpperCase() + which.slice(1)}Page() – You can use octokit.paginate or async iterators instead: https://github.com/octokit/rest.js#pagination.`) - const url = getPageLinks(link)[which] - - if (!url) { - const urlError = new HttpError(`No ${which} page found`, 404) - return Promise.reject(urlError) - } - - const requestOptions = { - url, - headers: applyAcceptHeader(link, headers) - } - - const promise = octokit.request(requestOptions) - - return promise -} - -function applyAcceptHeader (res, headers) { - const previous = res.headers && res.headers['x-github-media-type'] - - if (!previous || (headers && headers.accept)) { - return headers - } - headers = headers || {} - headers.accept = 'application/vnd.' + previous - .replace('; param=', '.') - .replace('; format=', '+') - - return headers -} diff --git a/node_modules/octokit-pagination-methods/lib/get-previous-page.js b/node_modules/octokit-pagination-methods/lib/get-previous-page.js deleted file mode 100644 index 0477eeb..0000000 --- a/node_modules/octokit-pagination-methods/lib/get-previous-page.js +++ /dev/null @@ -1,7 +0,0 @@ -module.exports = getPreviousPage - -const getPage = require('./get-page') - -function getPreviousPage (octokit, link, headers) { - return getPage(octokit, link, 'prev', headers) -} diff --git a/node_modules/octokit-pagination-methods/lib/has-first-page.js b/node_modules/octokit-pagination-methods/lib/has-first-page.js deleted file mode 100644 index 3814b1f..0000000 --- a/node_modules/octokit-pagination-methods/lib/has-first-page.js +++ /dev/null @@ -1,9 +0,0 @@ -module.exports = hasFirstPage - -const deprecate = require('./deprecate') -const getPageLinks = require('./get-page-links') - -function hasFirstPage (link) { - deprecate(`octokit.hasFirstPage() – You can use octokit.paginate or async iterators instead: https://github.com/octokit/rest.js#pagination.`) - return getPageLinks(link).first -} diff --git a/node_modules/octokit-pagination-methods/lib/has-last-page.js b/node_modules/octokit-pagination-methods/lib/has-last-page.js deleted file mode 100644 index 10c12e3..0000000 --- a/node_modules/octokit-pagination-methods/lib/has-last-page.js +++ /dev/null @@ -1,9 +0,0 @@ -module.exports = hasLastPage - -const deprecate = require('./deprecate') -const getPageLinks = require('./get-page-links') - -function hasLastPage (link) { - deprecate(`octokit.hasLastPage() – You can use octokit.paginate or async iterators instead: https://github.com/octokit/rest.js#pagination.`) - return getPageLinks(link).last -} diff --git a/node_modules/octokit-pagination-methods/lib/has-next-page.js b/node_modules/octokit-pagination-methods/lib/has-next-page.js deleted file mode 100644 index 1015ccd..0000000 --- a/node_modules/octokit-pagination-methods/lib/has-next-page.js +++ /dev/null @@ -1,9 +0,0 @@ -module.exports = hasNextPage - -const deprecate = require('./deprecate') -const getPageLinks = require('./get-page-links') - -function hasNextPage (link) { - deprecate(`octokit.hasNextPage() – You can use octokit.paginate or async iterators instead: https://github.com/octokit/rest.js#pagination.`) - return getPageLinks(link).next -} diff --git a/node_modules/octokit-pagination-methods/lib/has-previous-page.js b/node_modules/octokit-pagination-methods/lib/has-previous-page.js deleted file mode 100644 index 49e0926..0000000 --- a/node_modules/octokit-pagination-methods/lib/has-previous-page.js +++ /dev/null @@ -1,9 +0,0 @@ -module.exports = hasPreviousPage - -const deprecate = require('./deprecate') -const getPageLinks = require('./get-page-links') - -function hasPreviousPage (link) { - deprecate(`octokit.hasPreviousPage() – You can use octokit.paginate or async iterators instead: https://github.com/octokit/rest.js#pagination.`) - return getPageLinks(link).prev -} diff --git a/node_modules/octokit-pagination-methods/lib/http-error.js b/node_modules/octokit-pagination-methods/lib/http-error.js deleted file mode 100644 index 8eb9f2f..0000000 --- a/node_modules/octokit-pagination-methods/lib/http-error.js +++ /dev/null @@ -1,15 +0,0 @@ -module.exports = class HttpError extends Error { - constructor (message, code, headers) { - super(message) - - // Maintains proper stack trace (only available on V8) - /* istanbul ignore next */ - if (Error.captureStackTrace) { - Error.captureStackTrace(this, this.constructor) - } - - this.name = 'HttpError' - this.code = code - this.headers = headers - } -} diff --git a/node_modules/octokit-pagination-methods/package.json b/node_modules/octokit-pagination-methods/package.json deleted file mode 100644 index cb85926..0000000 --- a/node_modules/octokit-pagination-methods/package.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "_from": "octokit-pagination-methods@^1.1.0", - "_id": "octokit-pagination-methods@1.1.0", - "_inBundle": false, - "_integrity": "sha512-fZ4qZdQ2nxJvtcasX7Ghl+WlWS/d9IgnBIwFZXVNNZUmzpno91SX5bc5vuxiuKoCtK78XxGGNuSCrDC7xYB3OQ==", - "_location": "/octokit-pagination-methods", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "octokit-pagination-methods@^1.1.0", - "name": "octokit-pagination-methods", - "escapedName": "octokit-pagination-methods", - "rawSpec": "^1.1.0", - "saveSpec": null, - "fetchSpec": "^1.1.0" - }, - "_requiredBy": [ - "/@octokit/rest" - ], - "_resolved": "https://registry.npmjs.org/octokit-pagination-methods/-/octokit-pagination-methods-1.1.0.tgz", - "_shasum": "cf472edc9d551055f9ef73f6e42b4dbb4c80bea4", - "_spec": "octokit-pagination-methods@^1.1.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/rest", - "author": { - "name": "Gregor Martynus", - "url": "https://github.com/gr2m" - }, - "bugs": { - "url": "https://github.com/gr2m/octokit-pagination-methods/issues" - }, - "bundleDependencies": false, - "dependencies": {}, - "deprecated": false, - "description": "Legacy Octokit pagination methods from v15", - "devDependencies": { - "@octokit/rest": "github:octokit/rest.js#next", - "coveralls": "^3.0.2", - "nock": "^10.0.2", - "semantic-release": "^15.10.8", - "simple-mock": "^0.8.0", - "standard": "^12.0.1", - "standard-markdown": "^5.0.1", - "tap": "^12.0.1" - }, - "directories": { - "test": "test" - }, - "homepage": "https://github.com/gr2m/octokit-pagination-methods#readme", - "keywords": [ - "octokit", - "github", - "api", - "rest", - "plugin" - ], - "license": "MIT", - "main": "index.js", - "name": "octokit-pagination-methods", - "publishConfig": { - "access": "public", - "tag": "latest" - }, - "repository": { - "type": "git", - "url": "git+https://github.com/gr2m/octokit-pagination-methods.git" - }, - "scripts": { - "coverage": "tap --coverage-report=html", - "coverage:upload": "npm run test && tap --coverage-report=text-lcov | coveralls", - "pretest": "standard && standard-markdown *.md", - "semantic-release": "semantic-release", - "test": "tap --coverage test.js" - }, - "version": "1.1.0" -} diff --git a/node_modules/octokit-pagination-methods/test.js b/node_modules/octokit-pagination-methods/test.js deleted file mode 100644 index d16f4a2..0000000 --- a/node_modules/octokit-pagination-methods/test.js +++ /dev/null @@ -1,93 +0,0 @@ -const test = require('tap').test -const nock = require('nock') - -const Octokit = require('@octokit/rest') - .plugin(require('.')) - -test('@octokit/pagination-methods', (t) => { - nock('https://api.github.com', { - reqheaders: { - authorization: 'token secrettoken123' - } - }) - .get('/organizations') - .query({ page: 3, per_page: 1 }) - .reply(200, [{}], { - 'Link': '; rel="next", ; rel="first", ; rel="prev"', - 'X-GitHub-Media-Type': 'octokit.v3; format=json' - }) - .get('/organizations') - .query({ page: 1, per_page: 1 }) - .reply(200, [{}]) - .get('/organizations') - .query({ page: 2, per_page: 1 }) - .reply(200, [{}]) - .get('/organizations') - .query({ page: 4, per_page: 1 }) - .reply(404, {}) - - const octokit = new Octokit() - - octokit.authenticate({ - type: 'token', - token: 'secrettoken123' - }) - - return octokit.orgs.getAll({ - page: 3, - per_page: 1 - }) - - .then((response) => { - t.ok(octokit.hasNextPage(response)) - t.ok(octokit.hasPreviousPage(response)) - t.ok(octokit.hasFirstPage(response)) - t.notOk(octokit.hasLastPage(response)) - - const noop = () => {} - - return Promise.all([ - octokit.getFirstPage(response) - .then(response => { - t.doesNotThrow(() => { - octokit.hasPreviousPage(response) - }) - t.notOk(octokit.hasPreviousPage(response)) - }), - octokit.getPreviousPage(response, { foo: 'bar', accept: 'application/vnd.octokit.v3+json' }), - octokit.getNextPage(response).catch(noop), - octokit.getLastPage(response, { foo: 'bar' }) - .catch(error => { - t.equals(error.code, 404) - }), - // test error with promise - octokit.getLastPage(response).catch(noop) - ]) - }) - - .catch(t.error) -}) - -test('carries accept header correctly', () => { - nock('https://api.github.com', { - reqheaders: { - accept: 'application/vnd.github.hellcat-preview+json' - } - }) - .get('/user/teams') - .query({ per_page: 1 }) - .reply(200, [{}], { - 'Link': '; rel="next"', - 'X-GitHub-Media-Type': 'github; param=hellcat-preview; format=json' - }) - .get('/user/teams') - .query({ page: 2, per_page: 1 }) - .reply(200, []) - - const octokit = new Octokit() - - return octokit.users.getTeams({ per_page: 1 }) - .then(response => { - return octokit.getNextPage(response) - }) -}) diff --git a/node_modules/once/package.json b/node_modules/once/package.json index 2d7e871..d7f16e2 100644 --- a/node_modules/once/package.json +++ b/node_modules/once/package.json @@ -2,10 +2,9 @@ "_args": [ [ "once@1.4.0", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" + "." ] ], - "_development": true, "_from": "once@1.4.0", "_id": "once@1.4.0", "_inBundle": false, @@ -23,14 +22,12 @@ "fetchSpec": "1.4.0" }, "_requiredBy": [ - "/end-of-stream", - "/glob", - "/inflight", - "/pump" + "/@octokit/request", + "/@octokit/request-error" ], "_resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", "_spec": "1.4.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", + "_where": ".", "author": { "name": "Isaac Z. Schlueter", "email": "i@izs.me", diff --git a/node_modules/os-name/index.d.ts b/node_modules/os-name/index.d.ts deleted file mode 100644 index b1246ac..0000000 --- a/node_modules/os-name/index.d.ts +++ /dev/null @@ -1,37 +0,0 @@ -/// - -/** -Get the name of the current operating system. - -By default, the name of the current operating system is returned. - -@param platform - Custom platform name. -@param release - Custom release name. - -@example -``` -import * as os fron 'os'; -import osName = require('os-name'); - -// On a macOS Sierra system - -osName(); -//=> 'macOS Sierra' - -osName(os.platform(), os.release()); -//=> 'macOS Sierra' - -osName('darwin', '14.0.0'); -//=> 'OS X Yosemite' - -osName('linux', '3.13.0-24-generic'); -//=> 'Linux 3.13' - -osName('win32', '6.3.9600'); -//=> 'Windows 8.1' -``` -*/ -declare function osName(): string; -declare function osName(platform: NodeJS.Platform, release: string): string; - -export = osName; diff --git a/node_modules/os-name/index.js b/node_modules/os-name/index.js deleted file mode 100644 index f1287d5..0000000 --- a/node_modules/os-name/index.js +++ /dev/null @@ -1,46 +0,0 @@ -'use strict'; -const os = require('os'); -const macosRelease = require('macos-release'); -const winRelease = require('windows-release'); - -const osName = (platform, release) => { - if (!platform && release) { - throw new Error('You can\'t specify a `release` without specifying `platform`'); - } - - platform = platform || os.platform(); - - let id; - - if (platform === 'darwin') { - if (!release && os.platform() === 'darwin') { - release = os.release(); - } - - const prefix = release ? (Number(release.split('.')[0]) > 15 ? 'macOS' : 'OS X') : 'macOS'; - id = release ? macosRelease(release).name : ''; - return prefix + (id ? ' ' + id : ''); - } - - if (platform === 'linux') { - if (!release && os.platform() === 'linux') { - release = os.release(); - } - - id = release ? release.replace(/^(\d+\.\d+).*/, '$1') : ''; - return 'Linux' + (id ? ' ' + id : ''); - } - - if (platform === 'win32') { - if (!release && os.platform() === 'win32') { - release = os.release(); - } - - id = release ? winRelease(release) : ''; - return 'Windows' + (id ? ' ' + id : ''); - } - - return platform; -}; - -module.exports = osName; diff --git a/node_modules/os-name/package.json b/node_modules/os-name/package.json deleted file mode 100644 index d2cbe3d..0000000 --- a/node_modules/os-name/package.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "_from": "os-name@^3.1.0", - "_id": "os-name@3.1.0", - "_inBundle": false, - "_integrity": "sha512-h8L+8aNjNcMpo/mAIBPn5PXCM16iyPGjHNWo6U1YO8sJTMHtEtyczI6QJnLoplswm6goopQkqc7OAnjhWcugVg==", - "_location": "/os-name", - "_phantomChildren": {}, - "_requested": { - "type": "range", - "registry": true, - "raw": "os-name@^3.1.0", - "name": "os-name", - "escapedName": "os-name", - "rawSpec": "^3.1.0", - "saveSpec": null, - "fetchSpec": "^3.1.0" - }, - "_requiredBy": [ - "/@octokit/endpoint/universal-user-agent", - "/@octokit/request/universal-user-agent", - "/@octokit/rest/universal-user-agent", - "/universal-user-agent" - ], - "_resolved": "https://registry.npmjs.org/os-name/-/os-name-3.1.0.tgz", - "_shasum": "dec19d966296e1cd62d701a5a66ee1ddeae70801", - "_spec": "os-name@^3.1.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment/node_modules/@octokit/endpoint/node_modules/universal-user-agent", - "author": { - "name": "Sindre Sorhus", - "email": "sindresorhus@gmail.com", - "url": "sindresorhus.com" - }, - "bugs": { - "url": "https://github.com/sindresorhus/os-name/issues" - }, - "bundleDependencies": false, - "dependencies": { - "macos-release": "^2.2.0", - "windows-release": "^3.1.0" - }, - "deprecated": false, - "description": "Get the name of the current operating system. Example: macOS Sierra", - "devDependencies": { - "@types/node": "^11.13.0", - "ava": "^1.4.1", - "tsd": "^0.7.2", - "xo": "^0.24.0" - }, - "engines": { - "node": ">=6" - }, - "files": [ - "index.js", - "index.d.ts" - ], - "homepage": "https://github.com/sindresorhus/os-name#readme", - "keywords": [ - "os", - "operating", - "system", - "platform", - "name", - "title", - "release", - "version", - "macos", - "windows", - "linux" - ], - "license": "MIT", - "name": "os-name", - "repository": { - "type": "git", - "url": "git+https://github.com/sindresorhus/os-name.git" - }, - "scripts": { - "test": "xo && ava && tsd" - }, - "version": "3.1.0" -} diff --git a/node_modules/os-name/readme.md b/node_modules/os-name/readme.md deleted file mode 100644 index 35812b2..0000000 --- a/node_modules/os-name/readme.md +++ /dev/null @@ -1,64 +0,0 @@ -# os-name [![Build Status](https://travis-ci.org/sindresorhus/os-name.svg?branch=master)](https://travis-ci.org/sindresorhus/os-name) - -> Get the name of the current operating system
-> Example: `macOS Sierra` - -Useful for analytics and debugging. - - -## Install - -``` -$ npm install os-name -``` - - -## Usage - -```js -const os = require('os'); -const osName = require('os-name'); - -// On a macOS Sierra system - -osName(); -//=> 'macOS Sierra' - -osName(os.platform(), os.release()); -//=> 'macOS Sierra' - -osName('darwin', '14.0.0'); -//=> 'OS X Yosemite' - -osName('linux', '3.13.0-24-generic'); -//=> 'Linux 3.13' - -osName('win32', '6.3.9600'); -//=> 'Windows 8.1' -``` - - -## API - -### osName([platform, release]) - -By default, the name of the current operating system is returned. - -You can optionally supply a custom [`os.platform()`](https://nodejs.org/api/os.html#os_os_platform) and [`os.release()`](https://nodejs.org/api/os.html#os_os_release). - -Check out [`getos`](https://github.com/wblankenship/getos) if you need the Linux distribution name. - - -## Contributing - -Production systems depend on this package for logging / tracking. Please be careful when introducing new output, and adhere to existing output format (whitespace, capitalization, etc.). - - -## Related - -- [os-name-cli](https://github.com/sindresorhus/os-name-cli) - CLI for this module - - -## License - -MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/p-finally/index.js b/node_modules/p-finally/index.js deleted file mode 100644 index 52b7b49..0000000 --- a/node_modules/p-finally/index.js +++ /dev/null @@ -1,15 +0,0 @@ -'use strict'; -module.exports = (promise, onFinally) => { - onFinally = onFinally || (() => {}); - - return promise.then( - val => new Promise(resolve => { - resolve(onFinally()); - }).then(() => val), - err => new Promise(resolve => { - resolve(onFinally()); - }).then(() => { - throw err; - }) - ); -}; diff --git a/node_modules/p-finally/license b/node_modules/p-finally/license deleted file mode 100644 index 654d0bf..0000000 --- a/node_modules/p-finally/license +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) Sindre Sorhus (sindresorhus.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/node_modules/p-finally/package.json b/node_modules/p-finally/package.json deleted file mode 100644 index bdff36d..0000000 --- a/node_modules/p-finally/package.json +++ /dev/null @@ -1,78 +0,0 @@ -{ - "_args": [ - [ - "p-finally@1.0.0", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "p-finally@1.0.0", - "_id": "p-finally@1.0.0", - "_inBundle": false, - "_integrity": "sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4=", - "_location": "/p-finally", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "p-finally@1.0.0", - "name": "p-finally", - "escapedName": "p-finally", - "rawSpec": "1.0.0", - "saveSpec": null, - "fetchSpec": "1.0.0" - }, - "_requiredBy": [ - "/execa" - ], - "_resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", - "_spec": "1.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Sindre Sorhus", - "email": "sindresorhus@gmail.com", - "url": "sindresorhus.com" - }, - "bugs": { - "url": "https://github.com/sindresorhus/p-finally/issues" - }, - "description": "`Promise#finally()` ponyfill - Invoked when the promise is settled regardless of outcome", - "devDependencies": { - "ava": "*", - "xo": "*" - }, - "engines": { - "node": ">=4" - }, - "files": [ - "index.js" - ], - "homepage": "https://github.com/sindresorhus/p-finally#readme", - "keywords": [ - "promise", - "finally", - "handler", - "function", - "async", - "await", - "promises", - "settled", - "ponyfill", - "polyfill", - "shim", - "bluebird" - ], - "license": "MIT", - "name": "p-finally", - "repository": { - "type": "git", - "url": "git+https://github.com/sindresorhus/p-finally.git" - }, - "scripts": { - "test": "xo && ava" - }, - "version": "1.0.0", - "xo": { - "esnext": true - } -} diff --git a/node_modules/p-finally/readme.md b/node_modules/p-finally/readme.md deleted file mode 100644 index 09ef364..0000000 --- a/node_modules/p-finally/readme.md +++ /dev/null @@ -1,47 +0,0 @@ -# p-finally [![Build Status](https://travis-ci.org/sindresorhus/p-finally.svg?branch=master)](https://travis-ci.org/sindresorhus/p-finally) - -> [`Promise#finally()`](https://github.com/tc39/proposal-promise-finally) [ponyfill](https://ponyfill.com) - Invoked when the promise is settled regardless of outcome - -Useful for cleanup. - - -## Install - -``` -$ npm install --save p-finally -``` - - -## Usage - -```js -const pFinally = require('p-finally'); - -const dir = createTempDir(); - -pFinally(write(dir), () => cleanup(dir)); -``` - - -## API - -### pFinally(promise, [onFinally]) - -Returns a `Promise`. - -#### onFinally - -Type: `Function` - -Note: Throwing or returning a rejected promise will reject `promise` with the rejection reason. - - -## Related - -- [p-try](https://github.com/sindresorhus/p-try) - `Promise#try()` ponyfill - Starts a promise chain -- [More…](https://github.com/sindresorhus/promise-fun) - - -## License - -MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/path-key/index.js b/node_modules/path-key/index.js deleted file mode 100644 index 62c8250..0000000 --- a/node_modules/path-key/index.js +++ /dev/null @@ -1,13 +0,0 @@ -'use strict'; -module.exports = opts => { - opts = opts || {}; - - const env = opts.env || process.env; - const platform = opts.platform || process.platform; - - if (platform !== 'win32') { - return 'PATH'; - } - - return Object.keys(env).find(x => x.toUpperCase() === 'PATH') || 'Path'; -}; diff --git a/node_modules/path-key/license b/node_modules/path-key/license deleted file mode 100644 index 654d0bf..0000000 --- a/node_modules/path-key/license +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) Sindre Sorhus (sindresorhus.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/node_modules/path-key/package.json b/node_modules/path-key/package.json deleted file mode 100644 index bc9e195..0000000 --- a/node_modules/path-key/package.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "_args": [ - [ - "path-key@2.0.1", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "path-key@2.0.1", - "_id": "path-key@2.0.1", - "_inBundle": false, - "_integrity": "sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A=", - "_location": "/path-key", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "path-key@2.0.1", - "name": "path-key", - "escapedName": "path-key", - "rawSpec": "2.0.1", - "saveSpec": null, - "fetchSpec": "2.0.1" - }, - "_requiredBy": [ - "/cross-spawn", - "/npm-run-path" - ], - "_resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz", - "_spec": "2.0.1", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Sindre Sorhus", - "email": "sindresorhus@gmail.com", - "url": "sindresorhus.com" - }, - "bugs": { - "url": "https://github.com/sindresorhus/path-key/issues" - }, - "description": "Get the PATH environment variable key cross-platform", - "devDependencies": { - "ava": "*", - "xo": "*" - }, - "engines": { - "node": ">=4" - }, - "files": [ - "index.js" - ], - "homepage": "https://github.com/sindresorhus/path-key#readme", - "keywords": [ - "path", - "key", - "environment", - "env", - "variable", - "var", - "get", - "cross-platform", - "windows" - ], - "license": "MIT", - "name": "path-key", - "repository": { - "type": "git", - "url": "git+https://github.com/sindresorhus/path-key.git" - }, - "scripts": { - "test": "xo && ava" - }, - "version": "2.0.1", - "xo": { - "esnext": true - } -} diff --git a/node_modules/path-key/readme.md b/node_modules/path-key/readme.md deleted file mode 100644 index cb5710a..0000000 --- a/node_modules/path-key/readme.md +++ /dev/null @@ -1,51 +0,0 @@ -# path-key [![Build Status](https://travis-ci.org/sindresorhus/path-key.svg?branch=master)](https://travis-ci.org/sindresorhus/path-key) - -> Get the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable key cross-platform - -It's usually `PATH`, but on Windows it can be any casing like `Path`... - - -## Install - -``` -$ npm install --save path-key -``` - - -## Usage - -```js -const pathKey = require('path-key'); - -const key = pathKey(); -//=> 'PATH' - -const PATH = process.env[key]; -//=> '/usr/local/bin:/usr/bin:/bin' -``` - - -## API - -### pathKey([options]) - -#### options - -##### env - -Type: `Object`
-Default: [`process.env`](https://nodejs.org/api/process.html#process_process_env) - -Use a custom environment variables object. - -#### platform - -Type: `string`
-Default: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform) - -Get the PATH key for a specific platform. - - -## License - -MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/pump/.travis.yml b/node_modules/pump/.travis.yml deleted file mode 100644 index 17f9433..0000000 --- a/node_modules/pump/.travis.yml +++ /dev/null @@ -1,5 +0,0 @@ -language: node_js -node_js: - - "0.10" - -script: "npm test" diff --git a/node_modules/pump/README.md b/node_modules/pump/README.md deleted file mode 100644 index 4c81471..0000000 --- a/node_modules/pump/README.md +++ /dev/null @@ -1,65 +0,0 @@ -# pump - -pump is a small node module that pipes streams together and destroys all of them if one of them closes. - -``` -npm install pump -``` - -[![build status](http://img.shields.io/travis/mafintosh/pump.svg?style=flat)](http://travis-ci.org/mafintosh/pump) - -## What problem does it solve? - -When using standard `source.pipe(dest)` source will _not_ be destroyed if dest emits close or an error. -You are also not able to provide a callback to tell when then pipe has finished. - -pump does these two things for you - -## Usage - -Simply pass the streams you want to pipe together to pump and add an optional callback - -``` js -var pump = require('pump') -var fs = require('fs') - -var source = fs.createReadStream('/dev/random') -var dest = fs.createWriteStream('/dev/null') - -pump(source, dest, function(err) { - console.log('pipe finished', err) -}) - -setTimeout(function() { - dest.destroy() // when dest is closed pump will destroy source -}, 1000) -``` - -You can use pump to pipe more than two streams together as well - -``` js -var transform = someTransformStream() - -pump(source, transform, anotherTransform, dest, function(err) { - console.log('pipe finished', err) -}) -``` - -If `source`, `transform`, `anotherTransform` or `dest` closes all of them will be destroyed. - -Similarly to `stream.pipe()`, `pump()` returns the last stream passed in, so you can do: - -``` -return pump(s1, s2) // returns s2 -``` - -If you want to return a stream that combines *both* s1 and s2 to a single stream use -[pumpify](https://github.com/mafintosh/pumpify) instead. - -## License - -MIT - -## Related - -`pump` is part of the [mississippi stream utility collection](https://github.com/maxogden/mississippi) which includes more useful stream modules similar to this one. diff --git a/node_modules/pump/index.js b/node_modules/pump/index.js deleted file mode 100644 index c15059f..0000000 --- a/node_modules/pump/index.js +++ /dev/null @@ -1,82 +0,0 @@ -var once = require('once') -var eos = require('end-of-stream') -var fs = require('fs') // we only need fs to get the ReadStream and WriteStream prototypes - -var noop = function () {} -var ancient = /^v?\.0/.test(process.version) - -var isFn = function (fn) { - return typeof fn === 'function' -} - -var isFS = function (stream) { - if (!ancient) return false // newer node version do not need to care about fs is a special way - if (!fs) return false // browser - return (stream instanceof (fs.ReadStream || noop) || stream instanceof (fs.WriteStream || noop)) && isFn(stream.close) -} - -var isRequest = function (stream) { - return stream.setHeader && isFn(stream.abort) -} - -var destroyer = function (stream, reading, writing, callback) { - callback = once(callback) - - var closed = false - stream.on('close', function () { - closed = true - }) - - eos(stream, {readable: reading, writable: writing}, function (err) { - if (err) return callback(err) - closed = true - callback() - }) - - var destroyed = false - return function (err) { - if (closed) return - if (destroyed) return - destroyed = true - - if (isFS(stream)) return stream.close(noop) // use close for fs streams to avoid fd leaks - if (isRequest(stream)) return stream.abort() // request.destroy just do .end - .abort is what we want - - if (isFn(stream.destroy)) return stream.destroy() - - callback(err || new Error('stream was destroyed')) - } -} - -var call = function (fn) { - fn() -} - -var pipe = function (from, to) { - return from.pipe(to) -} - -var pump = function () { - var streams = Array.prototype.slice.call(arguments) - var callback = isFn(streams[streams.length - 1] || noop) && streams.pop() || noop - - if (Array.isArray(streams[0])) streams = streams[0] - if (streams.length < 2) throw new Error('pump requires two streams per minimum') - - var error - var destroys = streams.map(function (stream, i) { - var reading = i < streams.length - 1 - var writing = i > 0 - return destroyer(stream, reading, writing, function (err) { - if (!error) error = err - if (err) destroys.forEach(call) - if (reading) return - destroys.forEach(call) - callback(error) - }) - }) - - return streams.reduce(pipe) -} - -module.exports = pump diff --git a/node_modules/pump/package.json b/node_modules/pump/package.json deleted file mode 100644 index aaebf8f..0000000 --- a/node_modules/pump/package.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "_args": [ - [ - "pump@3.0.0", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "pump@3.0.0", - "_id": "pump@3.0.0", - "_inBundle": false, - "_integrity": "sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==", - "_location": "/pump", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "pump@3.0.0", - "name": "pump", - "escapedName": "pump", - "rawSpec": "3.0.0", - "saveSpec": null, - "fetchSpec": "3.0.0" - }, - "_requiredBy": [ - "/get-stream" - ], - "_resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz", - "_spec": "3.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Mathias Buus Madsen", - "email": "mathiasbuus@gmail.com" - }, - "browser": { - "fs": false - }, - "bugs": { - "url": "https://github.com/mafintosh/pump/issues" - }, - "dependencies": { - "end-of-stream": "^1.1.0", - "once": "^1.3.1" - }, - "description": "pipe streams together and close all of them if one of them closes", - "homepage": "https://github.com/mafintosh/pump#readme", - "keywords": [ - "streams", - "pipe", - "destroy", - "callback" - ], - "license": "MIT", - "name": "pump", - "repository": { - "type": "git", - "url": "git://github.com/mafintosh/pump.git" - }, - "scripts": { - "test": "node test-browser.js && node test-node.js" - }, - "version": "3.0.0" -} diff --git a/node_modules/pump/test-browser.js b/node_modules/pump/test-browser.js deleted file mode 100644 index 9a06c8a..0000000 --- a/node_modules/pump/test-browser.js +++ /dev/null @@ -1,66 +0,0 @@ -var stream = require('stream') -var pump = require('./index') - -var rs = new stream.Readable() -var ws = new stream.Writable() - -rs._read = function (size) { - this.push(Buffer(size).fill('abc')) -} - -ws._write = function (chunk, encoding, cb) { - setTimeout(function () { - cb() - }, 100) -} - -var toHex = function () { - var reverse = new (require('stream').Transform)() - - reverse._transform = function (chunk, enc, callback) { - reverse.push(chunk.toString('hex')) - callback() - } - - return reverse -} - -var wsClosed = false -var rsClosed = false -var callbackCalled = false - -var check = function () { - if (wsClosed && rsClosed && callbackCalled) { - console.log('test-browser.js passes') - clearTimeout(timeout) - } -} - -ws.on('finish', function () { - wsClosed = true - check() -}) - -rs.on('end', function () { - rsClosed = true - check() -}) - -var res = pump(rs, toHex(), toHex(), toHex(), ws, function () { - callbackCalled = true - check() -}) - -if (res !== ws) { - throw new Error('should return last stream') -} - -setTimeout(function () { - rs.push(null) - rs.emit('close') -}, 1000) - -var timeout = setTimeout(function () { - check() - throw new Error('timeout') -}, 5000) diff --git a/node_modules/pump/test-node.js b/node_modules/pump/test-node.js deleted file mode 100644 index 561251a..0000000 --- a/node_modules/pump/test-node.js +++ /dev/null @@ -1,53 +0,0 @@ -var pump = require('./index') - -var rs = require('fs').createReadStream('/dev/random') -var ws = require('fs').createWriteStream('/dev/null') - -var toHex = function () { - var reverse = new (require('stream').Transform)() - - reverse._transform = function (chunk, enc, callback) { - reverse.push(chunk.toString('hex')) - callback() - } - - return reverse -} - -var wsClosed = false -var rsClosed = false -var callbackCalled = false - -var check = function () { - if (wsClosed && rsClosed && callbackCalled) { - console.log('test-node.js passes') - clearTimeout(timeout) - } -} - -ws.on('close', function () { - wsClosed = true - check() -}) - -rs.on('close', function () { - rsClosed = true - check() -}) - -var res = pump(rs, toHex(), toHex(), toHex(), ws, function () { - callbackCalled = true - check() -}) - -if (res !== ws) { - throw new Error('should return last stream') -} - -setTimeout(function () { - rs.destroy() -}, 1000) - -var timeout = setTimeout(function () { - throw new Error('timeout') -}, 5000) diff --git a/node_modules/shebang-command/index.js b/node_modules/shebang-command/index.js deleted file mode 100644 index 2de70b0..0000000 --- a/node_modules/shebang-command/index.js +++ /dev/null @@ -1,19 +0,0 @@ -'use strict'; -var shebangRegex = require('shebang-regex'); - -module.exports = function (str) { - var match = str.match(shebangRegex); - - if (!match) { - return null; - } - - var arr = match[0].replace(/#! ?/, '').split(' '); - var bin = arr[0].split('/').pop(); - var arg = arr[1]; - - return (bin === 'env' ? - arg : - bin + (arg ? ' ' + arg : '') - ); -}; diff --git a/node_modules/shebang-command/license b/node_modules/shebang-command/license deleted file mode 100644 index 0f8cf79..0000000 --- a/node_modules/shebang-command/license +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) Kevin Martensson (github.com/kevva) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/node_modules/shebang-command/package.json b/node_modules/shebang-command/package.json deleted file mode 100644 index 780e88c..0000000 --- a/node_modules/shebang-command/package.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "_args": [ - [ - "shebang-command@1.2.0", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "shebang-command@1.2.0", - "_id": "shebang-command@1.2.0", - "_inBundle": false, - "_integrity": "sha1-RKrGW2lbAzmJaMOfNj/uXer98eo=", - "_location": "/shebang-command", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "shebang-command@1.2.0", - "name": "shebang-command", - "escapedName": "shebang-command", - "rawSpec": "1.2.0", - "saveSpec": null, - "fetchSpec": "1.2.0" - }, - "_requiredBy": [ - "/cross-spawn" - ], - "_resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz", - "_spec": "1.2.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Kevin Martensson", - "email": "kevinmartensson@gmail.com", - "url": "github.com/kevva" - }, - "bugs": { - "url": "https://github.com/kevva/shebang-command/issues" - }, - "dependencies": { - "shebang-regex": "^1.0.0" - }, - "description": "Get the command from a shebang", - "devDependencies": { - "ava": "*", - "xo": "*" - }, - "engines": { - "node": ">=0.10.0" - }, - "files": [ - "index.js" - ], - "homepage": "https://github.com/kevva/shebang-command#readme", - "keywords": [ - "cmd", - "command", - "parse", - "shebang" - ], - "license": "MIT", - "name": "shebang-command", - "repository": { - "type": "git", - "url": "git+https://github.com/kevva/shebang-command.git" - }, - "scripts": { - "test": "xo && ava" - }, - "version": "1.2.0", - "xo": { - "ignores": [ - "test.js" - ] - } -} diff --git a/node_modules/shebang-command/readme.md b/node_modules/shebang-command/readme.md deleted file mode 100644 index 16b0be4..0000000 --- a/node_modules/shebang-command/readme.md +++ /dev/null @@ -1,39 +0,0 @@ -# shebang-command [![Build Status](https://travis-ci.org/kevva/shebang-command.svg?branch=master)](https://travis-ci.org/kevva/shebang-command) - -> Get the command from a shebang - - -## Install - -``` -$ npm install --save shebang-command -``` - - -## Usage - -```js -const shebangCommand = require('shebang-command'); - -shebangCommand('#!/usr/bin/env node'); -//=> 'node' - -shebangCommand('#!/bin/bash'); -//=> 'bash' -``` - - -## API - -### shebangCommand(string) - -#### string - -Type: `string` - -String containing a shebang. - - -## License - -MIT © [Kevin Martensson](http://github.com/kevva) diff --git a/node_modules/shebang-regex/index.js b/node_modules/shebang-regex/index.js deleted file mode 100644 index d052d2e..0000000 --- a/node_modules/shebang-regex/index.js +++ /dev/null @@ -1,2 +0,0 @@ -'use strict'; -module.exports = /^#!.*/; diff --git a/node_modules/shebang-regex/license b/node_modules/shebang-regex/license deleted file mode 100644 index 654d0bf..0000000 --- a/node_modules/shebang-regex/license +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) Sindre Sorhus (sindresorhus.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/node_modules/shebang-regex/package.json b/node_modules/shebang-regex/package.json deleted file mode 100644 index 8dc38f3..0000000 --- a/node_modules/shebang-regex/package.json +++ /dev/null @@ -1,68 +0,0 @@ -{ - "_args": [ - [ - "shebang-regex@1.0.0", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "shebang-regex@1.0.0", - "_id": "shebang-regex@1.0.0", - "_inBundle": false, - "_integrity": "sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=", - "_location": "/shebang-regex", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "shebang-regex@1.0.0", - "name": "shebang-regex", - "escapedName": "shebang-regex", - "rawSpec": "1.0.0", - "saveSpec": null, - "fetchSpec": "1.0.0" - }, - "_requiredBy": [ - "/shebang-command" - ], - "_resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz", - "_spec": "1.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Sindre Sorhus", - "email": "sindresorhus@gmail.com", - "url": "sindresorhus.com" - }, - "bugs": { - "url": "https://github.com/sindresorhus/shebang-regex/issues" - }, - "description": "Regular expression for matching a shebang", - "devDependencies": { - "ava": "0.0.4" - }, - "engines": { - "node": ">=0.10.0" - }, - "files": [ - "index.js" - ], - "homepage": "https://github.com/sindresorhus/shebang-regex#readme", - "keywords": [ - "re", - "regex", - "regexp", - "shebang", - "match", - "test" - ], - "license": "MIT", - "name": "shebang-regex", - "repository": { - "type": "git", - "url": "git+https://github.com/sindresorhus/shebang-regex.git" - }, - "scripts": { - "test": "node test.js" - }, - "version": "1.0.0" -} diff --git a/node_modules/shebang-regex/readme.md b/node_modules/shebang-regex/readme.md deleted file mode 100644 index ef75e51..0000000 --- a/node_modules/shebang-regex/readme.md +++ /dev/null @@ -1,29 +0,0 @@ -# shebang-regex [![Build Status](https://travis-ci.org/sindresorhus/shebang-regex.svg?branch=master)](https://travis-ci.org/sindresorhus/shebang-regex) - -> Regular expression for matching a [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) - - -## Install - -``` -$ npm install --save shebang-regex -``` - - -## Usage - -```js -var shebangRegex = require('shebang-regex'); -var str = '#!/usr/bin/env node\nconsole.log("unicorns");'; - -shebangRegex.test(str); -//=> true - -shebangRegex.exec(str)[0]; -//=> '#!/usr/bin/env node' -``` - - -## License - -MIT © [Sindre Sorhus](http://sindresorhus.com) diff --git a/node_modules/signal-exit/CHANGELOG.md b/node_modules/signal-exit/CHANGELOG.md deleted file mode 100644 index e2f70d2..0000000 --- a/node_modules/signal-exit/CHANGELOG.md +++ /dev/null @@ -1,27 +0,0 @@ -# Change Log - -All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. - - -## [3.0.1](https://github.com/tapjs/signal-exit/compare/v3.0.0...v3.0.1) (2016-09-08) - - -### Bug Fixes - -* do not listen on SIGBUS, SIGFPE, SIGSEGV and SIGILL ([#40](https://github.com/tapjs/signal-exit/issues/40)) ([5b105fb](https://github.com/tapjs/signal-exit/commit/5b105fb)) - - - - -# [3.0.0](https://github.com/tapjs/signal-exit/compare/v2.1.2...v3.0.0) (2016-06-13) - - -### Bug Fixes - -* get our test suite running on Windows ([#23](https://github.com/tapjs/signal-exit/issues/23)) ([6f3eda8](https://github.com/tapjs/signal-exit/commit/6f3eda8)) -* hooking SIGPROF was interfering with profilers see [#21](https://github.com/tapjs/signal-exit/issues/21) ([#24](https://github.com/tapjs/signal-exit/issues/24)) ([1248a4c](https://github.com/tapjs/signal-exit/commit/1248a4c)) - - -### BREAKING CHANGES - -* signal-exit no longer wires into SIGPROF diff --git a/node_modules/signal-exit/LICENSE.txt b/node_modules/signal-exit/LICENSE.txt deleted file mode 100644 index eead04a..0000000 --- a/node_modules/signal-exit/LICENSE.txt +++ /dev/null @@ -1,16 +0,0 @@ -The ISC License - -Copyright (c) 2015, Contributors - -Permission to use, copy, modify, and/or distribute this software -for any purpose with or without fee is hereby granted, provided -that the above copyright notice and this permission notice -appear in all copies. - -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES -OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE -LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES -OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, -ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/signal-exit/README.md b/node_modules/signal-exit/README.md deleted file mode 100644 index 8ebccab..0000000 --- a/node_modules/signal-exit/README.md +++ /dev/null @@ -1,40 +0,0 @@ -# signal-exit - -[![Build Status](https://travis-ci.org/tapjs/signal-exit.png)](https://travis-ci.org/tapjs/signal-exit) -[![Coverage](https://coveralls.io/repos/tapjs/signal-exit/badge.svg?branch=master)](https://coveralls.io/r/tapjs/signal-exit?branch=master) -[![NPM version](https://img.shields.io/npm/v/signal-exit.svg)](https://www.npmjs.com/package/signal-exit) -[![Windows Tests](https://img.shields.io/appveyor/ci/bcoe/signal-exit/master.svg?label=Windows%20Tests)](https://ci.appveyor.com/project/bcoe/signal-exit) -[![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version) - -When you want to fire an event no matter how a process exits: - -* reaching the end of execution. -* explicitly having `process.exit(code)` called. -* having `process.kill(pid, sig)` called. -* receiving a fatal signal from outside the process - -Use `signal-exit`. - -```js -var onExit = require('signal-exit') - -onExit(function (code, signal) { - console.log('process exited!') -}) -``` - -## API - -`var remove = onExit(function (code, signal) {}, options)` - -The return value of the function is a function that will remove the -handler. - -Note that the function *only* fires for signals if the signal would -cause the proces to exit. That is, there are no other listeners, and -it is a fatal signal. - -## Options - -* `alwaysLast`: Run this handler after any other signal or exit - handlers. This causes `process.emit` to be monkeypatched. diff --git a/node_modules/signal-exit/index.js b/node_modules/signal-exit/index.js deleted file mode 100644 index 337f691..0000000 --- a/node_modules/signal-exit/index.js +++ /dev/null @@ -1,157 +0,0 @@ -// Note: since nyc uses this module to output coverage, any lines -// that are in the direct sync flow of nyc's outputCoverage are -// ignored, since we can never get coverage for them. -var assert = require('assert') -var signals = require('./signals.js') - -var EE = require('events') -/* istanbul ignore if */ -if (typeof EE !== 'function') { - EE = EE.EventEmitter -} - -var emitter -if (process.__signal_exit_emitter__) { - emitter = process.__signal_exit_emitter__ -} else { - emitter = process.__signal_exit_emitter__ = new EE() - emitter.count = 0 - emitter.emitted = {} -} - -// Because this emitter is a global, we have to check to see if a -// previous version of this library failed to enable infinite listeners. -// I know what you're about to say. But literally everything about -// signal-exit is a compromise with evil. Get used to it. -if (!emitter.infinite) { - emitter.setMaxListeners(Infinity) - emitter.infinite = true -} - -module.exports = function (cb, opts) { - assert.equal(typeof cb, 'function', 'a callback must be provided for exit handler') - - if (loaded === false) { - load() - } - - var ev = 'exit' - if (opts && opts.alwaysLast) { - ev = 'afterexit' - } - - var remove = function () { - emitter.removeListener(ev, cb) - if (emitter.listeners('exit').length === 0 && - emitter.listeners('afterexit').length === 0) { - unload() - } - } - emitter.on(ev, cb) - - return remove -} - -module.exports.unload = unload -function unload () { - if (!loaded) { - return - } - loaded = false - - signals.forEach(function (sig) { - try { - process.removeListener(sig, sigListeners[sig]) - } catch (er) {} - }) - process.emit = originalProcessEmit - process.reallyExit = originalProcessReallyExit - emitter.count -= 1 -} - -function emit (event, code, signal) { - if (emitter.emitted[event]) { - return - } - emitter.emitted[event] = true - emitter.emit(event, code, signal) -} - -// { : , ... } -var sigListeners = {} -signals.forEach(function (sig) { - sigListeners[sig] = function listener () { - // If there are no other listeners, an exit is coming! - // Simplest way: remove us and then re-send the signal. - // We know that this will kill the process, so we can - // safely emit now. - var listeners = process.listeners(sig) - if (listeners.length === emitter.count) { - unload() - emit('exit', null, sig) - /* istanbul ignore next */ - emit('afterexit', null, sig) - /* istanbul ignore next */ - process.kill(process.pid, sig) - } - } -}) - -module.exports.signals = function () { - return signals -} - -module.exports.load = load - -var loaded = false - -function load () { - if (loaded) { - return - } - loaded = true - - // This is the number of onSignalExit's that are in play. - // It's important so that we can count the correct number of - // listeners on signals, and don't wait for the other one to - // handle it instead of us. - emitter.count += 1 - - signals = signals.filter(function (sig) { - try { - process.on(sig, sigListeners[sig]) - return true - } catch (er) { - return false - } - }) - - process.emit = processEmit - process.reallyExit = processReallyExit -} - -var originalProcessReallyExit = process.reallyExit -function processReallyExit (code) { - process.exitCode = code || 0 - emit('exit', process.exitCode, null) - /* istanbul ignore next */ - emit('afterexit', process.exitCode, null) - /* istanbul ignore next */ - originalProcessReallyExit.call(process, process.exitCode) -} - -var originalProcessEmit = process.emit -function processEmit (ev, arg) { - if (ev === 'exit') { - if (arg !== undefined) { - process.exitCode = arg - } - var ret = originalProcessEmit.apply(this, arguments) - emit('exit', process.exitCode, null) - /* istanbul ignore next */ - emit('afterexit', process.exitCode, null) - return ret - } else { - return originalProcessEmit.apply(this, arguments) - } -} diff --git a/node_modules/signal-exit/package.json b/node_modules/signal-exit/package.json deleted file mode 100644 index d7b31a5..0000000 --- a/node_modules/signal-exit/package.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "_args": [ - [ - "signal-exit@3.0.2", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "signal-exit@3.0.2", - "_id": "signal-exit@3.0.2", - "_inBundle": false, - "_integrity": "sha1-tf3AjxKH6hF4Yo5BXiUTK3NkbG0=", - "_location": "/signal-exit", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "signal-exit@3.0.2", - "name": "signal-exit", - "escapedName": "signal-exit", - "rawSpec": "3.0.2", - "saveSpec": null, - "fetchSpec": "3.0.2" - }, - "_requiredBy": [ - "/execa", - "/write-file-atomic" - ], - "_resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.2.tgz", - "_spec": "3.0.2", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Ben Coe", - "email": "ben@npmjs.com" - }, - "bugs": { - "url": "https://github.com/tapjs/signal-exit/issues" - }, - "description": "when you want to fire an event no matter how a process exits.", - "devDependencies": { - "chai": "^3.5.0", - "coveralls": "^2.11.10", - "nyc": "^8.1.0", - "standard": "^7.1.2", - "standard-version": "^2.3.0", - "tap": "^8.0.1" - }, - "files": [ - "index.js", - "signals.js" - ], - "homepage": "https://github.com/tapjs/signal-exit", - "keywords": [ - "signal", - "exit" - ], - "license": "ISC", - "main": "index.js", - "name": "signal-exit", - "repository": { - "type": "git", - "url": "git+https://github.com/tapjs/signal-exit.git" - }, - "scripts": { - "coverage": "nyc report --reporter=text-lcov | coveralls", - "pretest": "standard", - "release": "standard-version", - "test": "tap --timeout=240 ./test/*.js --cov" - }, - "version": "3.0.2" -} diff --git a/node_modules/signal-exit/signals.js b/node_modules/signal-exit/signals.js deleted file mode 100644 index 3bd67a8..0000000 --- a/node_modules/signal-exit/signals.js +++ /dev/null @@ -1,53 +0,0 @@ -// This is not the set of all possible signals. -// -// It IS, however, the set of all signals that trigger -// an exit on either Linux or BSD systems. Linux is a -// superset of the signal names supported on BSD, and -// the unknown signals just fail to register, so we can -// catch that easily enough. -// -// Don't bother with SIGKILL. It's uncatchable, which -// means that we can't fire any callbacks anyway. -// -// If a user does happen to register a handler on a non- -// fatal signal like SIGWINCH or something, and then -// exit, it'll end up firing `process.emit('exit')`, so -// the handler will be fired anyway. -// -// SIGBUS, SIGFPE, SIGSEGV and SIGILL, when not raised -// artificially, inherently leave the process in a -// state from which it is not safe to try and enter JS -// listeners. -module.exports = [ - 'SIGABRT', - 'SIGALRM', - 'SIGHUP', - 'SIGINT', - 'SIGTERM' -] - -if (process.platform !== 'win32') { - module.exports.push( - 'SIGVTALRM', - 'SIGXCPU', - 'SIGXFSZ', - 'SIGUSR2', - 'SIGTRAP', - 'SIGSYS', - 'SIGQUIT', - 'SIGIOT' - // should detect profiler and enable/disable accordingly. - // see #21 - // 'SIGPROF' - ) -} - -if (process.platform === 'linux') { - module.exports.push( - 'SIGIO', - 'SIGPOLL', - 'SIGPWR', - 'SIGSTKFLT', - 'SIGUNUSED' - ) -} diff --git a/node_modules/strip-eof/index.js b/node_modules/strip-eof/index.js deleted file mode 100644 index a17d0af..0000000 --- a/node_modules/strip-eof/index.js +++ /dev/null @@ -1,15 +0,0 @@ -'use strict'; -module.exports = function (x) { - var lf = typeof x === 'string' ? '\n' : '\n'.charCodeAt(); - var cr = typeof x === 'string' ? '\r' : '\r'.charCodeAt(); - - if (x[x.length - 1] === lf) { - x = x.slice(0, x.length - 1); - } - - if (x[x.length - 1] === cr) { - x = x.slice(0, x.length - 1); - } - - return x; -}; diff --git a/node_modules/strip-eof/license b/node_modules/strip-eof/license deleted file mode 100644 index 654d0bf..0000000 --- a/node_modules/strip-eof/license +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) Sindre Sorhus (sindresorhus.com) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/node_modules/strip-eof/package.json b/node_modules/strip-eof/package.json deleted file mode 100644 index ccb28d1..0000000 --- a/node_modules/strip-eof/package.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "_args": [ - [ - "strip-eof@1.0.0", - "/Users/shim.taewon/Documents/sticky-pull-request-comment" - ] - ], - "_development": true, - "_from": "strip-eof@1.0.0", - "_id": "strip-eof@1.0.0", - "_inBundle": false, - "_integrity": "sha1-u0P/VZim6wXYm1n80SnJgzE2Br8=", - "_location": "/strip-eof", - "_phantomChildren": {}, - "_requested": { - "type": "version", - "registry": true, - "raw": "strip-eof@1.0.0", - "name": "strip-eof", - "escapedName": "strip-eof", - "rawSpec": "1.0.0", - "saveSpec": null, - "fetchSpec": "1.0.0" - }, - "_requiredBy": [ - "/execa" - ], - "_resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz", - "_spec": "1.0.0", - "_where": "/Users/shim.taewon/Documents/sticky-pull-request-comment", - "author": { - "name": "Sindre Sorhus", - "email": "sindresorhus@gmail.com", - "url": "sindresorhus.com" - }, - "bugs": { - "url": "https://github.com/sindresorhus/strip-eof/issues" - }, - "description": "Strip the End-Of-File (EOF) character from a string/buffer", - "devDependencies": { - "ava": "*", - "xo": "*" - }, - "engines": { - "node": ">=0.10.0" - }, - "files": [ - "index.js" - ], - "homepage": "https://github.com/sindresorhus/strip-eof#readme", - "keywords": [ - "strip", - "trim", - "remove", - "delete", - "eof", - "end", - "file", - "newline", - "linebreak", - "character", - "string", - "buffer" - ], - "license": "MIT", - "name": "strip-eof", - "repository": { - "type": "git", - "url": "git+https://github.com/sindresorhus/strip-eof.git" - }, - "scripts": { - "test": "xo && ava" - }, - "version": "1.0.0" -} diff --git a/node_modules/strip-eof/readme.md b/node_modules/strip-eof/readme.md deleted file mode 100644 index 45ffe04..0000000 --- a/node_modules/strip-eof/readme.md +++ /dev/null @@ -1,28 +0,0 @@ -# strip-eof [![Build Status](https://travis-ci.org/sindresorhus/strip-eof.svg?branch=master)](https://travis-ci.org/sindresorhus/strip-eof) - -> Strip the [End-Of-File](https://en.wikipedia.org/wiki/End-of-file) (EOF) character from a string/buffer - - -## Install - -``` -$ npm install --save strip-eof -``` - - -## Usage - -```js -const stripEof = require('strip-eof'); - -stripEof('foo\nbar\n\n'); -//=> 'foo\nbar\n' - -stripEof(new Buffer('foo\nbar\n\n')).toString(); -//=> 'foo\nbar\n' -``` - - -## License - -MIT © [Sindre Sorhus](http://sindresorhus.com) diff --git a/node_modules/tunnel/.idea/encodings.xml b/node_modules/tunnel/.idea/encodings.xml new file mode 100644 index 0000000..97626ba --- /dev/null +++ b/node_modules/tunnel/.idea/encodings.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/node_modules/tunnel/.idea/modules.xml b/node_modules/tunnel/.idea/modules.xml new file mode 100644 index 0000000..27bf888 --- /dev/null +++ b/node_modules/tunnel/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/node_modules/tunnel/.idea/node-tunnel.iml b/node_modules/tunnel/.idea/node-tunnel.iml new file mode 100644 index 0000000..24643cc --- /dev/null +++ b/node_modules/tunnel/.idea/node-tunnel.iml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/node_modules/tunnel/.idea/vcs.xml b/node_modules/tunnel/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/node_modules/tunnel/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/node_modules/tunnel/.idea/workspace.xml b/node_modules/tunnel/.idea/workspace.xml new file mode 100644 index 0000000..1a318c8 --- /dev/null +++ b/node_modules/tunnel/.idea/workspace.xml @@ -0,0 +1,797 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + max + onconne + + + + + + + + + + + + + false + + false + false + true + + + true + DEFINITION_ORDER + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +