diff --git a/.eslintrc.js b/.eslintrc.js index f06581b5a..05116fda6 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,11 +1,16 @@ module.exports = { - parser: '@typescript-eslint/parser', - extends: ['plugin:@typescript-eslint/recommended', 'prettier', 'prettier/@typescript-eslint'], - plugins: ['@typescript-eslint', 'prettier'], + parser: "@typescript-eslint/parser", + extends: [ + "plugin:@typescript-eslint/recommended", + "prettier", + "prettier/@typescript-eslint", + ], + plugins: ["@typescript-eslint", "prettier"], rules: { - '@typescript-eslint/camelcase': 'off', - '@typescript-eslint/no-use-before-define': 'off', - 'prettier/prettier': 'error', + "@typescript-eslint/camelcase": "off", + "@typescript-eslint/no-use-before-define": "off", + "prettier/prettier": "error", + "prefer-const": "off", }, env: { jest: true, diff --git a/src/types/OpenAPI3.ts b/src/types/OpenAPI3.ts index a45a465ff..3d9be6549 100644 --- a/src/types/OpenAPI3.ts +++ b/src/types/OpenAPI3.ts @@ -8,14 +8,44 @@ export interface OpenAPI3Schemas { [key: string]: OpenAPI3SchemaObject | OpenAPI3Reference; } +export interface OpenAPI3Paths { + [path: string]: { + [method: string]: OpenAPI3Response; + }; +} + +export interface OpenAPI3Response { + description?: string; + parameters?: OpenAPI3Parameter[]; + responses: { + [statusCode: string]: OpenAPI3ResponseObject; + }; +} + +export interface OpenAPI3Parameter { + name: string; + description?: string; + required?: boolean; + in: "query" | "header" | "path" | "cookie"; + schema: OpenAPI3SchemaObject | OpenAPI3Reference; +} + +export interface OpenAPI3ResponseObject { + description?: string; + content: { + [contentType: string]: { schema: OpenAPI3SchemaObject | OpenAPI3Reference }; + }; +} + export interface OpenAPI3Components { schemas: OpenAPI3Schemas; - responses?: OpenAPI3Schemas; + responses?: { [key: string]: OpenAPI3ResponseObject }; } export interface OpenAPI3 { openapi: string; - components: OpenAPI3Components; + paths?: OpenAPI3Paths; // technically required by spec, but this library tries to be lenient + components?: OpenAPI3Components; [key: string]: any; // handle other properties beyond swagger-to-ts’ concern } diff --git a/src/v3.ts b/src/v3.ts index 401152b3b..91aa7d619 100644 --- a/src/v3.ts +++ b/src/v3.ts @@ -1,7 +1,8 @@ import propertyMapper from "./property-mapper"; import { OpenAPI3, - OpenAPI3Components, + OpenAPI3Parameter, + OpenAPI3Paths, OpenAPI3SchemaObject, OpenAPI3Schemas, SwaggerToTSOptions, @@ -34,16 +35,14 @@ export default function generateTypesV3( options?: SwaggerToTSOptions ): string { const { rawSchema = false } = options || {}; - let components: OpenAPI3Components; + let { paths = {}, components = { schemas: {} } } = input as OpenAPI3; if (rawSchema) { components = { schemas: input }; } else { - components = (input as OpenAPI3).components; - - if (!components || !components.schemas) { + if (!input.components && !input.paths) { throw new Error( - `⛔️ 'components' missing from schema https://swagger.io/specification` + `No components or paths found. Specify --raw-schema to load a raw schema.` ); } } @@ -111,7 +110,7 @@ export default function generateTypesV3( if (Array.isArray(node.items)) { return tsTupleOf(node.items.map(transform)); } else { - return tsArrayOf(transform(node.items as any)); + return tsArrayOf(node.items ? transform(node.items as any) : "any"); } } } @@ -154,27 +153,107 @@ export default function generateTypesV3( return output; } - if (rawSchema) { - const schemas = createKeys(propertyMapped, Object.keys(propertyMapped)); + function transformPaths(paths: OpenAPI3Paths): string { + let output = ""; + Object.entries(paths).forEach(([path, methods]) => { + output += `"${path}": {\n`; + Object.entries(methods).forEach(([method, responses]) => { + if (responses.description) output += comment(responses.description); + output += `"${method}": {\n`; + + // handle parameters + if (responses.parameters) { + output += `parameters: {\n`; + const allParameters: Record< + string, + Record + > = {}; + responses.parameters.forEach((p) => { + if (!allParameters[p.in]) allParameters[p.in] = {}; + // TODO: handle $ref parameters + if (p.name) { + allParameters[p.in][p.name] = p; + } + }); + + Object.entries(allParameters).forEach(([loc, locParams]) => { + output += `"${loc}": {\n`; + Object.entries(locParams).forEach(([paramName, paramProps]) => { + if (paramProps.description) + output += comment(paramProps.description); + output += `"${paramName}"${ + paramProps.required === true ? "" : "?" + }: ${transform(paramProps.schema)};\n`; + }); + output += `}\n`; + }); + output += `}\n`; + } + // handle responses + output += `responses: {\n`; + Object.entries(responses.responses).forEach( + ([statusCode, response]) => { + if (response.description) output += comment(response.description); + if (!response.content || !Object.keys(response.content).length) { + output += `"${statusCode}": any;\n`; + return; + } + output += `"${statusCode}": {\n`; + Object.entries(response.content).forEach( + ([contentType, encodedResponse]) => { + output += `"${contentType}": ${transform( + encodedResponse.schema + )};\n`; + } + ); + output += `}\n`; + } + ); + output += `}\n`; + output += `}\n`; + }); + output += `}\n`; + }); + return output; + } + + if (rawSchema) { return `export interface schemas { - ${schemas} - }`; + ${createKeys(propertyMapped, Object.keys(propertyMapped))} +}`; } - const schemas = `schemas: { - ${createKeys(propertyMapped, Object.keys(propertyMapped))} - }`; - - const responses = !components.responses - ? `` - : `responses: { - ${createKeys(components.responses, Object.keys(components.responses))} - }`; - - // note: make sure that base-level schemas are required - return `export interface components { - ${schemas} - ${responses} - }`; + // now put everything together + let finalOutput = ""; + + // handle paths + if (Object.keys(paths).length) { + finalOutput += `export interface paths { + ${transformPaths(paths)} +} + +`; + } + + finalOutput += "export interface components {\n"; + + // TODO: handle components.parameters + + if (Object.keys(propertyMapped).length) { + finalOutput += `schemas: { + ${createKeys(propertyMapped, Object.keys(propertyMapped))} +}`; + } + if (components.responses && Object.keys(components.responses).length) { + finalOutput += ` +responses: { + ${createKeys(components.responses, Object.keys(components.responses))} +}`; + } + + // close components wrapper + finalOutput += "\n}"; + + return finalOutput; } diff --git a/tests/bin/expected/petstore.ts b/tests/bin/expected/petstore.ts index 1070a3925..1de02f293 100644 --- a/tests/bin/expected/petstore.ts +++ b/tests/bin/expected/petstore.ts @@ -3,6 +3,416 @@ * Do not make direct changes to the file. */ +export interface paths { + '/pet': { + put: { + responses: { + /** + * Invalid ID supplied + */ + '400': any + /** + * Pet not found + */ + '404': any + /** + * Validation exception + */ + '405': any + } + } + post: { + responses: { + /** + * Invalid input + */ + '405': any + } + } + } + '/pet/findByStatus': { + /** + * Multiple status values can be provided with comma separated strings + */ + get: { + parameters: { + query: { + /** + * Status values that need to be considered for filter + */ + status: ('available' | 'pending' | 'sold')[] + } + } + responses: { + /** + * successful operation + */ + '200': { + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + /** + * Invalid status value + */ + '400': any + } + } + } + '/pet/findByTags': { + /** + * Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + */ + get: { + parameters: { + query: { + /** + * Tags to filter by + */ + tags: string[] + } + } + responses: { + /** + * successful operation + */ + '200': { + 'application/xml': components['schemas']['Pet'][] + 'application/json': components['schemas']['Pet'][] + } + /** + * Invalid tag value + */ + '400': any + } + } + } + '/pet/{petId}': { + /** + * Returns a single pet + */ + get: { + parameters: { + path: { + /** + * ID of pet to return + */ + petId: number + } + } + responses: { + /** + * successful operation + */ + '200': { + 'application/xml': components['schemas']['Pet'] + 'application/json': components['schemas']['Pet'] + } + /** + * Invalid ID supplied + */ + '400': any + /** + * Pet not found + */ + '404': any + } + } + post: { + parameters: { + path: { + /** + * ID of pet that needs to be updated + */ + petId: number + } + } + responses: { + /** + * Invalid input + */ + '405': any + } + } + delete: { + parameters: { + header: { + api_key?: string + } + path: { + /** + * Pet id to delete + */ + petId: number + } + } + responses: { + /** + * Invalid ID supplied + */ + '400': any + /** + * Pet not found + */ + '404': any + } + } + } + '/pet/{petId}/uploadImage': { + post: { + parameters: { + path: { + /** + * ID of pet to update + */ + petId: number + } + } + responses: { + /** + * successful operation + */ + '200': { + 'application/json': components['schemas']['ApiResponse'] + } + } + } + } + '/store/inventory': { + /** + * Returns a map of status codes to quantities + */ + get: { + responses: { + /** + * successful operation + */ + '200': { + 'application/json': { [key: string]: number } + } + } + } + } + '/store/order': { + post: { + responses: { + /** + * successful operation + */ + '200': { + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + /** + * Invalid Order + */ + '400': any + } + } + } + '/store/order/{orderId}': { + /** + * For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions + */ + get: { + parameters: { + path: { + /** + * ID of pet that needs to be fetched + */ + orderId: number + } + } + responses: { + /** + * successful operation + */ + '200': { + 'application/xml': components['schemas']['Order'] + 'application/json': components['schemas']['Order'] + } + /** + * Invalid ID supplied + */ + '400': any + /** + * Order not found + */ + '404': any + } + } + /** + * For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors + */ + delete: { + parameters: { + path: { + /** + * ID of the order that needs to be deleted + */ + orderId: number + } + } + responses: { + /** + * Invalid ID supplied + */ + '400': any + /** + * Order not found + */ + '404': any + } + } + } + '/user': { + /** + * This can only be done by the logged in user. + */ + post: { + responses: { + /** + * successful operation + */ + default: any + } + } + } + '/user/createWithArray': { + post: { + responses: { + /** + * successful operation + */ + default: any + } + } + } + '/user/createWithList': { + post: { + responses: { + /** + * successful operation + */ + default: any + } + } + } + '/user/login': { + get: { + parameters: { + query: { + /** + * The user name for login + */ + username: string + /** + * The password for login in clear text + */ + password: string + } + } + responses: { + /** + * successful operation + */ + '200': { + 'application/xml': string + 'application/json': string + } + /** + * Invalid username/password supplied + */ + '400': any + } + } + } + '/user/logout': { + get: { + responses: { + /** + * successful operation + */ + default: any + } + } + } + '/user/{username}': { + get: { + parameters: { + path: { + /** + * The name that needs to be fetched. Use user1 for testing. + */ + username: string + } + } + responses: { + /** + * successful operation + */ + '200': { + 'application/xml': components['schemas']['User'] + 'application/json': components['schemas']['User'] + } + /** + * Invalid username supplied + */ + '400': any + /** + * User not found + */ + '404': any + } + } + /** + * This can only be done by the logged in user. + */ + put: { + parameters: { + path: { + /** + * name that need to be updated + */ + username: string + } + } + responses: { + /** + * Invalid user supplied + */ + '400': any + /** + * User not found + */ + '404': any + } + } + /** + * This can only be done by the logged in user. + */ + delete: { + parameters: { + path: { + /** + * The name that needs to be deleted + */ + username: string + } + } + responses: { + /** + * Invalid username supplied + */ + '400': any + /** + * User not found + */ + '404': any + } + } + } +} + export interface components { schemas: { Order: { diff --git a/tests/v3/expected/github.ts b/tests/v3/expected/github.ts new file mode 100644 index 000000000..caf907143 --- /dev/null +++ b/tests/v3/expected/github.ts @@ -0,0 +1,20156 @@ +/** + * This file was auto-generated by swagger-to-ts. + * Do not make direct changes to the file. + */ + +export interface paths { + "/": { + /** + * Get Hypermedia links to resources accessible in GitHub's REST API + */ + get: { + 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; + }; + }; + }; + }; + }; + "/app": { + /** + * 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://developer.github.com/v3/apps/#list-installations-for-the-authenticated-app)" 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. + */ + get: { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["integration"]; + }; + }; + }; + }; + "/app-manifests/{code}/conversions": { + /** + * 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`. + */ + post: { + 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": any; + "422": any; + }; + }; + }; + "/app/installations": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + query: { + outdated?: string; + }; + }; + responses: { + /** + * The permissions the installation has are included under the `permissions` key. + */ + "200": { + "application/json": components["schemas"]["installation"][]; + }; + }; + }; + }; + "/app/installations/{installation_id}": { + /** + * 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://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["installation"]; + }; + "404": any; + "415": any; + }; + }; + /** + * 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://developer.github.com/v3/apps/#suspend-an-app-installation)" 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/app/installations/{installation_id}/access_tokens": { + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["installation-token"]; + }; + "401": any; + "403": any; + "404": any; + "415": any; + "422": any; + }; + }; + }; + "/app/installations/{installation_id}/suspended": { + /** + * **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://developer.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. + * + * To suspend a GitHub App, you must be an account owner or have admin permissions in the repository or organization where the app is installed. + * + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + /** + * **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://developer.github.com/apps/managing-github-apps/suspending-a-github-app-installation/)." + * + * Removes a GitHub App installation suspension. + * + * To unsuspend a GitHub App, you must be an account owner or have admin permissions in the repository or organization where the app is installed and suspended. + * + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/applications/grants": { + /** + * **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). The [OAuth Authorizations API](https://developer.github.com/v3/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://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"]`. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["application-grant"][]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + }; + "/applications/grants/{grant_id}": { + /** + * **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). The [OAuth Authorizations API](https://developer.github.com/v3/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/). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["application-grant"]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + /** + * **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). The [OAuth Authorizations API](https://developer.github.com/v3/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). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + }; + }; + }; + "/applications/{client_id}/grant": { + /** + * 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). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "422": any; + }; + }; + }; + "/applications/{client_id}/grants/{access_token}": { + /** + * **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. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, 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://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). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/applications/{client_id}/token": { + /** + * 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`. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + "404": any; + "422": any; + }; + }; + /** + * 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`. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + "422": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "422": any; + }; + }; + }; + "/applications/{client_id}/tokens/{access_token}": { + /** + * **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. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, 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://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`. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + "404": any; + }; + }; + /** + * **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. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, 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://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`. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + }; + }; + /** + * **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. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, 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://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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/apps/{app_slug}": { + /** + * **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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["integration"]; + }; + "403": any; + "404": any; + "415": any; + }; + }; + }; + "/authorizations": { + /** + * **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). The [OAuth Authorizations API](https://developer.github.com/v3/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/). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"][]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + /** + * **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). The [OAuth Authorizations API](https://developer.github.com/v3/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://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 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). + */ + post: { + parameters: {}; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authorization"]; + }; + "304": any; + "401": any; + "403": any; + "410": any; + "422": any; + }; + }; + }; + "/authorizations/clients/{client_id}": { + /** + * **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). The [OAuth Authorizations API](https://developer.github.com/v3/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://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). The [OAuth Authorizations API](https://developer.github.com/v3/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/). + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if returning an existing token + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + /** + * **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). The [OAuth Authorizations API](https://developer.github.com/v3/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": any; + "401": any; + "403": any; + "422": any; + }; + }; + }; + "/authorizations/clients/{client_id}/{fingerprint}": { + /** + * **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). The [OAuth Authorizations API](https://developer.github.com/v3/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://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)." + */ + put: { + parameters: { + undefined: {}; + path: { + fingerprint: 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": any; + }; + }; + }; + "/authorizations/{authorization_id}": { + /** + * **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). The [OAuth Authorizations API](https://developer.github.com/v3/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/). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + /** + * **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). The [OAuth Authorizations API](https://developer.github.com/v3/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://developer.github.com/v3/auth/#working-with-two-factor-authentication)." + * + * You can only send one of these scope keys at a time. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["authorization"]; + }; + "422": any; + }; + }; + /** + * **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). The [OAuth Authorizations API](https://developer.github.com/v3/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/). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + }; + }; + }; + "/codes_of_conduct": { + get: { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["code-of-conduct"][]; + }; + "304": any; + "415": any; + }; + }; + }; + "/codes_of_conduct/{key}": { + get: { + parameters: { + path: { + key: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["code-of-conduct"]; + }; + "304": any; + "404": any; + "415": any; + }; + }; + }; + "/content_references/{content_reference_id}/attachments": { + /** + * 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/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://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. + */ + post: { + parameters: { + path: { + content_reference_id: number; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["content-reference-attachment"]; + }; + "304": any; + "403": any; + "404": any; + "410": any; + "415": any; + "422": any; + }; + }; + }; + "/emojis": { + /** + * Lists all the emojis available to use on GitHub. + */ + get: { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": { [key: string]: string }; + }; + "304": any; + }; + }; + }; + "/enterprises/{enterprise}/actions/runner-groups": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["runner-groups-enterprise"]; + }; + }; + }; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + patch: { + parameters: { + undefined: {}; + }; + 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/enterprises/{enterprise}/actions/runners": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + runners?: components["schemas"]["runner"][]; + }; + }; + }; + }; + }; + "/enterprises/{enterprise}/actions/runners/downloads": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner-application"][]; + }; + }; + }; + }; + "/enterprises/{enterprise}/actions/runners/registration-token": { + /** + * 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/enterpises/octo-enterprise --token TOKEN + * ``` + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + }; + "/enterprises/{enterprise}/actions/runners/remove-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 + * ``` + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + }; + "/enterprises/{enterprise}/actions/runners/{runner_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/enterprises/{enterprise}/settings/billing/actions": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-billing-usage"]; + }; + }; + }; + }; + "/enterprises/{enterprise}/settings/billing/packages": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["packages-billing-usage"]; + }; + }; + }; + }; + "/enterprises/{enterprise}/settings/billing/shared-storage": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["combined-billing-usage"]; + }; + }; + }; + }; + "/events": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + "304": any; + "403": any; + "503": any; + }; + }; + }; + "/feeds": { + /** + * 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. + */ + get: { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["feed"]; + }; + }; + }; + }; + "/gists": { + /** + * Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["base-gist"][]; + }; + "304": any; + "403": any; + }; + }; + /** + * 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. + */ + post: { + parameters: {}; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["gist-full"]; + }; + "304": any; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/gists/public": { + /** + * List 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["base-gist"][]; + }; + "304": any; + "403": any; + "422": any; + }; + }; + }; + "/gists/starred": { + /** + * List the authenticated user's starred gists: + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["base-gist"][]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + }; + "/gists/{gist_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-full"]; + }; + "304": any; + "403": any; + "404": any; + }; + }; + /** + * 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. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-full"]; + }; + "404": any; + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "403": any; + "404": any; + }; + }; + }; + "/gists/{gist_id}/comments": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-comment"][]; + }; + "304": any; + "403": any; + "404": any; + }; + }; + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["gist-comment"]; + }; + "304": any; + "403": any; + "404": any; + }; + }; + }; + "/gists/{gist_id}/comments/{comment_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-comment"]; + }; + "304": any; + "403": any; + "404": any; + }; + }; + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-comment"]; + }; + "404": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "403": any; + "404": any; + }; + }; + }; + "/gists/{gist_id}/commits": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-commit"][]; + }; + "304": any; + "403": any; + "404": any; + }; + }; + }; + "/gists/{gist_id}/forks": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-full"][]; + }; + "304": any; + "403": any; + "404": any; + }; + }; + /** + * **Note**: This was previously `/gists/:gist_id/fork`. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["base-gist"]; + }; + "304": any; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/gists/{gist_id}/star": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if gist is starred + */ + "204": any; + "304": any; + "403": any; + /** + * 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://developer.github.com/v3/#http-verbs)." + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "403": any; + "404": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "403": any; + "404": any; + }; + }; + }; + "/gists/{gist_id}/{sha}": { + get: { + parameters: { + undefined: {}; + path: { + sha: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gist-full"]; + }; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/gitignore/templates": { + /** + * List all templates available to pass as an option when [creating a repository](https://developer.github.com/v3/repos/#create-a-repository-for-the-authenticated-user). + */ + get: { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": string[]; + }; + "304": any; + }; + }; + }; + "/gitignore/templates/{name}": { + /** + * 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. + */ + get: { + parameters: { + path: { + name: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gitignore-template"]; + }; + "304": any; + }; + }; + }; + "/installation/repositories": { + /** + * List repositories that an app 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + repositories?: components["schemas"]["repository"][]; + repository_selection?: string; + }; + }; + "304": any; + "401": any; + "403": any; + }; + }; + }; + "/installation/token": { + /** + * 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://developer.github.com/v3/apps/#create-an-installation-access-token-for-an-app)" endpoint. + * + * 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. + */ + delete: { + parameters: {}; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/issues": { + /** + * 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. See the [Parameters table](https://developer.github.com/v3/issues/#parameters) for more + * information. + * + * + * **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: { + 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"; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + collab?: boolean; + orgs?: boolean; + owned?: boolean; + pulls?: boolean; + }; + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue"][]; + }; + "304": any; + "404": any; + "422": any; + }; + }; + }; + "/licenses": { + get: { + parameters: { + query: { + featured?: boolean; + }; + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["license-simple"][]; + }; + "304": any; + }; + }; + }; + "/licenses/{license}": { + get: { + parameters: { + path: { + license: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["license"]; + }; + "304": any; + "403": any; + "404": any; + }; + }; + }; + "/markdown": { + post: { + parameters: {}; + responses: { + /** + * response + */ + "200": any; + "304": any; + }; + }; + }; + "/markdown/raw": { + /** + * 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. + */ + post: { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "text/html": string; + }; + "304": any; + }; + }; + }; + "/marketplace_listing/accounts/{account_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["marketplace-purchase"]; + }; + "401": any; + /** + * Response when the account has not purchased the listing + */ + "404": { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "/marketplace_listing/plans": { + /** + * Lists all plans that are part of your GitHub Marketplace listing. + * + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["marketplace-listing-plan"][]; + }; + "401": any; + "404": any; + }; + }; + }; + "/marketplace_listing/plans/{plan_id}/accounts": { + /** + * 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://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. + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["marketplace-purchase"][]; + }; + "401": any; + "404": any; + "422": any; + }; + }; + }; + "/marketplace_listing/stubbed/accounts/{account_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["marketplace-purchase"]; + }; + "401": any; + /** + * Response when the account has not purchased the listing + */ + "404": any; + }; + }; + }; + "/marketplace_listing/stubbed/plans": { + /** + * Lists all plans that are part of your GitHub Marketplace listing. + * + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["marketplace-listing-plan"][]; + }; + "401": any; + }; + }; + }; + "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + /** + * 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://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. + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["marketplace-purchase"][]; + }; + "401": any; + }; + }; + }; + "/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: { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["api-overview"]; + }; + "304": any; + }; + }; + }; + "/networks/{owner}/{repo}/events": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + "301": any; + "304": any; + "403": any; + "404": any; + }; + }; + }; + "/notifications": { + /** + * List all notifications for the current user, sorted by most recently updated. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["thread"][]; + }; + "304": any; + "401": any; + "403": any; + "422": any; + }; + }; + /** + * 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://developer.github.com/v3/activity/notifications/#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + */ + put: { + parameters: {}; + responses: { + /** + * response + */ + "202": { + "application/json": { message?: string }; + }; + /** + * response + */ + "205": any; + "304": any; + "401": any; + "403": any; + }; + }; + }; + "/notifications/threads/{thread_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["thread"]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "205": any; + "304": any; + "403": any; + }; + }; + }; + "/notifications/threads/{thread_id}/subscription": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["thread-subscription"]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + /** + * 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://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription) endpoint. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["thread-subscription"]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + /** + * 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://developer.github.com/v3/activity/notifications/#set-a-thread-subscription) endpoint and set `ignore` to `true`. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + }; + }; + }; + "/octocat": { + /** + * Get the octocat as ASCII art + */ + get: { + parameters: { + query: { + /** + * The words to show in Octocat's speech bubble + */ + s?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/octocat-stream": string; + }; + }; + }; + }; + "/organizations": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-simple"][]; + }; + "304": any; + }; + }; + }; + "/orgs/{org}": { + /** + * 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: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-full"]; + }; + "404": any; + }; + }; + /** + * **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. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-full"]; + }; + "409": any; + "415": any; + /** + * Validation Failed + */ + "422": { + "application/json": + | components["schemas"]["validation-error"] + | components["schemas"]["validation-error-simple"]; + }; + }; + }; + }; + "/orgs/{org}/actions/runner-groups": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + patch: { + parameters: { + undefined: {}; + }; + 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/actions/runners": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + runners?: components["schemas"]["runner"][]; + }; + }; + }; + }; + }; + "/orgs/{org}/actions/runners/downloads": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner-application"][]; + }; + }; + }; + }; + "/orgs/{org}/actions/runners/registration-token": { + /** + * 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 + * ``` + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + }; + "/orgs/{org}/actions/runners/remove-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 + * ``` + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + }; + "/orgs/{org}/actions/runners/{runner_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/actions/secrets": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + secrets?: components["schemas"]["organization-actions-secret"][]; + }; + }; + }; + }; + }; + "/orgs/{org}/actions/secrets/public-key": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + "/orgs/{org}/actions/secrets/{secret_name}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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) + * ``` + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response when creating a secret + */ + "201": any; + /** + * Response when updating a secret + */ + "204": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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://developer.github.com/v3/actions/secrets/#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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + /** + * 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://developer.github.com/v3/actions/secrets/#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. + */ + put: { + parameters: { + undefined: {}; + path: { + repository_id: number; + }; + }; + responses: { + /** + * Response when repository was added to the selected list + */ + "204": any; + /** + * Response when visibility type is not set to selected + */ + "409": any; + }; + }; + /** + * 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://developer.github.com/v3/actions/secrets/#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. + */ + delete: { + parameters: { + undefined: {}; + path: { + repository_id: number; + }; + }; + responses: { + /** + * Response when repository was removed from the selected list + */ + "204": any; + /** + * Response when visibility type not set to selected + */ + "409": any; + }; + }; + }; + "/orgs/{org}/blocks": { + /** + * List the users blocked by an organization. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "415": any; + }; + }; + }; + "/orgs/{org}/blocks/{username}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * If the user is blocked: + */ + "204": any; + /** + * If the user is not blocked: + */ + "404": { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/credential-authorizations": { + /** + * 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). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["credential-authorization"][]; + }; + }; + }; + }; + "/orgs/{org}/credential-authorizations/{credential_id}": { + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + path: { + credential_id: number; + }; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/orgs/{org}/events": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + "/orgs/{org}/hooks": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-hook"][]; + }; + "404": any; + }; + }; + /** + * Here's how you can create a hook that posts payloads in JSON format: + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["org-hook"]; + }; + "404": any; + "422": any; + }; + }; + }; + "/orgs/{org}/hooks/{hook_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-hook"]; + }; + "404": any; + }; + }; + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-hook"]; + }; + "404": any; + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/orgs/{org}/hooks/{hook_id}/pings": { + /** + * This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/orgs/{org}/installation": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["installation"]; + }; + }; + }; + }; + "/orgs/{org}/installations": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + installations?: components["schemas"]["installation"][]; + }; + }; + }; + }; + }; + "/orgs/{org}/interaction-limits": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["interaction-limit"]; + }; + }; + }; + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["interaction-limit"]; + }; + "422": any; + }; + }; + /** + * Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/invitations": { + /** + * 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`. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-invitation"][]; + }; + "404": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["organization-invitation"]; + }; + "404": any; + "422": any; + }; + }; + }; + "/orgs/{org}/invitations/{invitation_id}/teams": { + /** + * List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "404": any; + }; + }; + }; + "/orgs/{org}/issues": { + /** + * 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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + */ + get: { + parameters: { + undefined: {}; + 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"; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue"][]; + }; + "404": any; + }; + }; + }; + "/orgs/{org}/members": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + /** + * Response if requester is not an organization member + */ + "302": any; + "422": any; + }; + }; + }; + "/orgs/{org}/members/{username}": { + /** + * Check if a user is, publicly or privately, a member of the organization. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if requester is an organization member and user is a member + */ + "204": any; + /** + * Response if requester is not an organization member + */ + "302": any; + /** + * Response if requester is an organization member and user is not a member + */ + "404": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "403": any; + }; + }; + }; + "/orgs/{org}/memberships/{username}": { + /** + * In order to get a user's membership with an organization, the authenticated user must be an organization member. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-membership"]; + }; + "403": any; + "404": any; + }; + }; + /** + * 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-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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-membership"]; + }; + "403": any; + "422": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "403": any; + "404": any; + }; + }; + }; + "/orgs/{org}/migrations": { + /** + * Lists the most recent migrations. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["migration"][]; + }; + }; + }; + /** + * Initiates the generation of a migration archive. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["migration"]; + }; + "404": any; + "422": any; + }; + }; + }; + "/orgs/{org}/migrations/{migration_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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": any; + }; + }; + }; + "/orgs/{org}/migrations/{migration_id}/archive": { + /** + * Fetches the URL to a migration archive. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "302": any; + "404": any; + }; + }; + /** + * Deletes a previous migration archive. Migration archives are automatically deleted after seven days. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/orgs/{org}/migrations/{migration_id}/repositories": { + /** + * List all the repositories for this organization migration. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + "404": any; + }; + }; + }; + "/orgs/{org}/outside_collaborators": { + /** + * List all users who are outside collaborators of an organization. + */ + get: { + parameters: { + undefined: {}; + 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "/orgs/{org}/outside_collaborators/{username}": { + /** + * 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/)". + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * User is getting converted asynchronously + */ + "202": any; + /** + * User was converted + */ + "204": any; + /** + * response + */ + "403": { + "application/json": { message?: string; documentation_url?: string }; + }; + "404": any; + }; + }; + /** + * Removing a user from this list will remove them from all the organization's repositories. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + /** + * Response if user is a member of the organization + */ + "422": { + "application/json": { message?: string; documentation_url?: string }; + }; + }; + }; + }; + "/orgs/{org}/projects": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project"][]; + }; + "422": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["project"]; + }; + "401": any; + "403": any; + "404": any; + "410": any; + "422": any; + }; + }; + }; + "/orgs/{org}/public_members": { + /** + * Members of an organization can choose to have their membership publicized or not. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "/orgs/{org}/public_members/{username}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if user is a public member + */ + "204": any; + /** + * Response if user is not a public member + */ + "404": any; + }; + }; + /** + * 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)." + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "403": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/repos": { + /** + * Lists repositories for the specified organization. + */ + get: { + parameters: { + undefined: {}; + 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"; + }; + }; + 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://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 + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["repository"]; + }; + "403": any; + "422": any; + }; + }; + }; + "/orgs/{org}/settings/billing/actions": { + /** + * 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 `read:org` scope. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-billing-usage"]; + }; + }; + }; + }; + "/orgs/{org}/settings/billing/packages": { + /** + * 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 `read:org` scope. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["packages-billing-usage"]; + }; + }; + }; + }; + "/orgs/{org}/settings/billing/shared-storage": { + /** + * 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 `read:org` scope. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["combined-billing-usage"]; + }; + }; + }; + }; + "/orgs/{org}/team-sync/groups": { + /** + * 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: + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["group-mapping"]; + }; + }; + }; + }; + "/orgs/{org}/teams": { + /** + * Lists all teams in an organization that are visible to the authenticated user. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "403": any; + }; + }; + /** + * 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)". + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-full"]; + }; + "403": any; + "422": any; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}": { + /** + * 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}`. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-full"]; + }; + "404": any; + }; + }; + /** + * 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}`. + */ + patch: { + parameters: { + undefined: {}; + }; + 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}`. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/discussions": { + /** + * 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/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + */ + get: { + parameters: { + undefined: {}; + }; + 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://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. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + /** + * 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/). + * + * **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}`. + */ + get: { + parameters: { + undefined: {}; + }; + 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://developer.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}`. + */ + patch: { + parameters: { + undefined: {}; + }; + 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://developer.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}`. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + /** + * 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/). + * + * **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`. + */ + get: { + parameters: { + undefined: {}; + }; + 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://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. + * + * **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`. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + /** + * 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/). + * + * **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}`. + */ + get: { + parameters: { + undefined: {}; + }; + 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://developer.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}`. + */ + patch: { + parameters: { + undefined: {}; + }; + 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://developer.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}`. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + /** + * 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/). + * + * **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`. + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + }; + }; + /** + * 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. + * + * **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`. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + /** + * **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://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/). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + /** + * 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/). + * + * **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`. + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + }; + }; + /** + * 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. + * + * **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`. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + /** + * **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://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/). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/invitations": { + /** + * 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`. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-invitation"][]; + }; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/members": { + /** + * Team members will include the members of child teams. + * + * To list members in a team, the team must be visible to the authenticated user. + */ + get: { + parameters: { + undefined: {}; + 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + /** + * 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://developer.github.com/v3/teams/#create-a-team). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-membership"]; + }; + /** + * Response if user has no team membership + */ + "404": any; + }; + }; + /** + * 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}`. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-membership"]; + }; + /** + * Response if team synchronization is set up + */ + "403": any; + /** + * 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}`. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + /** + * Response if team synchronization is set up + */ + "403": any; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/projects": { + /** + * 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`. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-project"][]; + }; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + /** + * 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}`. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-project"]; + }; + /** + * Response if project is not managed by this team + */ + "404": any; + }; + }; + /** + * 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}`. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + /** + * 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}`. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/repos": { + /** + * 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`. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + /** + * 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://developer.github.com/v3/media/) 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}`. + */ + get: { + parameters: { + undefined: {}; + }; + 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": any; + /** + * Response if team does not have permission for the repository + */ + "404": any; + }; + }; + /** + * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + * + * **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)". + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + /** + * 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}`. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { + /** + * 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`. + */ + get: { + parameters: { + undefined: {}; + }; + 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`. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["group-mapping"]; + }; + }; + }; + }; + "/orgs/{org}/teams/{team_slug}/teams": { + /** + * 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`. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if child teams exist + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + }; + }; + }; + "/projects/columns/cards/{card_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project-card"]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project-card"]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + /** + * Forbidden + */ + "403": { + "application/json": { + message?: string; + documentation_url?: string; + errors?: string[]; + }; + }; + "404": any; + }; + }; + }; + "/projects/columns/cards/{card_id}/moves": { + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": { [key: string]: any }; + }; + "304": any; + "401": any; + /** + * Forbidden + */ + "403": { + "application/json": { + message?: string; + documentation_url?: string; + errors?: { + code?: string; + message?: string; + resource?: string; + field?: string; + }[]; + }; + }; + "422": any; + /** + * Service Unavailable + */ + "503": { + "application/json": { + code?: string; + message?: string; + documentation_url?: string; + errors?: { code?: string; message?: string }[]; + }; + }; + }; + }; + }; + "/projects/columns/{column_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project-column"]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project-column"]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + }; + }; + }; + "/projects/columns/{column_id}/cards": { + get: { + parameters: { + undefined: {}; + 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project-card"][]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + /** + * **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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["project-card"]; + }; + "304": any; + "401": any; + "403": any; + /** + * 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/columns/{column_id}/moves": { + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": { [key: string]: any }; + }; + "304": any; + "401": any; + "403": any; + "422": any; + }; + }; + }; + "/projects/{project_id}": { + /** + * 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: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project"]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + /** + * 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. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project"]; + }; + "304": any; + "401": any; + /** + * Forbidden + */ + "403": { + "application/json": { + message?: string; + documentation_url?: string; + errors?: string[]; + }; + }; + /** + * Response if the authenticated user does not have access to the project + */ + "404": any; + "410": any; + "422": any; + }; + }; + /** + * Deletes a project board. Returns a `404 Not Found` status if projects are disabled. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Delete Success + */ + "204": any; + "304": any; + "401": any; + /** + * Forbidden + */ + "403": { + "application/json": { + message?: string; + documentation_url?: string; + errors?: string[]; + }; + }; + "404": any; + "410": any; + }; + }; + }; + "/projects/{project_id}/collaborators": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + "415": any; + "422": any; + }; + }; + }; + "/projects/{project_id}/collaborators/{username}": { + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + "415": any; + "422": any; + }; + }; + /** + * Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + "415": any; + "422": any; + }; + }; + }; + "/projects/{project_id}/collaborators/{username}/permission": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository-collaborator-permission"]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + "415": any; + "422": any; + }; + }; + }; + "/projects/{project_id}/columns": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project-column"][]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["project-column"]; + }; + "304": any; + "401": any; + "403": any; + "422": any; + }; + }; + }; + "/rate_limit": { + /** + * **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: { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["rate-limit-overview"]; + }; + "304": any; + "404": any; + }; + }; + }; + "/reactions/{reaction_id}": { + /** + * **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://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: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "410": any; + "415": any; + }; + }; + }; + "/repos/{owner}/{repo}": { + /** + * 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: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["full-repository"]; + }; + "301": any; + "403": any; + "404": any; + }; + }; + /** + * **Note**: To edit a repository's topics, use the [Replace all repository topics](https://developer.github.com/v3/repos/#replace-all-repository-topics) endpoint. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["full-repository"]; + }; + "403": any; + "404": any; + "422": any; + }; + }; + /** + * 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: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + /** + * 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": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/artifacts": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + artifacts?: components["schemas"]["artifact"][]; + }; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + path: { + archive_format: string; + }; + }; + responses: { + /** + * response + */ + "302": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "202": { + "application/json": components["schemas"]["job"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "302": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runners": { + /** + * Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + runners?: components["schemas"]["runner"][]; + }; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runners/downloads": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["runner-application"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runners/registration-token": { + /** + * 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 + * ``` + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runners/remove-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 + * ``` + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runs": { + /** + * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters). + * + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + workflow_runs?: components["schemas"]["workflow-run"][]; + }; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + artifacts?: components["schemas"]["artifact"][]; + }; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "202": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + /** + * 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://developer.github.com/v3/#parameters). + */ + get: { + parameters: { + undefined: {}; + 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + jobs?: components["schemas"]["job"][]; + }; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "302": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + /** + * **Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see "[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage)." + * + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["workflow-run-usage"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/secrets": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + secrets?: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/secrets/public-key": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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) + * ``` + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response when creating a secret + */ + "201": any; + /** + * Response when updating a secret + */ + "204": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/workflows": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + workflows?: components["schemas"]["workflow"][]; + }; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["workflow"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + /** + * 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)." + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + /** + * 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://developer.github.com/v3/#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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + workflow_runs?: components["schemas"]["workflow-run"][]; + }; + }; + }; + }; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + /** + * **Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see "[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage)." + * + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["workflow-usage"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/assignees": { + /** + * Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/assignees/{assignee}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + path: { + assignee: string; + }; + }; + responses: { + /** + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + */ + "204": any; + /** + * Otherwise a `404` status code is returned. + */ + "404": { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/automated-security-fixes": { + /** + * 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)". + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + /** + * 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)". + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/branches": { + get: { + parameters: { + undefined: {}; + 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; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["short-branch"][]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/branches/{branch}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["branch-with-protection"]; + }; + "404": any; + "415": any; + }; + }; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["branch-protection"]; + }; + "404": any; + }; + }; + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["protected-branch"]; + }; + "403": any; + "404": any; + "415": any; + "422": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "403": any; + }; + }; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + post: { + parameters: { + undefined: {}; + }; + 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * No Content + */ + "204": any; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["protected-branch-pull-request-review"]; + }; + "422": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * No Content + */ + "204": any; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["protected-branch-admin-enforced"]; + }; + "404": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["protected-branch-admin-enforced"]; + }; + "404": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * No Content + */ + "204": any; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["status-check-policy"]; + }; + "404": any; + }; + }; + /** + * 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. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["status-check-policy"]; + }; + "404": any; + "422": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * No Content + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": string[]; + }; + "404": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": string[]; + }; + "403": any; + "404": any; + "422": any; + }; + }; + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": string[]; + }; + "404": any; + "422": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": string[]; + }; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["branch-restriction-policy"]; + }; + "404": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * No Content + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["integration"][]; + }; + "404": any; + }; + }; + /** + * 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. | + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["integration"][]; + }; + "422": any; + }; + }; + /** + * 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. | + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["integration"][]; + }; + "422": any; + }; + }; + /** + * 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. | + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["integration"][]; + }; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "404": any; + }; + }; + /** + * 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. | + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "422": any; + }; + }; + /** + * 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. | + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "422": any; + }; + }; + /** + * 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. | + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "404": any; + }; + }; + /** + * 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. | + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "422": any; + }; + }; + /** + * 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. | + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "422": any; + }; + }; + /** + * 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. | + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/check-runs": { + /** + * **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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["check-run"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + /** + * **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: { + parameters: { + undefined: {}; + }; + 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. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["check-run"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["check-annotation"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/check-suites": { + /** + * **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 "[Update repository preferences for check suites](https://developer.github.com/v3/checks/suites/#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["check-suite"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/check-suites/preferences": { + /** + * 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://developer.github.com/v3/checks/suites/#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["check-suite-preference"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + /** + * **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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["check-suite"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + /** + * **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. + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + check_runs?: components["schemas"]["check-run"][]; + }; + }; + }; + }; + }; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + /** + * 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/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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": any; + }; + }; + }; + "/repos/{owner}/{repo}/code-scanning/alerts": { + /** + * Lists all open code scanning alerts for the default branch (usually `master`) and protected branches in a repository. For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. GitHub Apps must have the `security_events` read permission to use this endpoint. + */ + get: { + parameters: { + undefined: {}; + 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 the ref doesn't match an existing ref + */ + "404": any; + "503": any; + }; + }; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + /** + * 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`. + */ + get: { + parameters: { + undefined: {}; + path: { + alert_number: number; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["code-scanning-alert-code-scanning-alert"]; + }; + "404": any; + "503": any; + }; + }; + /** + * Updates the status of a single code scanning alert. For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. + * GitHub Apps must have the `security_events` write permission to use this endpoint. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["code-scanning-alert-code-scanning-alert"]; + }; + /** + * When code scanning isn't available you can try again at a later time + */ + "503": any; + }; + }; + }; + "/repos/{owner}/{repo}/code-scanning/analyses": { + /** + * List the details of recent code scanning analyses for a repository. For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. GitHub Apps must have the `security_events` read permission to use this endpoint. + */ + get: { + parameters: { + undefined: {}; + 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"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/code-scanning/sarifs": { + /** + * Upload a SARIF file containing the results of a code scanning analysis to make the results available in a repository. + * For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. GitHub Apps must have the `security_events` write permission to use this endpoint. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "202": any; + /** + * Response if `commit_sha` or `ref` cannot be found + */ + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/collaborators": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["collaborator"][]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/collaborators/{username}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if user is a collaborator + */ + "204": any; + /** + * Response if user is not a collaborator + */ + "404": any; + }; + }; + /** + * 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. + * + * 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://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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response when a new invitation is created + */ + "201": { + "application/json": components["schemas"]["repository-invitation"]; + }; + /** + * Response when person is already a collaborator + */ + "204": any; + "403": any; + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/collaborators/{username}/permission": { + /** + * Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if user has admin permissions + */ + "200": { + "application/json": components["schemas"]["repository-collaborator-permission"]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/comments": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit-comment"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/comments/{comment_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit-comment"]; + }; + "404": any; + }; + }; + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit-comment"]; + }; + "404": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + /** + * List the reactions to a [commit comment](https://developer.github.com/v3/repos/comments/). + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + "404": any; + "415": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Reaction exists + */ + "200": { + "application/json": components["schemas"]["reaction"]; + }; + /** + * Reaction created + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + "415": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + /** + * **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://developer.github.com/v3/repos/comments/). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/commits": { + /** + * **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. | + */ + get: { + parameters: { + undefined: {}; + 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; + /** + * 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; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-commit"][]; + }; + "400": any; + "404": any; + "409": any; + "500": any; + }; + }; + }; + "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["branch-short"][]; + }; + "415": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + /** + * Use the `:commit_sha` to specify the commit that will have its comments listed. + */ + get: { + parameters: { + undefined: {}; + }; + 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://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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["commit-comment"]; + }; + "403": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-simple"][]; + }; + "415": any; + }; + }; + }; + "/repos/{owner}/{repo}/commits/{ref}": { + /** + * 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://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: + * | 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. | + */ + get: { + parameters: { + undefined: {}; + path: { + /** + * ref+ parameter + */ + ref: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit"]; + }; + "404": any; + "422": any; + "500": any; + }; + }; + }; + "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + /** + * **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. + */ + get: { + parameters: { + undefined: {}; + path: { + /** + * ref+ parameter + */ + ref: string; + }; + query: { + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + check_runs?: components["schemas"]["check-run"][]; + }; + }; + }; + }; + }; + "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + /** + * **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. + */ + get: { + parameters: { + undefined: {}; + path: { + /** + * ref+ parameter + */ + ref: string; + }; + query: { + /** + * Filters check suites by GitHub App `id`. + */ + app_id?: number; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + check_suites?: components["schemas"]["check-suite"][]; + }; + }; + }; + }; + }; + "/repos/{owner}/{repo}/commits/{ref}/status": { + /** + * 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` + */ + get: { + parameters: { + undefined: {}; + path: { + /** + * ref+ parameter + */ + ref: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["combined-commit-status"]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/commits/{ref}/statuses": { + /** + * 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`. + */ + get: { + parameters: { + undefined: {}; + path: { + /** + * ref+ parameter + */ + ref: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["status"][]; + }; + "301": any; + }; + }; + }; + "/repos/{owner}/{repo}/community/code_of_conduct": { + /** + * This method returns the contents of the repository's code of conduct file, if one is detected. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["code-of-conduct"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/community/profile": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["community-profile"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/compare/{base}...{head}": { + /** + * 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 [List commits](https://developer.github.com/v3/repos/commits/#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. | + */ + get: { + parameters: { + undefined: {}; + path: { + base: string; + head: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit-comparison"]; + }; + "404": any; + "500": any; + }; + }; + }; + "/repos/{owner}/{repo}/contents/{path}": { + /** + * 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. + * + * #### 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. + */ + get: { + parameters: { + undefined: {}; + path: { + /** + * 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": any; + "403": any; + "404": any; + }; + }; + /** + * Creates a new file or replaces an existing file in a repository. + */ + put: { + parameters: { + undefined: {}; + path: { + /** + * path+ parameter + */ + path: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["file-commit"]; + }; + /** + * response + */ + "201": { + "application/json": components["schemas"]["file-commit"]; + }; + "404": any; + "409": any; + "422": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + path: { + /** + * path+ parameter + */ + path: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["file-commit"]; + }; + "404": any; + "409": any; + "422": any; + "503": any; + }; + }; + }; + "/repos/{owner}/{repo}/contributors": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * Set to `1` or `true` to include anonymous contributors in results. + */ + anon?: string; + }; + }; + responses: { + /** + * Response if repository contains content + */ + "200": { + "application/json": components["schemas"]["contributor"][]; + }; + /** + * Response if repository is empty + */ + "204": any; + "403": any; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/deployments": { + /** + * Simple filtering of deployments is available via query parameters: + */ + get: { + parameters: { + undefined: {}; + 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; + }; + }; + 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://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. + * + * #### 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`. + */ + post: { + parameters: { + undefined: {}; + }; + 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": any; + }; + }; + }; + "/repos/{owner}/{repo}/deployments/{deployment_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["deployment"]; + }; + "404": any; + }; + }; + /** + * 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://developer.github.com/v3/repos/deployments/#create-a-deployment)" and "[Create a deployment status](https://developer.github.com/v3/repos/deployments/#create-a-deployment-status)." + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + /** + * Users with pull access can view deployment statuses for a deployment: + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["deployment-status"][]; + }; + "404": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["deployment-status"]; + }; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + /** + * Users with pull access can view a deployment status for a deployment: + */ + get: { + parameters: { + undefined: {}; + path: { + status_id: number; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["deployment-status"]; + }; + "404": any; + "415": any; + }; + }; + }; + "/repos/{owner}/{repo}/dispatches": { + /** + * 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/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. 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/events": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/forks": { + get: { + parameters: { + undefined: {}; + query: { + /** + * The sort order. Can be either `newest`, `oldest`, or `stargazers`. + */ + sort?: "newest" | "oldest" | "stargazers"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + "400": any; + }; + }; + /** + * 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) or [GitHub Premium Support](https://premium.githubsupport.com). + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "202": { + "application/json": components["schemas"]["repository"]; + }; + "400": any; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/git/blobs": { + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["short-blob"]; + }; + "403": any; + "404": any; + "409": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + /** + * The `content` in the response will always be Base64 encoded. + * + * _Note_: This API supports blobs up to 100 megabytes in size. + */ + get: { + parameters: { + undefined: {}; + path: { + file_sha: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["blob"]; + }; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/git/commits": { + /** + * 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. | + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["git-commit"]; + }; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + /** + * 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. | + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["git-commit"]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + /** + * 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-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`. + */ + get: { + parameters: { + undefined: {}; + path: { + /** + * ref+ parameter + */ + ref: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["git-ref"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/git/ref/{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://developer.github.com/v3/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://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)". + */ + get: { + parameters: { + undefined: {}; + path: { + /** + * ref+ parameter + */ + ref: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["git-ref"]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/git/refs": { + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["git-ref"]; + }; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/git/refs/{ref}": { + patch: { + parameters: { + undefined: {}; + path: { + /** + * ref+ parameter + */ + ref: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["git-ref"]; + }; + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + path: { + /** + * ref+ parameter + */ + ref: string; + }; + }; + responses: { + /** + * Empty response + */ + "204": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/git/tags": { + /** + * 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: + * | 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. | + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["git-tag"]; + }; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + /** + * **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. | + */ + get: { + parameters: { + undefined: {}; + path: { + tag_sha: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["git-tag"]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/git/trees": { + /** + * 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)." + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["git-tree"]; + }; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + path: { + 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": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/hooks": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["hook"][]; + }; + "404": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["hook"]; + }; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["hook"]; + }; + "404": any; + }; + }; + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["hook"]; + }; + "404": any; + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + /** + * This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + /** + * 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` + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/import": { + /** + * 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://developer.github.com/v3/migrations/source_imports/#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://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://developer.github.com/v3/migrations/source_imports/#update-an-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 an import](https://developer.github.com/v3/migrations/source_imports/#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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["import"]; + }; + "404": any; + }; + }; + /** + * Start a source import to a GitHub repository using GitHub Importer. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["import"]; + }; + "404": any; + "422": any; + }; + }; + /** + * 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. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["import"]; + }; + }; + }; + /** + * Stop an import for a repository. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/import/authors": { + /** + * 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://developer.github.com/v3/migrations/source_imports/#map-a-commit-author) endpoint allow you to provide correct Git author information. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["porter-author"][]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/import/authors/{author_id}": { + /** + * Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. + */ + patch: { + parameters: { + undefined: {}; + path: { + author_id: number; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["porter-author"]; + }; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/import/large_files": { + /** + * List files larger than 100MB found during the import + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["porter-large-file"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/import/lfs": { + /** + * 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/). + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["import"]; + }; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/installation": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["installation"]; + }; + "301": any; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/interaction-limits": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["interaction-limit"]; + }; + }; + }; + /** + * Temporarily restricts interactions to certain GitHub users within the given repository. You must have owner or admin access to set restrictions. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["interaction-limit"]; + }; + }; + }; + /** + * Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/invitations": { + /** + * When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository-invitation"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/invitations/{invitation_id}": { + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository-invitation"]; + }; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues": { + /** + * 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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + */ + get: { + parameters: { + undefined: {}; + 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; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-simple"][]; + }; + "301": any; + "404": any; + "422": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["issue"]; + }; + "403": any; + "404": any; + "410": any; + "422": any; + "503": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/comments": { + /** + * By default, Issue Comments are ordered by ascending ID. + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * Either `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-comment"][]; + }; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-comment"]; + }; + "404": any; + }; + }; + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-comment"]; + }; + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + /** + * List the reactions to an [issue comment](https://developer.github.com/v3/issues/comments/). + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + "404": any; + "415": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Reaction exists + */ + "200": { + "application/json": components["schemas"]["reaction"]; + }; + /** + * Reaction created + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + "415": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + /** + * **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://developer.github.com/v3/issues/comments/). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/events": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-event"][]; + }; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/events/{event_id}": { + get: { + parameters: { + undefined: {}; + path: { + event_id: number; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-event"]; + }; + "403": any; + "404": any; + "410": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/{issue_number}": { + /** + * 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/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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue"]; + }; + "301": any; + "304": any; + "404": any; + "410": any; + }; + }; + /** + * Issue owners and users with push access can edit an issue. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue"]; + }; + "301": any; + "403": any; + "404": any; + "410": any; + "422": any; + "503": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + /** + * Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["issue-simple"]; + }; + }; + }; + /** + * Removes one or more assignees from an issue. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-simple"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + /** + * Issue Comments are ordered by ascending ID. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-comment"][]; + }; + "404": any; + "410": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["issue-comment"]; + }; + "403": any; + "404": any; + "410": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/events": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-event-for-issue"][]; + }; + "410": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"][]; + }; + "410": any; + }; + }; + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"][]; + }; + "410": any; + "422": any; + }; + }; + /** + * Removes any previous labels and sets the new labels for an issue. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"][]; + }; + "410": any; + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "410": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + path: { + name: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"][]; + }; + "404": any; + "410": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + /** + * 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)." + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "403": any; + "404": any; + "410": any; + "422": any; + }; + }; + /** + * Users with push access can unlock an issue's conversation. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "403": any; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + /** + * List the reactions to an [issue](https://developer.github.com/v3/issues/). + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + "404": any; + "410": any; + "415": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + "415": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + /** + * **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://developer.github.com/v3/issues/). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue-event-for-issue"][]; + }; + "404": any; + "410": any; + "415": any; + }; + }; + }; + "/repos/{owner}/{repo}/keys": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["deploy-key"][]; + }; + }; + }; + /** + * You can create a read-only deploy key. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["deploy-key"]; + }; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/keys/{key_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["deploy-key"]; + }; + "404": any; + }; + }; + /** + * Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/labels": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"][]; + }; + "404": any; + }; + }; + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["label"]; + }; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/labels/{name}": { + get: { + parameters: { + undefined: {}; + path: { + name: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"]; + }; + "404": any; + }; + }; + patch: { + parameters: { + undefined: {}; + path: { + name: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"]; + }; + }; + }; + delete: { + parameters: { + undefined: {}; + path: { + name: string; + }; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/languages": { + /** + * Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["language"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/license": { + /** + * This method returns the contents of the repository's license file, if one is detected. + * + * Similar to [Get repository content](https://developer.github.com/v3/repos/contents/#get-repository-content), 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["license-content"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/merges": { + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Successful Response (The resulting merge commit) + */ + "201": { + "application/json": components["schemas"]["commit"]; + }; + "403": any; + /** + * response + */ + "404": { + "application/json": { message?: string; documentation_url?: string }; + }; + /** + * Merge conflict response + */ + "409": { + "application/json": { message?: string; documentation_url?: string }; + }; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/milestones": { + get: { + parameters: { + undefined: {}; + 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["milestone"][]; + }; + "404": any; + }; + }; + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["milestone"]; + }; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/milestones/{milestone_number}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["milestone"]; + }; + "404": any; + }; + }; + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["milestone"]; + }; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["label"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/notifications": { + /** + * List all notifications for the current user. + */ + get: { + parameters: { + undefined: {}; + }; + 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://developer.github.com/v3/activity/notifications/#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "202": any; + }; + }; + }; + "/repos/{owner}/{repo}/pages": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["page"]; + }; + "404": any; + }; + }; + /** + * Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["page"]; + }; + "409": any; + "415": any; + "422": any; + }; + }; + /** + * Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "400": any; + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + "415": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/pages/builds": { + get: { + parameters: { + undefined: {}; + }; + 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["page-build-status"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/pages/builds/latest": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["page-build"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/pages/builds/{build_id}": { + get: { + parameters: { + undefined: {}; + path: { + build_id: number; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["page-build"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/projects": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project"][]; + }; + "401": any; + "403": any; + "404": any; + "410": any; + "422": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["project"]; + }; + "401": any; + "403": any; + "404": any; + "410": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-simple"][]; + }; + "304": any; + "422": any; + }; + }; + /** + * 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://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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["pull-request"]; + }; + "403": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/comments": { + /** + * **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. + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review-comment"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + /** + * **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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review-comment"]; + }; + "404": any; + }; + }; + /** + * **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. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review-comment"]; + }; + }; + }; + /** + * Deletes a review comment. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + /** + * List the reactions to a [pull request review comment](https://developer.github.com/v3/pulls/comments/). + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["reaction"][]; + }; + "404": any; + "415": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Reaction exists + */ + "200": { + "application/json": components["schemas"]["reaction"]; + }; + /** + * Reaction created + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + "415": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + /** + * **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://developer.github.com/v3/pulls/comments/). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}": { + /** + * 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://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: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + */ + "200": { + "application/json": components["schemas"]["pull-request"]; + }; + "304": any; + "404": any; + "500": any; + }; + }; + /** + * 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. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request"]; + }; + "403": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + /** + * **Note:** Multi-line comments on pull requests are currently in public beta and subject to change. + * + * Lists all 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. + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review-comment"][]; + }; + }; + }; + /** + * **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 "[Create an issue comment](https://developer.github.com/v3/issues/comments/#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 [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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["pull-request-review-comment"]; + }; + "403": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["pull-request-review-comment"]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + /** + * 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://developer.github.com/v3/repos/commits/#list-commits) endpoint. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-commit"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + /** + * **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["diff-entry"][]; + }; + "422": any; + "500": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if pull request has been merged + */ + "204": any; + /** + * Response if pull request has not been merged + */ + "404": any; + }; + }; + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if merge was successful + */ + "200": { + "application/json": components["schemas"]["pull-request-merge-result"]; + }; + "403": any; + "404": any; + /** + * 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": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review-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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["pull-request-simple"]; + }; + "403": any; + /** + * Response if user is not a collaborator + */ + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + /** + * The list of reviews returns in chronological order. + */ + get: { + parameters: { + undefined: {}; + }; + 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://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. + * + * 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://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-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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review"]; + }; + "403": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review"]; + }; + "404": any; + }; + }; + /** + * Update the review summary comment with new text. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review"]; + }; + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review"]; + }; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + /** + * List comments for a specific pull request review. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["review-comment"][]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + /** + * **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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review"]; + }; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["pull-request-review"]; + }; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + /** + * Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "202": { + "application/json": { message?: string; url?: string }; + }; + "403": any; + "415": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/readme": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + 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": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/releases": { + /** + * 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-repository-tags). + * + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["release"][]; + }; + "404": any; + }; + }; + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["release"]; + }; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * 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. + */ + "200": { + "application/json": components["schemas"]["release-asset"]; + }; + "302": any; + "404": any; + "415": any; + }; + }; + /** + * Users with push access to the repository can edit a release asset. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["release-asset"]; + }; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/releases/latest": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["release"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/releases/tags/{tag}": { + /** + * Get a published release with the specified tag. + */ + get: { + parameters: { + undefined: {}; + path: { + /** + * tag+ parameter + */ + tag: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["release"]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/releases/{release_id}": { + /** + * **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). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * **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). + */ + "200": { + "application/json": components["schemas"]["release"]; + }; + "404": any; + }; + }; + /** + * Users with push access to the repository can edit a release. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["release"]; + }; + }; + }; + /** + * Users with push access to the repository can delete a release. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/releases/{release_id}/assets": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["release-asset"][]; + }; + }; + }; + /** + * 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. + * + * 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://developer.github.com/v3/repos/releases/#list-assets-for-a-release)" + * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://github.com/contact). + * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. + */ + post: { + parameters: { + undefined: {}; + query: { + name?: string; + label?: string; + }; + }; + responses: { + /** + * Response for successful upload + */ + "201": { + "application/json": components["schemas"]["release-asset"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/stargazers": { + /** + * 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://developer.github.com/v3/media/) via the `Accept` header: + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + "application/vnd.github.v3.star+json": components["schemas"]["stargazer"][]; + }; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/stats/code_frequency": { + /** + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + */ + "200": { + "application/json": components["schemas"]["code-frequency-stat"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/stats/commit_activity": { + /** + * Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["commit-activity"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/stats/contributors": { + /** + * 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 + */ + get: { + parameters: { + undefined: {}; + }; + 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"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/stats/participation": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * The array order is oldest week (index 0) to most recent week. + */ + "200": { + "application/json": components["schemas"]["participation-stats"]; + }; + "404": any; + }; + }; + }; + "/repos/{owner}/{repo}/stats/punch_card": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/statuses/{sha}": { + /** + * 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. + */ + post: { + parameters: { + undefined: {}; + path: { + sha: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["status"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/subscribers": { + /** + * Lists the people watching the specified repository. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/subscription": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if you subscribe to the repository + */ + "200": { + "application/json": components["schemas"]["repository-subscription"]; + }; + "403": any; + /** + * Response if you don't subscribe to the repository + */ + "404": any; + }; + }; + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + 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://developer.github.com/v3/activity/watching/#set-a-repository-subscription). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/tags": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["tag"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/tarball/{ref}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + path: { + ref: string; + }; + }; + responses: { + /** + * response + */ + "302": any; + }; + }; + }; + "/repos/{owner}/{repo}/teams": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/topics": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["topic"]; + }; + "404": any; + "415": any; + }; + }; + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["topic"]; + }; + "404": any; + "415": any; + "422": any; + }; + }; + }; + "/repos/{owner}/{repo}/traffic/clones": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["clone-traffic"]; + }; + "403": any; + }; + }; + }; + "/repos/{owner}/{repo}/traffic/popular/paths": { + /** + * Get the top 10 popular contents over the last 14 days. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["content-traffic"][]; + }; + "403": any; + }; + }; + }; + "/repos/{owner}/{repo}/traffic/popular/referrers": { + /** + * Get the top 10 referrers over the last 14 days. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["referrer-traffic"][]; + }; + "403": any; + }; + }; + }; + "/repos/{owner}/{repo}/traffic/views": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["view-traffic"]; + }; + "403": any; + }; + }; + }; + "/repos/{owner}/{repo}/transfer": { + /** + * 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/). + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "202": { + "application/json": components["schemas"]["repository"]; + }; + }; + }; + }; + "/repos/{owner}/{repo}/vulnerability-alerts": { + /** + * 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)". + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if repository is enabled with vulnerability alerts + */ + "204": any; + /** + * Response if repository is not enabled with vulnerability alerts + */ + "404": any; + }; + }; + /** + * 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)". + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + /** + * 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)". + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/repos/{owner}/{repo}/zipball/{ref}": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + path: { + ref: string; + }; + }; + responses: { + /** + * response + */ + "302": any; + }; + }; + }; + "/repos/{template_owner}/{template_repo}/generate": { + /** + * 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://developer.github.com/v3/repos/#get-a-repository) 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 + */ + post: { + parameters: { + path: { + template_owner: string; + template_repo: string; + }; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["repository"]; + }; + }; + }; + }; + "/repositories": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + query: { + visibility?: string; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + "304": any; + "422": any; + }; + }; + }; + "/scim/v2/enterprises/{enterprise}/Groups": { + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["scim-enterprise-group"]; + }; + }; + }; + }; + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + put: { + parameters: { + undefined: {}; + }; + 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). + */ + patch: { + parameters: { + undefined: {}; + }; + 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/scim/v2/enterprises/{enterprise}/Users": { + /** + * **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. + */ + get: { + parameters: { + undefined: {}; + }; + 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. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["scim-enterprise-user"]; + }; + }; + }; + }; + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + */ + get: { + parameters: { + undefined: {}; + }; + 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}`. + */ + put: { + parameters: { + undefined: {}; + }; + 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 + * } + * }] + * } + * ``` + */ + patch: { + parameters: { + undefined: {}; + }; + 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/scim/v2/organizations/{org}/Users": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + 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": any; + "400": any; + "403": any; + "404": any; + }; + }; + /** + * Provision organization membership for a user, and send an activation email to the email address. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/scim+json": components["schemas"]["scim-user"]; + }; + "304": any; + "400": any; + "403": any; + "404": any; + "409": any; + "500": any; + }; + }; + }; + "/scim/v2/organizations/{org}/Users/{scim_user_id}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/scim+json": components["schemas"]["scim-user"]; + }; + "304": any; + "403": any; + "404": any; + }; + }; + /** + * 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://developer.github.com/v3/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}`. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/scim+json": components["schemas"]["scim-user"]; + }; + "304": any; + "403": any; + "404": any; + }; + }; + /** + * 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 + * } + * }] + * } + * ``` + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/scim+json": components["schemas"]["scim-user"]; + }; + "304": any; + "400": any; + "403": any; + "404": any; + /** + * Too many requests + */ + "429": { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "403": any; + "404": any; + }; + }; + }; + "/search/code": { + /** + * Searches for query terms inside of a file. 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). + * + * 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. + */ + get: { + 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://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"; + }; + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + incomplete_results?: boolean; + items?: components["schemas"]["code-search-result-item"][]; + }; + }; + "304": any; + "403": any; + "422": any; + "503": any; + }; + }; + }; + "/search/commits": { + /** + * Find commits via various criteria on the default branch (usually `master`). 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). + * + * 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` + */ + get: { + 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://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"; + }; + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + incomplete_results?: boolean; + items?: components["schemas"]["commit-search-result-item"][]; + }; + }; + "304": any; + "415": any; + }; + }; + }; + "/search/issues": { + /** + * 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). + * + * 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, whick means the oldest issues appear first in the search results. + */ + get: { + 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://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"; + }; + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + incomplete_results?: boolean; + items?: components["schemas"]["issue-search-result-item"][]; + }; + }; + "304": any; + "403": any; + "422": any; + "503": any; + }; + }; + }; + "/search/labels": { + /** + * 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). + * + * 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. + */ + get: { + 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://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"; + }; + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + incomplete_results?: boolean; + items?: components["schemas"]["label-search-result-item"][]; + }; + }; + "304": any; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/search/repositories": { + /** + * 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). + * + * 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` + */ + get: { + 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://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"; + }; + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + incomplete_results?: boolean; + items?: components["schemas"]["repo-search-result-item"][]; + }; + }; + "304": any; + "422": any; + "503": any; + }; + }; + }; + "/search/topics": { + /** + * 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). 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://developer.github.com/v3/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. + */ + get: { + 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://developer.github.com/v3/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": any; + "415": any; + }; + }; + }; + "/search/users": { + /** + * 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). + * + * 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. + */ + get: { + 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://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"; + }; + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": { + total_count?: number; + incomplete_results?: boolean; + items?: components["schemas"]["user-search-result-item"][]; + }; + }; + "304": any; + "422": any; + "503": any; + }; + }; + }; + "/teams/{team_id}": { + /** + * **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://developer.github.com/v3/teams/#get-a-team-by-name) endpoint. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-full"]; + }; + "404": any; + }; + }; + /** + * **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://developer.github.com/v3/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`. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-full"]; + }; + "403": any; + "404": any; + "422": any; + }; + }; + /** + * **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://developer.github.com/v3/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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + "422": any; + }; + }; + }; + "/teams/{team_id}/discussions": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://developer.github.com/v3/teams/discussions/#list-discussions) endpoint. + * + * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + get: { + parameters: { + undefined: {}; + }; + 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://developer.github.com/v3/teams/discussions/#create-a-discussion) endpoint. + * + * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + }; + "/teams/{team_id}/discussions/{discussion_number}": { + /** + * **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://developer.github.com/v3/teams/discussions/#get-a-discussion) endpoint. + * + * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + get: { + parameters: { + undefined: {}; + }; + 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://developer.github.com/v3/teams/discussions/#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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + patch: { + parameters: { + undefined: {}; + }; + 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://developer.github.com/v3/teams/discussions/#delete-a-discussion) endpoint. + * + * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/teams/{team_id}/discussions/{discussion_number}/comments": { + /** + * **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://developer.github.com/v3/teams/discussion_comments/#list-discussion-comments) endpoint. + * + * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + get: { + parameters: { + undefined: {}; + }; + 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://developer.github.com/v3/teams/discussion_comments/#create-a-discussion-comment) endpoint. + * + * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + }; + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + /** + * **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://developer.github.com/v3/teams/discussion_comments/#get-a-discussion-comment) endpoint. + * + * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + get: { + parameters: { + undefined: {}; + }; + 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://developer.github.com/v3/teams/discussion_comments/#update-a-discussion-comment) endpoint. + * + * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + patch: { + parameters: { + undefined: {}; + }; + 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://developer.github.com/v3/teams/discussion_comments/#delete-a-discussion-comment) endpoint. + * + * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment) endpoint. + * + * List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * 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"; + }; + }; + 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://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment) endpoint. + * + * Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + }; + }; + }; + "/teams/{team_id}/discussions/{discussion_number}/reactions": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion) endpoint. + * + * List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + get: { + parameters: { + undefined: {}; + query: { + /** + * 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"; + }; + }; + 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://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion) endpoint. + * + * Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. + */ + post: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["reaction"]; + }; + }; + }; + }; + "/teams/{team_id}/invitations": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://developer.github.com/v3/teams/members/#list-pending-team-invitations) endpoint. + * + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-invitation"][]; + }; + }; + }; + }; + "/teams/{team_id}/members": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://developer.github.com/v3/teams/members/#list-team-members) endpoint. + * + * Team members will include the members of child teams. + */ + get: { + parameters: { + undefined: {}; + 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "404": any; + }; + }; + }; + "/teams/{team_id}/members/{username}": { + /** + * The "Get team member" endpoint (described below) is deprecated. + * + * We recommend using the [Get team membership for a user](https://developer.github.com/v3/teams/members/#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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if user is a member + */ + "204": any; + /** + * Response if user is not a member + */ + "404": any; + }; + }; + /** + * The "Add team member" endpoint (described below) is deprecated. + * + * We recommend using the [Add or update team membership for a user](https://developer.github.com/v3/teams/members/#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://developer.github.com/v3/#http-verbs)." + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "403": any; + /** + * Response if team synchronization is set up + */ + "404": any; + /** + * 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://developer.github.com/v3/teams/members/#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/)." + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + /** + * Response if team synchronization is setup + */ + "404": any; + }; + }; + }; + "/teams/{team_id}/memberships/{username}": { + /** + * **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://developer.github.com/v3/teams/members/#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://developer.github.com/v3/teams/#create-a-team). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-membership"]; + }; + "404": any; + }; + }; + /** + * **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://developer.github.com/v3/teams/members/#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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-membership"]; + }; + /** + * Response if team synchronization is set up + */ + "403": any; + "404": any; + /** + * 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://developer.github.com/v3/teams/members/#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/)." + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + /** + * Response if team synchronization is set up + */ + "403": any; + }; + }; + }; + "/teams/{team_id}/projects": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://developer.github.com/v3/teams/#list-team-projects) endpoint. + * + * Lists the organization projects for a team. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-project"][]; + }; + "404": any; + "415": any; + }; + }; + }; + "/teams/{team_id}/projects/{project_id}": { + /** + * **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://developer.github.com/v3/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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-project"]; + }; + /** + * Response if project is not managed by this team + */ + "404": any; + "415": any; + }; + }; + /** + * **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://developer.github.com/v3/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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + /** + * Response if the project is not owned by the organization + */ + "403": { + "application/json": { message?: string; documentation_url?: string }; + }; + "404": any; + "415": any; + "422": any; + }; + }; + /** + * **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://developer.github.com/v3/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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "404": any; + "415": any; + "422": any; + }; + }; + }; + "/teams/{team_id}/repos": { + /** + * **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://developer.github.com/v3/teams/#list-team-repositories) endpoint. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + "404": any; + }; + }; + }; + "/teams/{team_id}/repos/{owner}/{repo}": { + /** + * **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://developer.github.com/v3/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://developer.github.com/v3/media/) via the `Accept` header: + */ + get: { + parameters: { + undefined: {}; + }; + 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": any; + /** + * Response if repository is not managed by this team + */ + "404": any; + }; + }; + /** + * **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://developer.github.com/v3/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://developer.github.com/v3/#http-verbs)." + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "403": any; + "422": any; + }; + }; + /** + * **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://developer.github.com/v3/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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + }; + }; + }; + "/teams/{team_id}/team-sync/group-mappings": { + /** + * **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://developer.github.com/v3/teams/team_sync/#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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["group-mapping"]; + }; + "403": any; + "404": any; + }; + }; + /** + * **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://developer.github.com/v3/teams/team_sync/#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. + */ + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["group-mapping"]; + }; + "403": any; + "422": any; + }; + }; + }; + "/teams/{team_id}/teams": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://developer.github.com/v3/teams/#list-child-teams) endpoint. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if child teams exist + */ + "200": { + "application/json": components["schemas"]["team"][]; + }; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/user": { + /** + * 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. + */ + get: { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": + | components["schemas"]["private-user"] + | components["schemas"]["public-user"]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + /** + * **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. + */ + patch: { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["private-user"]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/user/blocks": { + /** + * List the users you've blocked on your personal account. + */ + get: { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + "415": any; + }; + }; + }; + "/user/blocks/{username}": { + /** + * If the user is blocked: + * + * If the user is not blocked: + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * If the user is blocked: + */ + "204": any; + "304": any; + "401": any; + "403": any; + /** + * If the user is not blocked: + */ + "404": { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + "422": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + }; + "/user/email/visibility": { + /** + * Sets the visibility for your primary email addresses. + */ + patch: { + parameters: {}; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["email"][]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/user/emails": { + /** + * Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["email"][]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + /** + * This endpoint is accessible with the `user` scope. + */ + post: { + parameters: {}; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["email"][]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + "422": any; + }; + }; + /** + * This endpoint is accessible with the `user` scope. + */ + delete: { + parameters: {}; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/user/followers": { + /** + * Lists the people following the authenticated user. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + }; + "/user/following": { + /** + * Lists the people who the authenticated user follows. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + }; + "/user/following/{username}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if the person is followed by the authenticated user + */ + "204": any; + "304": any; + "401": any; + "403": any; + /** + * 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://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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + /** + * Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + }; + "/user/gpg_keys": { + /** + * 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/). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gpg-key"][]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + /** + * 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/). + */ + post: { + parameters: {}; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["gpg-key"]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/user/gpg_keys/{gpg_key_id}": { + /** + * 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/). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gpg-key"]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + /** + * 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/). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/user/installations": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * You can find the permissions for the installation under the `permissions` key. + */ + "200": { + "application/json": { + total_count?: number; + installations?: components["schemas"]["installation"][]; + }; + }; + "304": any; + "401": any; + "403": any; + "415": any; + }; + }; + }; + "/user/installations/{installation_id}/repositories": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + 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": any; + "403": any; + "404": any; + }; + }; + }; + "/user/installations/{installation_id}/repositories/{repository_id}": { + /** + * 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. + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "403": any; + "404": any; + }; + }; + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "403": any; + "404": any; + }; + }; + }; + "/user/issues": { + /** + * 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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + */ + get: { + 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"; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + }; + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["issue"][]; + }; + "304": any; + "404": any; + }; + }; + }; + "/user/keys": { + /** + * 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/). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["key"][]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + /** + * 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/). + */ + post: { + parameters: {}; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["key"]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/user/keys/{key_id}": { + /** + * 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/). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["key"]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + /** + * 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/). + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + }; + "/user/marketplace_purchases": { + /** + * Lists the active subscriptions for the authenticated user. 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/). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["user-marketplace-purchase"][]; + }; + "304": any; + "401": any; + "404": any; + }; + }; + }; + "/user/marketplace_purchases/stubbed": { + /** + * Lists the active subscriptions for the authenticated user. 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/). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["user-marketplace-purchase"][]; + }; + "304": any; + "401": any; + }; + }; + }; + "/user/memberships/orgs": { + get: { + 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"; + }; + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-membership"][]; + }; + "304": any; + "401": any; + "403": any; + "422": any; + }; + }; + }; + "/user/memberships/orgs/{org}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-membership"]; + }; + "403": any; + "404": any; + }; + }; + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["org-membership"]; + }; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/user/migrations": { + /** + * Lists all migrations a user has started. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["migration"][]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + /** + * Initiates the generation of a user migration archive. + */ + post: { + parameters: {}; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["migration"]; + }; + "304": any; + "401": any; + "403": any; + "422": any; + }; + }; + }; + "/user/migrations/{migration_id}": { + /** + * 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). + */ + get: { + parameters: { + undefined: {}; + query: { + exclude?: string[]; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["migration"]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + }; + "/user/migrations/{migration_id}/archive": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "302": any; + "304": any; + "401": any; + "403": any; + }; + }; + /** + * 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://developer.github.com/v3/migrations/users/#list-user-migrations) and [Get a user migration status](https://developer.github.com/v3/migrations/users/#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + }; + "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + /** + * 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. + */ + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + }; + "/user/migrations/{migration_id}/repositories": { + /** + * Lists all the repositories for this user migration. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + "404": any; + }; + }; + }; + "/user/orgs": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-simple"][]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + }; + "/user/projects": { + post: { + parameters: {}; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["project"]; + }; + "304": any; + "401": any; + "403": any; + "415": any; + "422": any; + }; + }; + }; + "/user/public_emails": { + /** + * Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://developer.github.com/v3/users/emails/#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["email"][]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + }; + "/user/repos": { + /** + * 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. + */ + get: { + 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"; + }; + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository"][]; + }; + "304": any; + "401": any; + "403": any; + /** + * Response definition missing + */ + "418": any; + "422": any; + }; + }; + /** + * 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 + */ + post: { + parameters: {}; + responses: { + /** + * response + */ + "201": { + "application/json": components["schemas"]["repository"]; + }; + "304": any; + "400": any; + "401": any; + "403": any; + "404": any; + "422": any; + }; + }; + }; + "/user/repository_invitations": { + /** + * When authenticating as a user, this endpoint will list all currently open repository invitations for that user. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository-invitation"][]; + }; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + }; + "/user/repository_invitations/{invitation_id}": { + patch: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "403": any; + "404": any; + "409": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "403": any; + "404": any; + "409": any; + }; + }; + }; + "/user/starred": { + /** + * Lists repositories the authenticated user has starred. + * + * 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: + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository"][]; + "application/vnd.github.v3.star+json": components["schemas"]["starred-repository"][]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + }; + "/user/starred/{owner}/{repo}": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Response if this repository is starred by you + */ + "204": any; + "304": any; + "401": any; + "403": any; + /** + * 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://developer.github.com/v3/#http-verbs)." + */ + put: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + delete: { + parameters: { + undefined: {}; + }; + responses: { + /** + * Empty response + */ + "204": any; + "304": any; + "401": any; + "403": any; + "404": any; + }; + }; + }; + "/user/subscriptions": { + /** + * Lists repositories the authenticated user is watching. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + "304": any; + "401": any; + "403": any; + }; + }; + }; + "/user/teams": { + /** + * 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/). + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["team-full"][]; + }; + "304": any; + "403": any; + "404": any; + }; + }; + }; + "/users": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + "304": any; + }; + }; + }; + "/users/{username}": { + /** + * 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/)". + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": + | components["schemas"]["private-user"] + | components["schemas"]["public-user"]; + }; + "404": any; + }; + }; + }; + "/users/{username}/events": { + /** + * If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + "/users/{username}/events/orgs/{org}": { + /** + * This is the user's organization dashboard. You must be authenticated as the user to view this. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + "/users/{username}/events/public": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + "/users/{username}/followers": { + /** + * Lists the people following the specified user. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "/users/{username}/following": { + /** + * Lists the people who the specified user follows. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "/users/{username}/following/{target_user}": { + get: { + parameters: { + undefined: {}; + path: { + target_user: string; + }; + }; + responses: { + /** + * Response if the user follows the target user + */ + "204": any; + /** + * Response if the user does not follow the target user + */ + "404": any; + }; + }; + }; + "/users/{username}/gists": { + /** + * Lists public gists for the specified user: + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["base-gist"][]; + }; + "422": any; + }; + }; + }; + "/users/{username}/gpg_keys": { + /** + * Lists the GPG keys for a user. This information is accessible by anyone. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["gpg-key"][]; + }; + }; + }; + }; + "/users/{username}/hovercard": { + /** + * 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 + * ``` + */ + get: { + parameters: { + undefined: {}; + 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": any; + "422": any; + }; + }; + }; + "/users/{username}/installation": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["installation"]; + }; + }; + }; + }; + "/users/{username}/keys": { + /** + * Lists the _verified_ public SSH keys for a user. This is accessible by anyone. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["key-simple"][]; + }; + }; + }; + }; + "/users/{username}/orgs": { + /** + * 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://developer.github.com/v3/orgs/#list-organizations-for-the-authenticated-user) API instead. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "/users/{username}/projects": { + get: { + parameters: { + undefined: {}; + query: { + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["project"][]; + }; + "415": any; + "422": any; + }; + }; + }; + "/users/{username}/received_events": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + "/users/{username}/received_events/public": { + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + "/users/{username}/repos": { + /** + * Lists public repositories for the specified user. + */ + get: { + parameters: { + undefined: {}; + 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"; + }; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + "/users/{username}/settings/billing/actions": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["actions-billing-usage"]; + }; + }; + }; + }; + "/users/{username}/settings/billing/packages": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["packages-billing-usage"]; + }; + }; + }; + }; + "/users/{username}/settings/billing/shared-storage": { + /** + * 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. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["combined-billing-usage"]; + }; + }; + }; + }; + "/users/{username}/starred": { + /** + * Lists repositories a user has starred. + * + * 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: + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["repository"][]; + "application/vnd.github.v3.star+json": components["schemas"]["starred-repository"][]; + }; + }; + }; + }; + "/users/{username}/subscriptions": { + /** + * Lists repositories a user is watching. + */ + get: { + parameters: { + undefined: {}; + }; + responses: { + /** + * response + */ + "200": { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + "/zen": { + /** + * Get a random sentence from the Zen of GitHub + */ + get: { + responses: { + /** + * response + */ + "200": { + "text/plain": string; + }; + }; + }; + }; +} + +export interface components { + 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[]; + }; + /** + * 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; + app_slug: string; + suspended_by?: components["schemas"]["simple-user"] | null; + suspended_at?: string | null; + contact_email?: string | null; + }; + /** + * 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; + template_repository?: string; + 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; + }; + /** + * 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: { [key: string]: any }; + /** + * Describe whether all repositories have been selected or there's a selection involved + */ + repository_selection: "all" | "selected"; + single_file_name: string | null; + 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; + }; + "runner-groups-enterprise": { + id?: number; + name?: string; + visibility?: string; + default?: boolean; + selected_organizations_url?: string; + runners_url?: string; + }; + /** + * 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; + }; + /** + * 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"; + }; + "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; + }; + /** + * 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: { + id?: number; + node_id?: string; + url?: string; + name?: string; + description?: string | null; + color?: string; + 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; + 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: string; + 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?: { + MD5_RSA?: string; + MD5_DSA?: string; + SHA256_RSA?: string; + SHA256_DSA?: string; + }; + hooks?: string[]; + web?: string[]; + api?: string[]; + git?: string[]; + pages?: string[]; + importer?: string[]; + github_services_sha?: string; + installed_version?: 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?: string; + 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; + }; + "runner-groups-org": { + id?: number; + name?: string; + visibility?: string; + default?: boolean; + selected_repositories_url?: string; + runners_url?: string; + inherited?: 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; + }; + /** + * 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; + }; + /** + * Interaction limit settings. + */ + "interaction-limit": { + /** + * The interaction limit to enable. + */ + limit: "existing_users" | "contributors_only" | "collaborators_only"; + origin: string; + expires_at: string; + }; + /** + * 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 + */ + organization_permission?: "read" | "write" | "admin" | "none"; + /** + * Whether or not this project can be seen by everyone. + */ + private?: boolean; + cards_url?: string; + permissions?: { read: boolean; write: boolean; admin: 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; + organization_permission?: string; + 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?: { + 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; + template_repository?: string; + 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; + }; + /** + * 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; + }; + "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; + 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 | null; + updated_at: string | null; + /** + * 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 | null; + sha: string | null; + 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: string | 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: string | null; + conclusion: string | 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 code scanning alert number. + */ + "code-scanning-alert-number": number; + /** + * The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "code-scanning-alert-created-at": string; + /** + * The REST API URL of the alert resource. + */ + "code-scanning-alert-url": string; + /** + * The GitHub URL of the alert resource. + */ + "code-scanning-alert-html-url": string; + "code-scanning-alert-dismissed-by": + | (components["schemas"]["simple-user"] | "null") + | null; + /** + * 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"]["code-scanning-alert-number"]; + created_at?: components["schemas"]["code-scanning-alert-created-at"]; + url?: components["schemas"]["code-scanning-alert-url"]; + html_url?: components["schemas"]["code-scanning-alert-html-url"]; + state?: components["schemas"]["code-scanning-alert-state"]; + dismissed_by?: components["schemas"]["code-scanning-alert-dismissed-by"]; + 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": any[] | null; + "code-scanning-alert-code-scanning-alert": { + number?: components["schemas"]["code-scanning-alert-number"]; + created_at?: components["schemas"]["code-scanning-alert-created-at"]; + url?: components["schemas"]["code-scanning-alert-url"]; + html_url?: components["schemas"]["code-scanning-alert-html-url"]; + instances?: components["schemas"]["code-scanning-alert-instances"]; + state?: components["schemas"]["code-scanning-alert-state"]; + dismissed_by?: components["schemas"]["code-scanning-alert-dismissed-by"]; + 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; + /** + * 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; + }; + /** + * 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 hte 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?: string; + insecure_ssl?: string; + content_type?: string; + digest?: string; + secret?: string; + 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; + }; + /** + * 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; + }; + /** + * 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?: { + 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; + }[]; + }; + /** + * 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"; + 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; + }; + /** + * 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/tests/v3/expected/manifold.ts b/tests/v3/expected/manifold.ts index 239fd60a3..79c677f5d 100644 --- a/tests/v3/expected/manifold.ts +++ b/tests/v3/expected/manifold.ts @@ -3,6 +3,624 @@ * Do not make direct changes to the file. */ +export interface paths { + "/regions/": { + get: { + parameters: { + query: { + /** + * Filter results to only include the regions that have this location. + */ + location?: string; + /** + * Filter results to only include the regions that are on this + * platform. + */ + platform?: string; + }; + }; + responses: { + /** + * A list of regions. + */ + "200": { + "application/json": components["schemas"]["Region"][]; + }; + /** + * Unexpected Error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + post: { + responses: { + /** + * Complete region object + */ + "201": { + "application/json": components["schemas"]["Region"]; + }; + /** + * Invalid request provided + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Region already exists for that platform and location + */ + "409": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected Error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "/regions/{id}": { + get: { + parameters: { + path: { + /** + * ID of the region to lookup, stored as a base32 encoded 18 byte identifier. + */ + id: string; + }; + }; + responses: { + /** + * A region. + */ + "200": { + "application/json": components["schemas"]["Region"]; + }; + /** + * Provided Region ID is Invalid + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Region could not be found + */ + "404": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected Error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + patch: { + parameters: { + path: { + /** + * ID of the region to lookup, stored as a base32 encoded 18 byte identifier. + */ + id: string; + }; + }; + responses: { + /** + * Complete region object + */ + "200": { + "application/json": components["schemas"]["Region"]; + }; + /** + * Invalid request provided + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected Error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "/providers/": { + get: { + parameters: { + query: { + /** + * Filter results to only include those that have this label. + */ + label?: string; + }; + }; + responses: { + /** + * A list of providers. + */ + "200": { + "application/json": components["schemas"]["Provider"][]; + }; + /** + * Unexpected Error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + post: { + responses: { + /** + * Complete provider object + */ + "201": { + "application/json": components["schemas"]["Provider"]; + }; + /** + * Invalid request provided + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Forbidden + */ + "403": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Provider already exists with that label + */ + "409": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected Error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "/providers/{id}": { + get: { + parameters: { + path: { + /** + * ID of the provider to lookup, stored as a base32 encoded 18 byte identifier. + */ + id: string; + }; + }; + responses: { + /** + * A provider. + */ + "200": { + "application/json": components["schemas"]["Provider"]; + }; + /** + * Unknown provider error + */ + "404": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected Error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + patch: { + parameters: { + path: { + /** + * ID of the provider to update, stored as a base32 encoded 18 byte identifier. + */ + id: string; + }; + }; + responses: { + /** + * Complete provider object + */ + "200": { + "application/json": components["schemas"]["Provider"]; + }; + /** + * Invalid request provided + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Forbidden + */ + "403": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Provider not found + */ + "404": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Provider already exists with that label + */ + "409": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected Error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "/products/": { + get: { + parameters: { + query: { + /** + * Base32 encoded 18 byte identifier of the provider that these + * products must belong to. + */ + provider_id?: string; + /** + * Filter results to only include those that have this label. + */ + label?: string; + /** + * Return only products matching at least one of the tags. + */ + tags?: string[]; + }; + }; + responses: { + /** + * A product. + */ + "200": { + "application/json": components["schemas"]["Product"][]; + }; + /** + * Invalid provider_id supplied + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected Error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + post: { + responses: { + /** + * Complete product object + */ + "201": { + "application/json": components["schemas"]["Product"]; + }; + /** + * Invalid request provided + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Forbidden + */ + "403": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Product already exists with that label + */ + "409": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected Error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "/internal/products": { + get: { + parameters: { + query: { + /** + * Base32 encoded 18 byte identifier of the provider that these + * products must belong to. + */ + provider_id?: string; + /** + * Filter results to only include those that have this label. + */ + label?: string; + /** + * Return only products matching at least one of the tags. + */ + tags?: string[]; + /** + * Return product listings without plan information + */ + include_plans?: boolean; + }; + }; + responses: { + /** + * A product. + */ + "200": { + "application/json": components["schemas"]["ExpandedProduct"][]; + }; + /** + * Invalid provider_id supplied + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected Error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "/products/{id}": { + get: { + parameters: { + path: { + /** + * ID of the product to lookup, stored as a base32 encoded 18 byte + * identifier. + */ + id: string; + }; + }; + responses: { + /** + * A product. + */ + "200": { + "application/json": components["schemas"]["Product"]; + }; + /** + * Invalid Product ID + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Product not found error + */ + "404": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + patch: { + parameters: { + path: { + /** + * ID of the product to lookup, stored as a base32 encoded 18 byte + * identifier. + */ + id: string; + }; + }; + responses: { + /** + * Complete product object + */ + "200": { + "application/json": components["schemas"]["Product"]; + }; + /** + * Invalid Product ID + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Product not found error + */ + "404": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "/plans/{id}": { + get: { + parameters: { + path: { + /** + * ID of the plan to lookup, stored as a base32 encoded 18 byte + * identifier. + */ + id: string; + }; + }; + responses: { + /** + * A plan. + */ + "200": { + "application/json": components["schemas"]["ExpandedPlan"]; + }; + /** + * Invalid Plan ID Provided + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unknown plan error + */ + "404": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected error + */ + default: { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + patch: { + parameters: { + path: { + /** + * ID of the plan to lookup, stored as a base32 encoded 18 byte + * identifier. + */ + id: string; + }; + }; + responses: { + /** + * Complete product plan + */ + "200": { + "application/json": components["schemas"]["Plan"]; + }; + /** + * Invalid Plan ID + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Plan not found error + */ + "404": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; + "/plans/": { + get: { + parameters: { + query: { + /** + * Return the plans that are associated with this product. + */ + product_id: string[]; + /** + * Filter results to only include those that have this label. + */ + label?: string; + }; + }; + responses: { + /** + * A list of plans for the given product. + */ + "200": { + "application/json": components["schemas"]["ExpandedPlan"][]; + }; + /** + * Invalid Parameters Provided + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Could not find product + */ + "404": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + post: { + responses: { + /** + * Complete plan object + */ + "201": { + "application/json": components["schemas"]["Plan"]; + }; + /** + * Invalid request provided + */ + "400": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Forbidden + */ + "403": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Plan already exists with that label + */ + "409": { + "application/json": components["schemas"]["Error"]; + }; + /** + * Unexpected Error + */ + "500": { + "application/json": components["schemas"]["Error"]; + }; + }; + }; + }; +} + export interface components { schemas: { /** diff --git a/tests/v3/expected/petstore.ts b/tests/v3/expected/petstore.ts index 9b6991fac..5e103eea6 100644 --- a/tests/v3/expected/petstore.ts +++ b/tests/v3/expected/petstore.ts @@ -3,6 +3,416 @@ * Do not make direct changes to the file. */ +export interface paths { + "/pet": { + put: { + responses: { + /** + * Invalid ID supplied + */ + "400": any; + /** + * Pet not found + */ + "404": any; + /** + * Validation exception + */ + "405": any; + }; + }; + post: { + responses: { + /** + * Invalid input + */ + "405": any; + }; + }; + }; + "/pet/findByStatus": { + /** + * Multiple status values can be provided with comma separated strings + */ + get: { + parameters: { + query: { + /** + * Status values that need to be considered for filter + */ + status: ("available" | "pending" | "sold")[]; + }; + }; + responses: { + /** + * successful operation + */ + "200": { + "application/xml": components["schemas"]["Pet"][]; + "application/json": components["schemas"]["Pet"][]; + }; + /** + * Invalid status value + */ + "400": any; + }; + }; + }; + "/pet/findByTags": { + /** + * Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + */ + get: { + parameters: { + query: { + /** + * Tags to filter by + */ + tags: string[]; + }; + }; + responses: { + /** + * successful operation + */ + "200": { + "application/xml": components["schemas"]["Pet"][]; + "application/json": components["schemas"]["Pet"][]; + }; + /** + * Invalid tag value + */ + "400": any; + }; + }; + }; + "/pet/{petId}": { + /** + * Returns a single pet + */ + get: { + parameters: { + path: { + /** + * ID of pet to return + */ + petId: number; + }; + }; + responses: { + /** + * successful operation + */ + "200": { + "application/xml": components["schemas"]["Pet"]; + "application/json": components["schemas"]["Pet"]; + }; + /** + * Invalid ID supplied + */ + "400": any; + /** + * Pet not found + */ + "404": any; + }; + }; + post: { + parameters: { + path: { + /** + * ID of pet that needs to be updated + */ + petId: number; + }; + }; + responses: { + /** + * Invalid input + */ + "405": any; + }; + }; + delete: { + parameters: { + header: { + api_key?: string; + }; + path: { + /** + * Pet id to delete + */ + petId: number; + }; + }; + responses: { + /** + * Invalid ID supplied + */ + "400": any; + /** + * Pet not found + */ + "404": any; + }; + }; + }; + "/pet/{petId}/uploadImage": { + post: { + parameters: { + path: { + /** + * ID of pet to update + */ + petId: number; + }; + }; + responses: { + /** + * successful operation + */ + "200": { + "application/json": components["schemas"]["ApiResponse"]; + }; + }; + }; + }; + "/store/inventory": { + /** + * Returns a map of status codes to quantities + */ + get: { + responses: { + /** + * successful operation + */ + "200": { + "application/json": { [key: string]: number }; + }; + }; + }; + }; + "/store/order": { + post: { + responses: { + /** + * successful operation + */ + "200": { + "application/xml": components["schemas"]["Order"]; + "application/json": components["schemas"]["Order"]; + }; + /** + * Invalid Order + */ + "400": any; + }; + }; + }; + "/store/order/{orderId}": { + /** + * For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions + */ + get: { + parameters: { + path: { + /** + * ID of pet that needs to be fetched + */ + orderId: number; + }; + }; + responses: { + /** + * successful operation + */ + "200": { + "application/xml": components["schemas"]["Order"]; + "application/json": components["schemas"]["Order"]; + }; + /** + * Invalid ID supplied + */ + "400": any; + /** + * Order not found + */ + "404": any; + }; + }; + /** + * For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors + */ + delete: { + parameters: { + path: { + /** + * ID of the order that needs to be deleted + */ + orderId: number; + }; + }; + responses: { + /** + * Invalid ID supplied + */ + "400": any; + /** + * Order not found + */ + "404": any; + }; + }; + }; + "/user": { + /** + * This can only be done by the logged in user. + */ + post: { + responses: { + /** + * successful operation + */ + default: any; + }; + }; + }; + "/user/createWithArray": { + post: { + responses: { + /** + * successful operation + */ + default: any; + }; + }; + }; + "/user/createWithList": { + post: { + responses: { + /** + * successful operation + */ + default: any; + }; + }; + }; + "/user/login": { + get: { + parameters: { + query: { + /** + * The user name for login + */ + username: string; + /** + * The password for login in clear text + */ + password: string; + }; + }; + responses: { + /** + * successful operation + */ + "200": { + "application/xml": string; + "application/json": string; + }; + /** + * Invalid username/password supplied + */ + "400": any; + }; + }; + }; + "/user/logout": { + get: { + responses: { + /** + * successful operation + */ + default: any; + }; + }; + }; + "/user/{username}": { + get: { + parameters: { + path: { + /** + * The name that needs to be fetched. Use user1 for testing. + */ + username: string; + }; + }; + responses: { + /** + * successful operation + */ + "200": { + "application/xml": components["schemas"]["User"]; + "application/json": components["schemas"]["User"]; + }; + /** + * Invalid username supplied + */ + "400": any; + /** + * User not found + */ + "404": any; + }; + }; + /** + * This can only be done by the logged in user. + */ + put: { + parameters: { + path: { + /** + * name that need to be updated + */ + username: string; + }; + }; + responses: { + /** + * Invalid user supplied + */ + "400": any; + /** + * User not found + */ + "404": any; + }; + }; + /** + * This can only be done by the logged in user. + */ + delete: { + parameters: { + path: { + /** + * The name that needs to be deleted + */ + username: string; + }; + }; + responses: { + /** + * Invalid username supplied + */ + "400": any; + /** + * User not found + */ + "404": any; + }; + }; + }; +} + export interface components { schemas: { Order: { diff --git a/tests/v3/expected/stripe.ts b/tests/v3/expected/stripe.ts index f37c266c9..f9891b7c9 100644 --- a/tests/v3/expected/stripe.ts +++ b/tests/v3/expected/stripe.ts @@ -3,6 +3,12884 @@ * Do not make direct changes to the file. */ +export interface paths { + "/v1/3d_secure": { + /** + *

Initiate 3D Secure authentication.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["three_d_secure"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/3d_secure/{three_d_secure}": { + /** + *

Retrieves a 3D Secure object.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + three_d_secure: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["three_d_secure"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account": { + /** + *

With Connect, you can delete Custom or Express accounts you manage.

+ * + *

Accounts created using test-mode keys can be deleted at any time. Accounts created using live-mode keys can only be deleted once all balances are zero.

+ * + *

If you want to delete your own account, use the account information tab in your account settings instead.

+ */ + delete: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the details of an account.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

+ * + *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account/bank_accounts": { + /** + *

Create an external account for a given account.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account/bank_accounts/{id}": { + /** + *

Delete a specified external account for a given account.

+ */ + delete: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieve a specified external account for a given account.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

+ *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

+ */ + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account/capabilities": { + /** + *

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["capability"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account/capabilities/{capability}": { + /** + *

Retrieves information about the specified Account Capability.

+ */ + get: { + parameters: { + path: { + capability: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["capability"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates an existing Account Capability.

+ */ + post: { + parameters: { + path: { + capability: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["capability"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account/external_accounts": { + /** + *

List external accounts for an account.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. + */ + data: (Partial & + Partial)[]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Create an external account for a given account.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account/external_accounts/{id}": { + /** + *

Delete a specified external account for a given account.

+ */ + delete: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieve a specified external account for a given account.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

+ *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

+ */ + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account/login_links": { + /** + *

Creates a single-use login link for an Express account to access their Stripe dashboard.

+ * + *

You may only create login links for Express accounts connected to your platform.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["login_link"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account/logout": { + /** + *

Invalidates all sessions for a light account, for a platform to use during platform logout.

+ * + *

You may only log out Express accounts connected to your platform.

+ */ + put: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["light_account_logout"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account/people": { + /** + *

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Filters on the list of people returned based on the person's relationship to the account's company. + */ + relationship?: { + director?: boolean; + executive?: boolean; + owner?: boolean; + representative?: boolean; + }; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["person"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new person.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account/people/{person}": { + /** + *

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

+ */ + delete: { + parameters: { + path: { + person: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves an existing person.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + person: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates an existing person.

+ */ + post: { + parameters: { + path: { + person: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account/persons": { + /** + *

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Filters on the list of people returned based on the person's relationship to the account's company. + */ + relationship?: { + director?: boolean; + executive?: boolean; + owner?: boolean; + representative?: boolean; + }; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["person"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new person.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account/persons/{person}": { + /** + *

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

+ */ + delete: { + parameters: { + path: { + person: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves an existing person.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + person: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates an existing person.

+ */ + post: { + parameters: { + path: { + person: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/account_links": { + /** + *

Creates an AccountLink object that returns a single-use Stripe URL that the user can redirect their user to in order to take them through the Connect Onboarding flow.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["account_link"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts": { + /** + *

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

+ */ + get: { + parameters: { + query: { + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["account"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

With Connect, you can create Stripe accounts for your users. + * To do this, you’ll first need to register your platform.

+ * + *

For Standard accounts, parameters other than country, email, and type + * are used to prefill the account application that we ask the account holder to complete.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}": { + /** + *

With Connect, you can delete Custom or Express accounts you manage.

+ * + *

Accounts created using test-mode keys can be deleted at any time. Accounts created using live-mode keys can only be deleted once all balances are zero.

+ * + *

If you want to delete your own account, use the account information tab in your account settings instead.

+ */ + delete: { + parameters: { + path: { + account: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the details of an account.

+ */ + get: { + parameters: { + path: { + account: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates a connected Express or Custom account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types.

+ * + *

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

+ */ + post: { + parameters: { + path: { + account: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/bank_accounts": { + /** + *

Create an external account for a given account.

+ */ + post: { + parameters: { + path: { + account: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/bank_accounts/{id}": { + /** + *

Delete a specified external account for a given account.

+ */ + delete: { + parameters: { + path: { + account: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieve a specified external account for a given account.

+ */ + get: { + parameters: { + path: { + account: string; + id: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

+ *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

+ */ + post: { + parameters: { + path: { + account: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/capabilities": { + /** + *

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

+ */ + get: { + parameters: { + path: { + account: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["capability"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/capabilities/{capability}": { + /** + *

Retrieves information about the specified Account Capability.

+ */ + get: { + parameters: { + path: { + account: string; + capability: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["capability"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates an existing Account Capability.

+ */ + post: { + parameters: { + path: { + account: string; + capability: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["capability"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/external_accounts": { + /** + *

List external accounts for an account.

+ */ + get: { + parameters: { + path: { + account: string; + }; + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. + */ + data: (Partial & + Partial)[]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Create an external account for a given account.

+ */ + post: { + parameters: { + path: { + account: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/external_accounts/{id}": { + /** + *

Delete a specified external account for a given account.

+ */ + delete: { + parameters: { + path: { + account: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieve a specified external account for a given account.

+ */ + get: { + parameters: { + path: { + account: string; + id: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the metadata, account holder name, and account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

+ *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

+ */ + post: { + parameters: { + path: { + account: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["external_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/login_links": { + /** + *

Creates a single-use login link for an Express account to access their Stripe dashboard.

+ * + *

You may only create login links for Express accounts connected to your platform.

+ */ + post: { + parameters: { + path: { + account: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["login_link"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/logout": { + /** + *

Invalidates all sessions for a light account, for a platform to use during platform logout.

+ * + *

You may only log out Express accounts connected to your platform.

+ */ + put: { + parameters: { + path: { + account: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["light_account_logout"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/people": { + /** + *

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

+ */ + get: { + parameters: { + path: { + account: string; + }; + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Filters on the list of people returned based on the person's relationship to the account's company. + */ + relationship?: { + director?: boolean; + executive?: boolean; + owner?: boolean; + representative?: boolean; + }; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["person"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new person.

+ */ + post: { + parameters: { + path: { + account: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/people/{person}": { + /** + *

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

+ */ + delete: { + parameters: { + path: { + account: string; + person: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves an existing person.

+ */ + get: { + parameters: { + path: { + account: string; + person: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates an existing person.

+ */ + post: { + parameters: { + path: { + account: string; + person: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/persons": { + /** + *

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

+ */ + get: { + parameters: { + path: { + account: string; + }; + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Filters on the list of people returned based on the person's relationship to the account's company. + */ + relationship?: { + director?: boolean; + executive?: boolean; + owner?: boolean; + representative?: boolean; + }; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["person"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new person.

+ */ + post: { + parameters: { + path: { + account: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/persons/{person}": { + /** + *

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

+ */ + delete: { + parameters: { + path: { + account: string; + person: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves an existing person.

+ */ + get: { + parameters: { + path: { + account: string; + person: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates an existing person.

+ */ + post: { + parameters: { + path: { + account: string; + person: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["person"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/accounts/{account}/reject": { + /** + *

With Connect, you may flag accounts as suspicious.

+ * + *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

+ */ + post: { + parameters: { + path: { + account: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/apple_pay/domains": { + /** + *

List apple pay domains.

+ */ + get: { + parameters: { + query: { + domain_name?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["apple_pay_domain"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Create an apple pay domain.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["apple_pay_domain"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/apple_pay/domains/{domain}": { + /** + *

Delete an apple pay domain.

+ */ + delete: { + parameters: { + path: { + domain: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_apple_pay_domain"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieve an apple pay domain.

+ */ + get: { + parameters: { + path: { + domain: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["apple_pay_domain"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/application_fees": { + /** + *

Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Only return application fees for the charge specified by this charge ID. + */ + charge?: string; + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["application_fee"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/application_fees/{fee}/refunds/{id}": { + /** + *

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + fee: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["fee_refund"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ * + *

This request only accepts metadata as an argument.

+ */ + post: { + parameters: { + path: { + fee: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["fee_refund"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/application_fees/{id}": { + /** + *

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["application_fee"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/application_fees/{id}/refund": { + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["application_fee"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/application_fees/{id}/refunds": { + /** + *

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["fee_refund"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Refunds an application fee that has previously been collected but not yet refunded. + * Funds will be refunded to the Stripe account from which the fee was originally collected.

+ * + *

You can optionally refund only part of an application fee. + * You can do so multiple times, until the entire fee has been refunded.

+ * + *

Once entirely refunded, an application fee can’t be refunded again. + * This method will raise an error when called on an already-refunded application fee, + * or when trying to refund more money than is left on an application fee.

+ */ + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["fee_refund"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/balance": { + /** + *

Retrieves the current account balance, based on the authentication that was used to make the request. + * For a sample request, see Accounting for negative balances.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["balance"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/balance/history": { + /** + *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

+ * + *

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

+ */ + get: { + parameters: { + query: { + available_on?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ + currency?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. + */ + payout?: string; + /** + * Only returns the original transaction. + */ + source?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Only returns transactions of the given type. One of: `charge`, `refund`, `adjustment`, `application_fee`, `application_fee_refund`, `transfer`, `payment`, `payout`, `payout_failure`, `stripe_fee`, or `network_cost`. + */ + type?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["balance_transaction"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/balance/history/{id}": { + /** + *

Retrieves the balance transaction with the given ID.

+ * + *

Note that this endpoint previously used the path /v1/balance/history/:id.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["balance_transaction"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/balance_transactions": { + /** + *

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

+ * + *

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

+ */ + get: { + parameters: { + query: { + available_on?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ + currency?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. + */ + payout?: string; + /** + * Only returns the original transaction. + */ + source?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Only returns transactions of the given type. One of: `charge`, `refund`, `adjustment`, `application_fee`, `application_fee_refund`, `transfer`, `payment`, `payout`, `payout_failure`, `stripe_fee`, or `network_cost`. + */ + type?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["balance_transaction"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/balance_transactions/{id}": { + /** + *

Retrieves the balance transaction with the given ID.

+ * + *

Note that this endpoint previously used the path /v1/balance/history/:id.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["balance_transaction"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/billing_portal/sessions": { + /** + *

Creates a session of the Self-service Portal.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["billing_portal.session"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/bitcoin/receivers": { + /** + *

Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Filter for active receivers. + */ + active?: boolean; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * Filter for filled receivers. + */ + filled?: boolean; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Filter for receivers with uncaptured funds. + */ + uncaptured_funds?: boolean; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["bitcoin_receiver"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/bitcoin/receivers/{id}": { + /** + *

Retrieves the Bitcoin receiver with the given ID.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["bitcoin_receiver"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/bitcoin/receivers/{receiver}/transactions": { + /** + *

List bitcoin transacitons for a given receiver.

+ */ + get: { + parameters: { + query: { + /** + * Only return transactions for the customer specified by this customer ID. + */ + customer?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + path: { + receiver: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["bitcoin_transaction"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/bitcoin/transactions": { + /** + *

List bitcoin transacitons for a given receiver.

+ */ + get: { + parameters: { + query: { + /** + * Only return transactions for the customer specified by this customer ID. + */ + customer?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + receiver?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["bitcoin_transaction"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/charges": { + /** + *

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

+ */ + get: { + parameters: { + query: { + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return charges for the customer specified by this customer ID. + */ + customer?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. + */ + payment_intent?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Only return charges for this transfer group. + */ + transfer_group?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["charge"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["charge"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/charges/{charge}": { + /** + *

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

+ */ + get: { + parameters: { + path: { + charge: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["charge"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ + post: { + parameters: { + path: { + charge: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["charge"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/charges/{charge}/capture": { + /** + *

Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

+ * + *

Uncaptured payments expire exactly seven days after they are created. If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

+ */ + post: { + parameters: { + path: { + charge: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["charge"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/charges/{charge}/dispute": { + /** + *

Retrieve a dispute for a specified charge.

+ */ + get: { + parameters: { + path: { + charge: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["dispute"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + post: { + parameters: { + path: { + charge: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["dispute"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/charges/{charge}/dispute/close": { + post: { + parameters: { + path: { + charge: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["dispute"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/charges/{charge}/refund": { + /** + *

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

+ * + *

Creating a new refund will refund a charge that has previously been created but not yet refunded. + * Funds will be refunded to the credit or debit card that was originally charged.

+ * + *

You can optionally refund only part of a charge. + * You can do so multiple times, until the entire charge has been refunded.

+ * + *

Once entirely refunded, a charge can’t be refunded again. + * This method will raise an error when called on an already-refunded charge, + * or when trying to refund more money than is left on a charge.

+ */ + post: { + parameters: { + path: { + charge: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["charge"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/charges/{charge}/refunds": { + /** + *

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

+ */ + get: { + parameters: { + path: { + charge: string; + }; + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["refund"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Create a refund.

+ */ + post: { + parameters: { + path: { + charge: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["refund"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/charges/{charge}/refunds/{refund}": { + /** + *

Retrieves the details of an existing refund.

+ */ + get: { + parameters: { + path: { + charge: string; + refund: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["refund"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Update a specified refund.

+ */ + post: { + parameters: { + path: { + charge: string; + refund: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["refund"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/checkout/sessions": { + /** + *

Returns a list of Checkout Sessions.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Only return the Checkout Session for the PaymentIntent specified. + */ + payment_intent?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Only return the Checkout Session for the subscription specified. + */ + subscription?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["checkout.session"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a Session object.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["checkout.session"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/checkout/sessions/{session}": { + /** + *

Retrieves a Session object.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + session: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["checkout.session"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/country_specs": { + /** + *

Lists all Country Spec objects available in the API.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["country_spec"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/country_specs/{country}": { + /** + *

Returns a Country Spec for a given Country code.

+ */ + get: { + parameters: { + path: { + country: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["country_spec"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/coupons": { + /** + *

Returns a list of your coupons.

+ */ + get: { + parameters: { + query: { + /** + * A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["coupon"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

+ * + *

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["coupon"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/coupons/{coupon}": { + /** + *

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

+ */ + delete: { + parameters: { + path: { + coupon: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_coupon"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the coupon with the given ID.

+ */ + get: { + parameters: { + path: { + coupon: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["coupon"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

+ */ + post: { + parameters: { + path: { + coupon: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["coupon"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/credit_notes": { + /** + *

Returns a list of credit notes.

+ */ + get: { + parameters: { + query: { + /** + * Only return credit notes for the customer specified by this customer ID. + */ + customer?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * Only return credit notes for the invoice specified by this invoice ID. + */ + invoice?: string; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["credit_note"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces + * its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result + * in any combination of the following:

+ * + *
    + *
  • Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
    • + *
  • Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their next invoice when it’s finalized.
    • + *
  • Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
    • + *
+ * + *

For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.

+ * + *

You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount + * or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["credit_note"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/credit_notes/preview": { + /** + *

Get a preview of a credit note without creating it.

+ */ + get: { + parameters: { + query: { + /** + * The integer amount in **%s** representing the total amount of the credit note. + */ + amount?: number; + /** + * The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. + */ + credit_amount?: number; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * ID of the invoice. + */ + invoice: string; + /** + * Line items that make up the credit note. + */ + lines?: { + amount?: number; + description?: string; + invoice_line_item?: string; + quantity?: number; + tax_rates?: Partial & Partial<"">; + type: "custom_line_item" | "invoice_line_item"; + unit_amount?: number; + unit_amount_decimal?: string; + }[]; + /** + * The credit note's memo appears on the credit note PDF. + */ + memo?: string; + /** + * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + */ + metadata?: { [key: string]: string }; + /** + * The integer amount in **%s** representing the amount that is credited outside of Stripe. + */ + out_of_band_amount?: number; + /** + * Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` + */ + reason?: + | "duplicate" + | "fraudulent" + | "order_change" + | "product_unsatisfactory"; + /** + * ID of an existing refund to link this credit note to. + */ + refund?: string; + /** + * The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. + */ + refund_amount?: number; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["credit_note"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/credit_notes/preview/lines": { + /** + *

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

+ */ + get: { + parameters: { + query: { + /** + * The integer amount in **%s** representing the total amount of the credit note. + */ + amount?: number; + /** + * The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. + */ + credit_amount?: number; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * ID of the invoice. + */ + invoice: string; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Line items that make up the credit note. + */ + lines?: { + amount?: number; + description?: string; + invoice_line_item?: string; + quantity?: number; + tax_rates?: Partial & Partial<"">; + type: "custom_line_item" | "invoice_line_item"; + unit_amount?: number; + unit_amount_decimal?: string; + }[]; + /** + * The credit note's memo appears on the credit note PDF. + */ + memo?: string; + /** + * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + */ + metadata?: { [key: string]: string }; + /** + * The integer amount in **%s** representing the amount that is credited outside of Stripe. + */ + out_of_band_amount?: number; + /** + * Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` + */ + reason?: + | "duplicate" + | "fraudulent" + | "order_change" + | "product_unsatisfactory"; + /** + * ID of an existing refund to link this credit note to. + */ + refund?: string; + /** + * The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. + */ + refund_amount?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["credit_note_line_item"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/credit_notes/{credit_note}/lines": { + /** + *

When retrieving a credit note, you’ll get a lines property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

+ */ + get: { + parameters: { + path: { + credit_note: string; + }; + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["credit_note_line_item"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/credit_notes/{id}": { + /** + *

Retrieves the credit note object with the given identifier.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["credit_note"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates an existing credit note.

+ */ + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["credit_note"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/credit_notes/{id}/void": { + /** + *

Marks a credit note as void. Learn more about voiding credit notes.

+ */ + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["credit_note"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers": { + /** + *

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

+ */ + get: { + parameters: { + query: { + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A filter on the list based on the customer's `email` field. The value must be a string. + */ + email?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["customer"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new customer object.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["customer"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}": { + /** + *

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

+ */ + delete: { + parameters: { + path: { + customer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_customer"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.

+ */ + get: { + parameters: { + path: { + customer: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": Partial & + Partial; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

+ * + *

This request accepts mostly the same arguments as the customer creation call.

+ */ + post: { + parameters: { + path: { + customer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["customer"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/balance_transactions": { + /** + *

Returns a list of transactions that updated the customer’s balance.

+ */ + get: { + parameters: { + path: { + customer: string; + }; + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["customer_balance_transaction"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates an immutable transaction that updates the customer’s balance.

+ */ + post: { + parameters: { + path: { + customer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["customer_balance_transaction"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/balance_transactions/{transaction}": { + /** + *

Retrieves a specific transaction that updated the customer’s balance.

+ */ + get: { + parameters: { + path: { + customer: string; + transaction: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["customer_balance_transaction"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Most customer balance transaction fields are immutable, but you may update its description and metadata.

+ */ + post: { + parameters: { + path: { + customer: string; + transaction: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["customer_balance_transaction"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/bank_accounts": { + /** + *

You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.

+ */ + get: { + parameters: { + path: { + customer: string; + }; + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["bank_account"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

When you create a new credit card, you must specify a customer or recipient on which to create it.

+ * + *

If the card’s owner has no default card, then the new card will become the default. + * However, if the owner already has a default, then it will not change. + * To change the default, you should update the customer to have a new default_source.

+ */ + post: { + parameters: { + path: { + customer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_source"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/bank_accounts/{id}": { + /** + *

Delete a specified source for a given customer.

+ */ + delete: { + parameters: { + path: { + customer: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": Partial & + Partial; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.

+ */ + get: { + parameters: { + path: { + customer: string; + id: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["bank_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Update a specified source for a given customer.

+ */ + post: { + parameters: { + path: { + customer: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": Partial & + Partial & + Partial; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/bank_accounts/{id}/verify": { + /** + *

Verify a specified bank account for a given customer.

+ */ + post: { + parameters: { + path: { + customer: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["bank_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/cards": { + /** + *

You can see a list of the cards belonging to a customer. + * Note that the 10 most recent sources are always available on the Customer object. + * If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.

+ */ + get: { + parameters: { + path: { + customer: string; + }; + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["card"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

When you create a new credit card, you must specify a customer or recipient on which to create it.

+ * + *

If the card’s owner has no default card, then the new card will become the default. + * However, if the owner already has a default, then it will not change. + * To change the default, you should update the customer to have a new default_source.

+ */ + post: { + parameters: { + path: { + customer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_source"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/cards/{id}": { + /** + *

Delete a specified source for a given customer.

+ */ + delete: { + parameters: { + path: { + customer: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": Partial & + Partial; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.

+ */ + get: { + parameters: { + path: { + customer: string; + id: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["card"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Update a specified source for a given customer.

+ */ + post: { + parameters: { + path: { + customer: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": Partial & + Partial & + Partial; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/discount": { + /** + *

Removes the currently applied discount on a customer.

+ */ + delete: { + parameters: { + path: { + customer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_discount"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + get: { + parameters: { + path: { + customer: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["discount"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/sources": { + /** + *

List sources for a specified customer.

+ */ + get: { + parameters: { + path: { + customer: string; + }; + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Filter sources according to a particular object type. + */ + object?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: (Partial & + Partial & + Partial & + Partial & + Partial)[]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

When you create a new credit card, you must specify a customer or recipient on which to create it.

+ * + *

If the card’s owner has no default card, then the new card will become the default. + * However, if the owner already has a default, then it will not change. + * To change the default, you should update the customer to have a new default_source.

+ */ + post: { + parameters: { + path: { + customer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_source"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/sources/{id}": { + /** + *

Delete a specified source for a given customer.

+ */ + delete: { + parameters: { + path: { + customer: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": Partial & + Partial; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieve a specified source for a given customer.

+ */ + get: { + parameters: { + path: { + customer: string; + id: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_source"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Update a specified source for a given customer.

+ */ + post: { + parameters: { + path: { + customer: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": Partial & + Partial & + Partial; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/sources/{id}/verify": { + /** + *

Verify a specified bank account for a given customer.

+ */ + post: { + parameters: { + path: { + customer: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["bank_account"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/subscriptions": { + /** + *

You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

+ */ + get: { + parameters: { + path: { + customer: string; + }; + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["subscription"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new subscription on an existing customer.

+ */ + post: { + parameters: { + path: { + customer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}": { + /** + *

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

+ * + *

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

+ * + *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

+ */ + delete: { + parameters: { + path: { + customer: string; + subscription_exposed_id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the subscription with the given ID.

+ */ + get: { + parameters: { + path: { + customer: string; + subscription_exposed_id: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

+ */ + post: { + parameters: { + path: { + customer: string; + subscription_exposed_id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount": { + /** + *

Removes the currently applied discount on a customer.

+ */ + delete: { + parameters: { + path: { + customer: string; + subscription_exposed_id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_discount"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + get: { + parameters: { + path: { + customer: string; + subscription_exposed_id: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["discount"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/tax_ids": { + /** + *

Returns a list of tax IDs for a customer.

+ */ + get: { + parameters: { + path: { + customer: string; + }; + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["tax_id"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new TaxID object for a customer.

+ */ + post: { + parameters: { + path: { + customer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["tax_id"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/customers/{customer}/tax_ids/{id}": { + /** + *

Deletes an existing TaxID object.

+ */ + delete: { + parameters: { + path: { + customer: string; + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_tax_id"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the TaxID object with the given identifier.

+ */ + get: { + parameters: { + path: { + customer: string; + id: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["tax_id"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/disputes": { + /** + *

Returns a list of your disputes.

+ */ + get: { + parameters: { + query: { + /** + * Only return disputes associated to the charge specified by this charge ID. + */ + charge?: string; + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. + */ + payment_intent?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["dispute"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/disputes/{dispute}": { + /** + *

Retrieves the dispute with the given ID.

+ */ + get: { + parameters: { + path: { + dispute: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["dispute"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

+ * + *

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

+ */ + post: { + parameters: { + path: { + dispute: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["dispute"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/disputes/{dispute}/close": { + /** + *

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

+ * + *

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

+ */ + post: { + parameters: { + path: { + dispute: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["dispute"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/ephemeral_keys": { + /** + *

Creates a short-lived API key for a given resource.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["ephemeral_key"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/ephemeral_keys/{key}": { + /** + *

Invalidates a short-lived API key for a given resource.

+ */ + delete: { + parameters: { + path: { + key: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["ephemeral_key"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/events": { + /** + *

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

+ */ + get: { + parameters: { + query: { + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned. + */ + delivery_success?: boolean; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property. + */ + type?: string; + /** + * An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both. + */ + types?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["event"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/events/{id}": { + /** + *

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["event"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/exchange_rates": { + /** + *

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["exchange_rate"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/exchange_rates/{currency}": { + /** + *

Retrieves the exchange rates from the given currency to every supported currency.

+ */ + get: { + parameters: { + path: { + currency: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["exchange_rate"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/file_links": { + /** + *

Returns a list of file links.

+ */ + get: { + parameters: { + query: { + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * Filter links by their expiration status. By default, all links are returned. + */ + expired?: boolean; + /** + * Only return links for the given file. + */ + file?: string; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["file_link"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new file link object.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["file_link"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/file_links/{link}": { + /** + *

Retrieves the file link with the given ID.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + link: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["file_link"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates an existing file link object. Expired links can no longer be updated.

+ */ + post: { + parameters: { + path: { + link: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["file_link"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/files": { + /** + *

Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

+ */ + get: { + parameters: { + query: { + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * The file purpose to filter queries by. If none is provided, files will not be filtered by purpose. + */ + purpose?: + | "additional_verification" + | "business_icon" + | "business_logo" + | "customer_signature" + | "dispute_evidence" + | "finance_report_run" + | "identity_document" + | "pci_document" + | "sigma_scheduled_query" + | "tax_document_user_upload"; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["file"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

+ * + *

All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["file"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/files/{file}": { + /** + *

Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + file: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["file"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/invoiceitems": { + /** + *

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

+ */ + get: { + parameters: { + query: { + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. + */ + customer?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed. + */ + invoice?: string; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied. + */ + pending?: boolean; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["invoiceitem"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates an item to be added to a draft invoice. If no invoice is specified, the item will be on the next invoice created for the customer specified.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["invoiceitem"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/invoiceitems/{invoiceitem}": { + /** + *

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

+ */ + delete: { + parameters: { + path: { + invoiceitem: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_invoiceitem"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the invoice item with the given ID.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + invoiceitem: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["invoiceitem"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

+ */ + post: { + parameters: { + path: { + invoiceitem: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["invoiceitem"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/invoices": { + /** + *

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

+ */ + get: { + parameters: { + query: { + /** + * The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. + */ + collection_method?: "charge_automatically" | "send_invoice"; + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return invoices for the customer specified by this customer ID. + */ + customer?: string; + due_date?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) + */ + status?: "draft" | "open" | "paid" | "uncollectible" | "void"; + /** + * Only return invoices for the subscription specified by this subscription ID. + */ + subscription?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["invoice"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["invoice"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/invoices/upcoming": { + /** + *

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discount that is applicable to the customer.

+ * + *

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

+ * + *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

+ */ + get: { + parameters: { + query: { + /** + * The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. + */ + coupon?: string; + /** + * The identifier of the customer whose upcoming invoice you'd like to retrieve. + */ + customer?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * List of invoice items to add or update in the upcoming invoice preview. + */ + invoice_items?: { + amount?: number; + currency?: string; + description?: string; + discountable?: boolean; + invoiceitem?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<"">; + period?: { end: number; start: number }; + quantity?: number; + tax_rates?: Partial & Partial<"">; + unit_amount?: number; + unit_amount_decimal?: string; + }[]; + /** + * The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. + */ + schedule?: string; + /** + * The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. + */ + subscription?: string; + /** + * For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. + */ + subscription_billing_cycle_anchor?: Partial<"now" | "unchanged"> & + Partial; + /** + * Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`.` + */ + subscription_cancel_at?: Partial & Partial<"">; + /** + * Boolean indicating whether this subscription should cancel at the end of the current period. + */ + subscription_cancel_at_period_end?: boolean; + /** + * This simulates the subscription being canceled or expired immediately. + */ + subscription_cancel_now?: boolean; + /** + * If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. + */ + subscription_default_tax_rates?: Partial & Partial<"">; + /** + * List of subscription items, each with an attached plan. + */ + subscription_items?: { + billing_thresholds?: Partial<{ usage_gte: number }> & Partial<"">; + clear_usage?: boolean; + deleted?: boolean; + id?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<"">; + plan?: string; + quantity?: number; + tax_rates?: Partial & Partial<"">; + }[]; + /** + * If previewing an update to a subscription, this decides whether the preview will show the result of applying prorations or not. If set, one of `subscription_items` or `subscription`, and one of `subscription_items` or `subscription_trial_end` are required. + */ + subscription_prorate?: boolean; + /** + * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or `always_invoice`. + * + * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`. + * + * Prorations can be disabled by passing `none`. + */ + subscription_proration_behavior?: + | "always_invoice" + | "create_prorations" + | "none"; + /** + * If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period, and cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration` cannot be set to false. + */ + subscription_proration_date?: number; + /** + * Date a subscription is intended to start (can be future or past) + */ + subscription_start_date?: number; + /** + * If provided, the invoice returned will preview updating or creating a subscription with that tax percent. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + */ + subscription_tax_percent?: number; + /** + * If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. + */ + subscription_trial_end?: Partial<"now"> & Partial; + /** + * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. + */ + subscription_trial_from_plan?: boolean; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["invoice"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/invoices/upcoming/lines": { + /** + *

When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

+ */ + get: { + parameters: { + query: { + /** + * The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. + */ + coupon?: string; + /** + * The identifier of the customer whose upcoming invoice you'd like to retrieve. + */ + customer?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * List of invoice items to add or update in the upcoming invoice preview. + */ + invoice_items?: { + amount?: number; + currency?: string; + description?: string; + discountable?: boolean; + invoiceitem?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<"">; + period?: { end: number; start: number }; + quantity?: number; + tax_rates?: Partial & Partial<"">; + unit_amount?: number; + unit_amount_decimal?: string; + }[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. + */ + schedule?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. + */ + subscription?: string; + /** + * For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. + */ + subscription_billing_cycle_anchor?: Partial<"now" | "unchanged"> & + Partial; + /** + * Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`.` + */ + subscription_cancel_at?: Partial & Partial<"">; + /** + * Boolean indicating whether this subscription should cancel at the end of the current period. + */ + subscription_cancel_at_period_end?: boolean; + /** + * This simulates the subscription being canceled or expired immediately. + */ + subscription_cancel_now?: boolean; + /** + * If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. + */ + subscription_default_tax_rates?: Partial & Partial<"">; + /** + * List of subscription items, each with an attached plan. + */ + subscription_items?: { + billing_thresholds?: Partial<{ usage_gte: number }> & Partial<"">; + clear_usage?: boolean; + deleted?: boolean; + id?: string; + metadata?: Partial<{ [key: string]: string }> & Partial<"">; + plan?: string; + quantity?: number; + tax_rates?: Partial & Partial<"">; + }[]; + /** + * If previewing an update to a subscription, this decides whether the preview will show the result of applying prorations or not. If set, one of `subscription_items` or `subscription`, and one of `subscription_items` or `subscription_trial_end` are required. + */ + subscription_prorate?: boolean; + /** + * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. Valid values are `create_prorations`, `none`, or `always_invoice`. + * + * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`. + * + * Prorations can be disabled by passing `none`. + */ + subscription_proration_behavior?: + | "always_invoice" + | "create_prorations" + | "none"; + /** + * If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period, and cannot be before the subscription was on its current plan. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration` cannot be set to false. + */ + subscription_proration_date?: number; + /** + * Date a subscription is intended to start (can be future or past) + */ + subscription_start_date?: number; + /** + * If provided, the invoice returned will preview updating or creating a subscription with that tax percent. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version, for further information view the [migration docs](https://stripe.com/docs/billing/migration/taxes) for `tax_rates`. + */ + subscription_tax_percent?: number; + /** + * If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. + */ + subscription_trial_end?: Partial<"now"> & Partial; + /** + * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. + */ + subscription_trial_from_plan?: boolean; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["line_item"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/invoices/{invoice}": { + /** + *

Permanently deletes a draft invoice. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized, it must be voided.

+ */ + delete: { + parameters: { + path: { + invoice: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_invoice"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the invoice with the given ID.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + invoice: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["invoice"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Draft invoices are fully editable. Once an invoice is finalized, + * monetary values, as well as collection_method, become uneditable.

+ * + *

If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, + * sending reminders for, or automatically reconciling invoices, pass + * auto_advance=false.

+ */ + post: { + parameters: { + path: { + invoice: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["invoice"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/invoices/{invoice}/finalize": { + /** + *

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

+ */ + post: { + parameters: { + path: { + invoice: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["invoice"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/invoices/{invoice}/lines": { + /** + *

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + path: { + invoice: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["line_item"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/invoices/{invoice}/mark_uncollectible": { + /** + *

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

+ */ + post: { + parameters: { + path: { + invoice: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["invoice"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/invoices/{invoice}/pay": { + /** + *

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

+ */ + post: { + parameters: { + path: { + invoice: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["invoice"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/invoices/{invoice}/send": { + /** + *

Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

+ * + *

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

+ */ + post: { + parameters: { + path: { + invoice: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["invoice"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/invoices/{invoice}/void": { + /** + *

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

+ */ + post: { + parameters: { + path: { + invoice: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["invoice"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuer_fraud_records": { + /** + *

Returns a list of issuer fraud records.

+ */ + get: { + parameters: { + query: { + /** + * Only return issuer fraud records for the charge specified by this charge ID. + */ + charge?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["issuer_fraud_record"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuer_fraud_records/{issuer_fraud_record}": { + /** + *

Retrieves the details of an issuer fraud record that has previously been created.

+ * + *

Please refer to the issuer fraud record object reference for more details.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + issuer_fraud_record: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuer_fraud_record"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/authorizations": { + /** + *

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Only return issuing transactions that belong to the given card. + */ + card?: string; + /** + * Only return authorizations belonging to the given cardholder. + */ + cardholder?: string; + /** + * Only return authorizations that were created during the given date interval. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. + */ + status?: "closed" | "pending" | "reversed"; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["issuing.authorization"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/authorizations/{authorization}": { + /** + *

Retrieves an Issuing Authorization object.

+ */ + get: { + parameters: { + path: { + authorization: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.authorization"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ + post: { + parameters: { + path: { + authorization: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.authorization"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/authorizations/{authorization}/approve": { + /** + *

Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.

+ */ + post: { + parameters: { + path: { + authorization: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.authorization"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/authorizations/{authorization}/decline": { + /** + *

Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.

+ */ + post: { + parameters: { + path: { + authorization: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.authorization"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/cardholders": { + /** + *

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Only return cardholders that were created during the given date interval. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return cardholders that have the given email address. + */ + email?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Only return cardholders that have the given phone number. + */ + phone_number?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. + */ + status?: "active" | "blocked" | "inactive"; + /** + * Only return cardholders that have the given type. One of `individual` or `company`. + */ + type?: "company" | "individual"; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["issuing.cardholder"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new Issuing Cardholder object that can be issued cards.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.cardholder"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/cardholders/{cardholder}": { + /** + *

Retrieves an Issuing Cardholder object.

+ */ + get: { + parameters: { + path: { + cardholder: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.cardholder"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ + post: { + parameters: { + path: { + cardholder: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.cardholder"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/cards": { + /** + *

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Only return cards belonging to the Cardholder with the provided ID. + */ + cardholder?: string; + /** + * Only return cards that were issued during the given date interval. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Only return cards that have the given expiration month. + */ + exp_month?: number; + /** + * Only return cards that have the given expiration year. + */ + exp_year?: number; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * Only return cards that have the given last four digits. + */ + last4?: string; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Only return cards that have the given status. One of `active`, `inactive`, or `canceled`. + */ + status?: "active" | "canceled" | "inactive"; + /** + * Only return cards that have the given type. One of `virtual` or `physical`. + */ + type?: "physical" | "virtual"; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["issuing.card"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates an Issuing Card object.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.card"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/cards/{card}": { + /** + *

Retrieves an Issuing Card object.

+ */ + get: { + parameters: { + path: { + card: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.card"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ + post: { + parameters: { + path: { + card: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.card"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/disputes": { + /** + *

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["issuing.dispute"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates an Issuing Dispute object.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.dispute"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/disputes/{dispute}": { + /** + *

Retrieves an Issuing Dispute object.

+ */ + get: { + parameters: { + path: { + dispute: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.dispute"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ + post: { + parameters: { + path: { + dispute: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.dispute"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/settlements": { + /** + *

Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Only return issuing settlements that were created during the given date interval. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["issuing.settlement"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/settlements/{settlement}": { + /** + *

Retrieves an Issuing Settlement object.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + settlement: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.settlement"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ + post: { + parameters: { + path: { + settlement: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.settlement"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/transactions": { + /** + *

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Only return transactions that belong to the given card. + */ + card?: string; + /** + * Only return transactions that belong to the given cardholder. + */ + cardholder?: string; + /** + * Only return transactions that were created during the given date interval. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["issuing.transaction"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/issuing/transactions/{transaction}": { + /** + *

Retrieves an Issuing Transaction object.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + transaction: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.transaction"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ + post: { + parameters: { + path: { + transaction: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["issuing.transaction"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/mandates/{mandate}": { + /** + *

Retrieves a Mandate object.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + mandate: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["mandate"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/order_returns": { + /** + *

Returns a list of your order returns. The returns are returned sorted by creation date, with the most recently created return appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Date this return was created. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * The order to retrieve returns for. + */ + order?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["order_return"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/order_returns/{id}": { + /** + *

Retrieves the details of an existing order return. Supply the unique order ID from either an order return creation request or the order return list, and Stripe will return the corresponding order information.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["order_return"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/orders": { + /** + *

Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Date this order was created. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return orders for the given customer. + */ + customer?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * Only return orders with the given IDs. + */ + ids?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Only return orders that have the given status. One of `created`, `paid`, `fulfilled`, or `refunded`. + */ + status?: string; + /** + * Filter orders based on when they were paid, fulfilled, canceled, or returned. + */ + status_transitions?: { + canceled?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + fulfilled?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + paid?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + returned?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + }; + /** + * Only return orders with the given upstream order IDs. + */ + upstream_ids?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["order"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new order object.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["order"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/orders/{id}": { + /** + *

Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["order"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["order"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/orders/{id}/pay": { + /** + *

Pay an order by providing a source to create a payment.

+ */ + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["order"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/orders/{id}/returns": { + /** + *

Return all or part of an order. The order must have a status of paid or fulfilled before it can be returned. Once all items have been returned, the order will become canceled or returned depending on which status the order started in.

+ */ + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["order_return"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/payment_intents": { + /** + *

Returns a list of PaymentIntents.

+ */ + get: { + parameters: { + query: { + /** + * A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return PaymentIntents for the customer specified by this customer ID. + */ + customer?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["payment_intent"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a PaymentIntent object.

+ * + *

After the PaymentIntent is created, attach a payment method and confirm + * to continue the payment. You can read more about the different payment flows + * available via the Payment Intents API here.

+ * + *

When confirm=true is used during creation, it is equivalent to creating + * and confirming the PaymentIntent in the same call. You may use any parameters + * available in the confirm API when confirm=true + * is supplied.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_intent"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/payment_intents/{intent}": { + /** + *

Retrieves the details of a PaymentIntent that has previously been created.

+ * + *

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

+ * + *

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the payment intent object reference for more details.

+ */ + get: { + parameters: { + query: { + /** + * The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source. + */ + client_secret?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + intent: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_intent"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates properties on a PaymentIntent object without confirming.

+ * + *

Depending on which properties you update, you may need to confirm the + * PaymentIntent again. For example, updating the payment_method will + * always require you to confirm the PaymentIntent again. If you prefer to + * update and confirm at the same time, we recommend updating properties via + * the confirm API instead.

+ */ + post: { + parameters: { + path: { + intent: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_intent"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/payment_intents/{intent}/cancel": { + /** + *

A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action.

+ * + *

Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status='requires_capture', the remaining amount_capturable will automatically be refunded.

+ */ + post: { + parameters: { + path: { + intent: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_intent"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/payment_intents/{intent}/capture": { + /** + *

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

+ * + *

Uncaptured PaymentIntents will be canceled exactly seven days after they are created.

+ * + *

Learn more about separate authorization and capture.

+ */ + post: { + parameters: { + path: { + intent: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_intent"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/payment_intents/{intent}/confirm": { + /** + *

Confirm that your customer intends to pay with current or provided + * payment method. Upon confirmation, the PaymentIntent will attempt to initiate + * a payment.

+ * + *

If the selected payment method requires additional authentication steps, the + * PaymentIntent will transition to the requires_action status and + * suggest additional actions via next_action. If payment fails, + * the PaymentIntent will transition to the requires_payment_method status. If + * payment succeeds, the PaymentIntent will transition to the succeeded + * status (or requires_capture, if capture_method is set to manual).

+ * + *

If the confirmation_method is automatic, payment may be attempted + * using our client SDKs + * and the PaymentIntent’s client_secret. + * After next_actions are handled by the client, no additional + * confirmation is required to complete the payment.

+ * + *

If the confirmation_method is manual, all payment attempts must be + * initiated using a secret key. + * If any actions are required for the payment, the PaymentIntent will + * return to the requires_confirmation state + * after those actions are completed. Your server needs to then + * explicitly re-confirm the PaymentIntent to initiate the next payment + * attempt. Read the expanded documentation + * to learn more about manual confirmation.

+ */ + post: { + parameters: { + path: { + intent: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_intent"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/payment_methods": { + /** + *

Returns a list of PaymentMethods for a given Customer

+ */ + get: { + parameters: { + query: { + /** + * The ID of the customer whose PaymentMethods will be retrieved. + */ + customer: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * A required filter on the list, based on the object `type` field. + */ + type: + | "au_becs_debit" + | "card" + | "card_present" + | "fpx" + | "ideal" + | "sepa_debit"; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["payment_method"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_method"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/payment_methods/{payment_method}": { + /** + *

Retrieves a PaymentMethod object.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + payment_method: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_method"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

+ */ + post: { + parameters: { + path: { + payment_method: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_method"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/payment_methods/{payment_method}/attach": { + /** + *

Attaches a PaymentMethod object to a Customer.

+ * + *

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent + * or a PaymentIntent with setup_future_usage. + * These approaches will perform any necessary steps to ensure that the PaymentMethod can be used in a future payment. Using the + * /v1/payment_methods/:id/attach endpoint does not ensure that future payments can be made with the attached PaymentMethod. + * See Optimizing cards for future payments for more information about setting up future payments.

+ * + *

To use this PaymentMethod as the default for invoice or subscription payments, + * set invoice_settings.default_payment_method, + * on the Customer to the PaymentMethod’s ID.

+ */ + post: { + parameters: { + path: { + payment_method: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_method"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/payment_methods/{payment_method}/detach": { + /** + *

Detaches a PaymentMethod object from a Customer.

+ */ + post: { + parameters: { + path: { + payment_method: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payment_method"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/payouts": { + /** + *

Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

+ */ + get: { + parameters: { + query: { + arrival_date?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * The ID of an external account - only return payouts sent to this external account. + */ + destination?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. + */ + status?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["payout"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

+ * + *

If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.

+ * + *

If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payout"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/payouts/{payout}": { + /** + *

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + payout: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payout"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

+ */ + post: { + parameters: { + path: { + payout: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payout"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/payouts/{payout}/cancel": { + /** + *

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

+ */ + post: { + parameters: { + path: { + payout: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["payout"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/plans": { + /** + *

Returns a list of your plans.

+ */ + get: { + parameters: { + query: { + /** + * Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). + */ + active?: boolean; + /** + * A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Only return plans for the given product. + */ + product?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["plan"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

You can create plans using the API, or in the Stripe Dashboard.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["plan"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/plans/{plan}": { + /** + *

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

+ */ + delete: { + parameters: { + path: { + plan: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_plan"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the plan with the given ID.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + plan: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["plan"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

+ */ + post: { + parameters: { + path: { + plan: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["plan"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/products": { + /** + *

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Only return products that are active or inactive (e.g., pass `false` to list all inactive products). + */ + active?: boolean; + /** + * Only return products that were created during the given date interval. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * Only return products with the given IDs. + */ + ids?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Only return products that can be shipped (i.e., physical, not digital products). + */ + shippable?: boolean; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Only return products of this type. + */ + type?: "good" | "service"; + /** + * Only return products with the given url. + */ + url?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["product"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new product object. To create a product for use with orders, see Products.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["product"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/products/{id}": { + /** + *

Delete a product. Deleting a product with type=good is only possible if it has no SKUs associated with it. Deleting a product with type=service is only possible if it has no plans associated with it.

+ */ + delete: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_product"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["product"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["product"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/radar/early_fraud_warnings": { + /** + *

Returns a list of early fraud warnings.

+ */ + get: { + parameters: { + query: { + /** + * Only return early fraud warnings for the charge specified by this charge ID. + */ + charge?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["radar.early_fraud_warning"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/radar/early_fraud_warnings/{early_fraud_warning}": { + /** + *

Retrieves the details of an early fraud warning that has previously been created.

+ * + *

Please refer to the early fraud warning object reference for more details.

+ */ + get: { + parameters: { + path: { + early_fraud_warning: string; + }; + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["radar.early_fraud_warning"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/radar/value_list_items": { + /** + *

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

+ */ + get: { + parameters: { + query: { + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Return items belonging to the parent list whose value matches the specified value (using an "is like" match). + */ + value?: string; + /** + * Identifier for the parent value list this item belongs to. + */ + value_list: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["radar.value_list_item"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new ValueListItem object, which is added to the specified parent value list.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["radar.value_list_item"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/radar/value_list_items/{item}": { + /** + *

Deletes a ValueListItem object, removing it from its parent value list.

+ */ + delete: { + parameters: { + path: { + item: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_radar.value_list_item"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves a ValueListItem object.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + item: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["radar.value_list_item"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/radar/value_lists": { + /** + *

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

+ */ + get: { + parameters: { + query: { + /** + * The alias used to reference the value list when writing rules. + */ + alias?: string; + /** + * A value contained within a value list - returns all value lists containing this value. + */ + contains?: string; + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["radar.value_list"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new ValueList object, which can then be referenced in rules.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["radar.value_list"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/radar/value_lists/{value_list}": { + /** + *

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

+ */ + delete: { + parameters: { + path: { + value_list: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_radar.value_list"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves a ValueList object.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + value_list: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["radar.value_list"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

+ */ + post: { + parameters: { + path: { + value_list: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["radar.value_list"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/recipients": { + /** + *

Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.

+ */ + get: { + parameters: { + query: { + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + type?: "corporation" | "individual"; + /** + * Only return recipients that are verified or unverified. + */ + verified?: boolean; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["recipient"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new Recipient object and verifies the recipient’s identity. + * Also verifies the recipient’s bank account information or debit card, if either is provided.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["recipient"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/recipients/{id}": { + /** + *

Permanently deletes a recipient. It cannot be undone.

+ */ + delete: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_recipient"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": Partial & + Partial; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified recipient by setting the values of the parameters passed. + * Any parameters not provided will be left unchanged.

+ * + *

If you update the name or tax ID, the identity verification will automatically be rerun. + * If you update the bank account, the bank account validation will automatically be rerun.

+ */ + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["recipient"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/refunds": { + /** + *

Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

+ */ + get: { + parameters: { + query: { + /** + * Only return refunds for the charge specified by this charge ID. + */ + charge?: string; + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Only return refunds for the PaymentIntent specified by this ID. + */ + payment_intent?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["refund"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Create a refund.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["refund"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/refunds/{refund}": { + /** + *

Retrieves the details of an existing refund.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + refund: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["refund"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ * + *

This request only accepts metadata as an argument.

+ */ + post: { + parameters: { + path: { + refund: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["refund"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/reporting/report_runs": { + /** + *

Returns a list of Report Runs, with the most recent appearing first. (Requires a live-mode API key.)

+ */ + get: { + parameters: { + query: { + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["reporting.report_run"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new object and begin running the report. (Requires a live-mode API key.)

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["reporting.report_run"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/reporting/report_runs/{report_run}": { + /** + *

Retrieves the details of an existing Report Run. (Requires a live-mode API key.)

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + report_run: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["reporting.report_run"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/reporting/report_types": { + /** + *

Returns a full list of Report Types. (Requires a live-mode API key.)

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["reporting.report_type"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/reporting/report_types/{report_type}": { + /** + *

Retrieves the details of a Report Type. (Requires a live-mode API key.)

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + report_type: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["reporting.report_type"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/reviews": { + /** + *

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

+ */ + get: { + parameters: { + query: { + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["review"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/reviews/{review}": { + /** + *

Retrieves a Review object.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + review: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["review"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/reviews/{review}/approve": { + /** + *

Approves a Review object, closing it and removing it from the list of reviews.

+ */ + post: { + parameters: { + path: { + review: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["review"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/setup_intents": { + /** + *

Returns a list of SetupIntents.

+ */ + get: { + parameters: { + query: { + /** + * A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return SetupIntents for the customer specified by this customer ID. + */ + customer?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Only return SetupIntents associated with the specified payment method. + */ + payment_method?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["setup_intent"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a SetupIntent object.

+ * + *

After the SetupIntent is created, attach a payment method and confirm + * to collect any required permissions to charge the payment method later.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["setup_intent"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/setup_intents/{intent}": { + /** + *

Retrieves the details of a SetupIntent that has previously been created.

+ * + *

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

+ * + *

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

+ */ + get: { + parameters: { + query: { + /** + * The client secret of the SetupIntent. Required if a publishable key is used to retrieve the SetupIntent. + */ + client_secret?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + intent: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["setup_intent"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates a SetupIntent object.

+ */ + post: { + parameters: { + path: { + intent: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["setup_intent"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/setup_intents/{intent}/cancel": { + /** + *

A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action.

+ * + *

Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.

+ */ + post: { + parameters: { + path: { + intent: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["setup_intent"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/setup_intents/{intent}/confirm": { + /** + *

Confirm that your customer intends to set up the current or + * provided payment method. For example, you would confirm a SetupIntent + * when a customer hits the “Save” button on a payment method management + * page on your website.

+ * + *

If the selected payment method does not require any additional + * steps from the customer, the SetupIntent will transition to the + * succeeded status.

+ * + *

Otherwise, it will transition to the requires_action status and + * suggest additional actions via next_action. If setup fails, + * the SetupIntent will transition to the + * requires_payment_method status.

+ */ + post: { + parameters: { + path: { + intent: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["setup_intent"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/sigma/scheduled_query_runs": { + /** + *

Returns a list of scheduled query runs.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["scheduled_query_run"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": { + /** + *

Retrieves the details of an scheduled query run.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + scheduled_query_run: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["scheduled_query_run"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/skus": { + /** + *

Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive products). + */ + active?: boolean; + /** + * Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if `product` is also supplied. For instance, if the associated product has attributes `["color", "size"]`, passing in `attributes[color]=red` returns all the SKUs for this product that have `color` set to `red`. + */ + attributes?: { [key: string]: string }; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * Only return SKUs with the given IDs. + */ + ids?: string[]; + /** + * Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned. + */ + in_stock?: boolean; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * The ID of the product whose SKUs will be retrieved. Must be a product with type `good`. + */ + product?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["sku"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new SKU associated with a product.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["sku"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/skus/{id}": { + /** + *

Delete a SKU. Deleting a SKU is only possible until it has been used in an order.

+ */ + delete: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_sku"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": Partial & + Partial; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ * + *

Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.

+ */ + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["sku"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/sources": { + /** + *

Creates a new source object.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["source"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/sources/{source}": { + /** + *

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

+ */ + get: { + parameters: { + query: { + /** + * The client secret of the source. Required if a publishable key is used to retrieve the source. + */ + client_secret?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + source: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["source"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ * + *

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

+ */ + post: { + parameters: { + path: { + source: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["source"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/sources/{source}/mandate_notifications/{mandate_notification}": { + /** + *

Retrieves a new Source MandateNotification.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + mandate_notification: string; + source: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["source_mandate_notification"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/sources/{source}/source_transactions": { + /** + *

List source transactions for a given source.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + path: { + source: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["source_transaction"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/sources/{source}/source_transactions/{source_transaction}": { + /** + *

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + source: string; + source_transaction: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["source_transaction"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/sources/{source}/verify": { + /** + *

Verify a given source.

+ */ + post: { + parameters: { + path: { + source: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["source"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/subscription_items": { + /** + *

Returns a list of your subscription items for a given subscription.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * The ID of the subscription whose items will be retrieved. + */ + subscription: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["subscription_item"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Adds a new item to an existing subscription. No existing items will be changed or replaced.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription_item"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/subscription_items/{item}": { + /** + *

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

+ */ + delete: { + parameters: { + path: { + item: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_subscription_item"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the invoice item with the given ID.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + item: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription_item"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the plan or quantity of an item on a current subscription.

+ */ + post: { + parameters: { + path: { + item: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription_item"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/subscription_items/{subscription_item}/usage_record_summaries": { + /** + *

For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the billing plan’s month of September).

+ * + *

The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + path: { + subscription_item: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["usage_record_summary"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/subscription_items/{subscription_item}/usage_records": { + /** + *

Creates a usage record for a specified subscription item and date, and fills it with a quantity.

+ * + *

Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the metered billing plan, Stripe helps you send accurate invoices to your customers.

+ * + *

The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan’s aggregate_usage parameter. When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.

+ * + *

The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

+ */ + post: { + parameters: { + path: { + subscription_item: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["usage_record"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/subscription_schedules": { + /** + *

Retrieves the list of your subscription schedules.

+ */ + get: { + parameters: { + query: { + /** + * Only return subscription schedules that were created canceled the given date interval. + */ + canceled_at?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return subscription schedules that completed during the given date interval. + */ + completed_at?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return subscription schedules that were created during the given date interval. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return subscription schedules for the given customer. + */ + customer?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * Only return subscription schedules that were released during the given date interval. + */ + released_at?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return subscription schedules that have not started yet. + */ + scheduled?: boolean; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["subscription_schedule"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new subscription schedule object. Each customer can have up to 25 active or scheduled subscriptions.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription_schedule"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/subscription_schedules/{schedule}": { + /** + *

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + schedule: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription_schedule"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates an existing subscription schedule.

+ */ + post: { + parameters: { + path: { + schedule: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription_schedule"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/subscription_schedules/{schedule}/cancel": { + /** + *

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

+ */ + post: { + parameters: { + path: { + schedule: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription_schedule"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/subscription_schedules/{schedule}/release": { + /** + *

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

+ */ + post: { + parameters: { + path: { + schedule: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription_schedule"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/subscriptions": { + /** + *

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

+ */ + get: { + parameters: { + query: { + /** + * The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. + */ + collection_method?: "charge_automatically" | "send_invoice"; + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + current_period_end?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + current_period_start?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * The ID of the customer whose subscriptions will be retrieved. + */ + customer?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * The ID of the plan whose subscriptions will be retrieved. + */ + plan?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * The status of the subscriptions to retrieve. One of: `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `unpaid`, `canceled`, or `all`. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Passing in a value of `all` will return subscriptions of all statuses. + */ + status?: + | "active" + | "all" + | "canceled" + | "ended" + | "incomplete" + | "incomplete_expired" + | "past_due" + | "trialing" + | "unpaid"; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["subscription"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new subscription on an existing customer. Each customer can have up to 25 active or scheduled subscriptions.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/subscriptions/{subscription_exposed_id}": { + /** + *

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

+ * + *

Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

+ * + *

By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

+ */ + delete: { + parameters: { + path: { + subscription_exposed_id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the subscription with the given ID.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + subscription_exposed_id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

+ */ + post: { + parameters: { + path: { + subscription_exposed_id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["subscription"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/subscriptions/{subscription_exposed_id}/discount": { + /** + *

Removes the currently applied discount on a subscription.

+ */ + delete: { + parameters: { + path: { + subscription_exposed_id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_discount"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/tax_rates": { + /** + *

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

+ */ + get: { + parameters: { + query: { + /** + * Optional flag to filter by tax rates that are either active or not active (archived) + */ + active?: boolean; + /** + * Optional range for filtering created date + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * Optional flag to filter by tax rates that are inclusive (or those that are not inclusive) + */ + inclusive?: boolean; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["tax_rate"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new tax rate.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["tax_rate"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/tax_rates/{tax_rate}": { + /** + *

Retrieves a tax rate with the given ID

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + tax_rate: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["tax_rate"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates an existing tax rate.

+ */ + post: { + parameters: { + path: { + tax_rate: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["tax_rate"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/terminal/connection_tokens": { + /** + *

To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["terminal.connection_token"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/terminal/locations": { + /** + *

Returns a list of Location objects.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["terminal.location"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new Location object.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["terminal.location"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/terminal/locations/{location}": { + /** + *

Deletes a Location object.

+ */ + delete: { + parameters: { + path: { + location: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_terminal.location"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves a Location object.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + location: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["terminal.location"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ + post: { + parameters: { + path: { + location: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["terminal.location"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/terminal/readers": { + /** + *

Returns a list of Reader objects.

+ */ + get: { + parameters: { + query: { + /** + * Filters readers by device type + */ + device_type?: "bbpos_chipper2x" | "verifone_P400"; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A location ID to filter the response list to only readers at the specific location + */ + location?: string; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * A status filter to filter readers to only offline or online readers + */ + status?: "offline" | "online"; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * A list of readers + */ + data: components["schemas"]["terminal.reader"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Creates a new Reader object.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["terminal.reader"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/terminal/readers/{reader}": { + /** + *

Deletes a Reader object.

+ */ + delete: { + parameters: { + path: { + reader: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_terminal.reader"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves a Reader object.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + reader: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["terminal.reader"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ */ + post: { + parameters: { + path: { + reader: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["terminal.reader"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/tokens": { + /** + *

Creates a single-use token that represents a bank account’s details. + * This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["token"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/tokens/{token}": { + /** + *

Retrieves the token with the given ID.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + token: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["token"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/topups": { + /** + *

Returns a list of top-ups.

+ */ + get: { + parameters: { + query: { + /** + * A positive integer representing how much to transfer. + */ + amount?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. + */ + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. + */ + status?: "canceled" | "failed" | "pending" | "succeeded"; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["topup"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Top up the balance of an account

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["topup"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/topups/{topup}": { + /** + *

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + topup: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["topup"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the metadata of a top-up. Other top-up details are not editable by design.

+ */ + post: { + parameters: { + path: { + topup: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["topup"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/topups/{topup}/cancel": { + /** + *

Cancels a top-up. Only pending top-ups can be canceled.

+ */ + post: { + parameters: { + path: { + topup: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["topup"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/transfers": { + /** + *

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

+ */ + get: { + parameters: { + query: { + created?: Partial<{ + gt?: number; + gte?: number; + lt?: number; + lte?: number; + }> & + Partial; + /** + * Only return transfers for the destination specified by this account ID. + */ + destination?: string; + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + /** + * Only return transfers with the specified transfer group. + */ + transfer_group?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["transfer"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["transfer"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/transfers/{id}/reversals": { + /** + *

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + /** + * Details about each object. + */ + data: components["schemas"]["transfer_reversal"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

When you create a new reversal, you must specify a transfer to create it on.

+ * + *

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

+ * + *

Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

+ */ + post: { + parameters: { + path: { + id: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["transfer_reversal"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/transfers/{transfer}": { + /** + *

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + transfer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["transfer"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ * + *

This request accepts only metadata as an argument.

+ */ + post: { + parameters: { + path: { + transfer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["transfer"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/transfers/{transfer}/reversals/{id}": { + /** + *

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + id: string; + transfer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["transfer_reversal"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

+ * + *

This request only accepts metadata and description as arguments.

+ */ + post: { + parameters: { + path: { + id: string; + transfer: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["transfer_reversal"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/webhook_endpoints": { + /** + *

Returns a list of your webhook endpoints.

+ */ + get: { + parameters: { + query: { + /** + * A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. + */ + ending_before?: string; + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + /** + * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. + */ + limit?: number; + /** + * A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. + */ + starting_after?: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": { + data: components["schemas"]["webhook_endpoint"][]; + /** + * True if this list has another page of items after this one that can be fetched. + */ + has_more: boolean; + /** + * String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + */ + object: "list"; + /** + * The URL where this list can be accessed. + */ + url: string; + }; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

+ */ + post: { + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["webhook_endpoint"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + "/v1/webhook_endpoints/{webhook_endpoint}": { + /** + *

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

+ */ + delete: { + parameters: { + path: { + webhook_endpoint: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["deleted_webhook_endpoint"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Retrieves the webhook endpoint with the given ID.

+ */ + get: { + parameters: { + query: { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: string[]; + }; + path: { + webhook_endpoint: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["webhook_endpoint"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + /** + *

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

+ */ + post: { + parameters: { + path: { + webhook_endpoint: string; + }; + }; + responses: { + /** + * Successful response. + */ + "200": { + "application/json": components["schemas"]["webhook_endpoint"]; + }; + /** + * Error response. + */ + default: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; +} + export interface components { schemas: { /** diff --git a/tests/v3/index.test.ts b/tests/v3/index.test.ts index e248badd9..752caaddb 100644 --- a/tests/v3/index.test.ts +++ b/tests/v3/index.test.ts @@ -14,7 +14,7 @@ function format(types: string): string { } describe("cli", () => { - ["stripe", "manifold", "petstore"].forEach((file) => { + ["github", "stripe", "manifold", "petstore"].forEach((file) => { it(`reads ${file} spec (v3) from file`, () => { execSync( `../../pkg/bin/cli.js specs/${file}.yaml -o generated/${file}.ts`, @@ -212,10 +212,7 @@ describe("types", () => { }, tuple: { type: "array", - items: [ - { type: "string" }, - { type: "number" } - ] + items: [{ type: "string" }, { type: "number" }], }, nullable: { type: "array", @@ -467,4 +464,170 @@ describe("OpenAPI3 features", () => { }`) ); }); + + it("raw schemas", () => { + const schema: any = { + User: { + type: "object", + properties: { + name: { type: "string" }, + email: { type: "string" }, + }, + required: ["name", "email"], + }, + }; + + expect(swaggerToTS(schema, { version: 3, rawSchema: true })).toBe( + format(` + export interface schemas { + User: { name: string; email: string } + }`) + ); + }); + + it("paths", () => { + const schema: OpenAPI3 = { + openapi: "3.0.1", + paths: { + "/": { + get: { + responses: { + "200": { + content: { + "application/json": { + schema: { + type: "object", + properties: { + title: { type: "string" }, + body: { type: "string" }, + }, + required: ["title", "body"], + }, + }, + }, + }, + }, + }, + }, + "/search": { + post: { + parameters: [ + { + name: "q", + in: "query", + required: true, + schema: { type: "string" }, + }, + { + name: "p", + in: "query", + schema: { type: "integer" }, + }, + ], + responses: { + "200": { + content: { + "application/json": { + schema: { + type: "object", + properties: { + results: { + type: "array", + items: { $ref: "#/components/schemas/SearchResult" }, + }, + total: { type: "integer" }, + }, + required: ["total"], + }, + }, + }, + }, + "404": { + content: { + "application/json": { + schema: { $ref: "#/components/schemas/ErrorResponse" }, + }, + }, + }, + }, + }, + }, + }, + components: { + schemas: { + ErrorResponse: { + type: "object", + properties: { + error: { type: "string" }, + message: { type: "string" }, + }, + required: ["error", "message"], + }, + SearchResponse: { + type: "object", + properties: { + title: { type: "string" }, + date: { type: "string" }, + }, + required: ["title", "date"], + }, + }, + responses: { + NotFound: { + content: { + "application/json": { + schema: { $ref: "#/components/schemas/ErrorResponse" }, + }, + }, + }, + }, + }, + }; + + expect(swaggerToTS(schema)).toBe( + format(` + export interface paths { + '/': { + get: { + responses: { + '200': { + 'application/json': { title: string; body: string } + } + } + } + }; + '/search': { + post: { + parameters: { + query: { + q: string; + p?: number; + } + }; + responses: { + '200': { + 'application/json': { + results?: components['schemas']['SearchResult'][]; + total: number; + } + } + '404': { + 'application/json': components['schemas']['ErrorResponse'] + } + } + } + } + } + + export interface components { + schemas: { + ErrorResponse: { error: string; message: string }; + SearchResponse: { title: string; date: string } + } + responses: { + NotFound: { [key: string]: any } + } + }`) + ); + }); }); diff --git a/tests/v3/specs/github.yaml b/tests/v3/specs/github.yaml new file mode 100644 index 000000000..d26e3cbe1 --- /dev/null +++ b/tests/v3/specs/github.yaml @@ -0,0 +1,63094 @@ +--- +openapi: 3.0.3 +info: + version: 1.0.0 + title: GitHub v3 REST API + description: GitHub's v3 REST API. + license: + name: MIT + url: https://spdx.org/licenses/MIT + termsOfService: https://docs.github.com/articles/github-terms-of-service + contact: + name: Support + url: https://support.github.com +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: 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://developer.github.com/v3/ +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 + "/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://developer.github.com/v3/apps/#list-installations-for-the-authenticated-app)" 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. + tags: + - apps + operationId: apps/get-authenticated + externalDocs: + description: API method documentation + url: https://developer.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: + "/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://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`. + tags: + - apps + operationId: apps/create-from-manifest + externalDocs: + description: API method documentation + url: https://developer.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: + "/app/installations": + get: + summary: List installations for the authenticated app + description: |- + 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. + tags: + - apps + operationId: apps/list-installations + externalDocs: + description: API method documentation + url: https://developer.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: + "/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. + + 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. + tags: + - apps + operationId: apps/get-installation + externalDocs: + description: API method documentation + url: https://developer.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: + 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://developer.github.com/v3/apps/#suspend-an-app-installation)" 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. + tags: + - apps + operationId: apps/delete-installation + externalDocs: + description: API method documentation + url: https://developer.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: + "/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. + + 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. + tags: + - apps + operationId: apps/create-installation-access-token + externalDocs: + description: API method documentation + url: https://developer.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: + type: object + properties: + contents: + type: string + issues: + type: string + deployments: + type: string + single_file: + type: string + def_not_a_repo: + type: string + example: '"read"' + example: + contents: read + issues: read + deployments: write + single_file: read + responses: + '201': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/installation-token" + examples: + default: + "$ref": "#/components/examples/installation-token" + '403': + "$ref": "#/components/responses/forbidden" + '415': + "$ref": "#/components/responses/preview_header_missing" + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: apps + subcategory: + "/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://developer.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. + + To suspend a GitHub App, you must be an account owner or have admin permissions in the repository or organization where the app is installed. + + 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. + tags: + - apps + operationId: apps/suspend-installation + externalDocs: + description: API method documentation + url: https://developer.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: + 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://developer.github.com/apps/managing-github-apps/suspending-a-github-app-installation/)." + + Removes a GitHub App installation suspension. + + To unsuspend a GitHub App, you must be an account owner or have admin permissions in the repository or organization where the app is installed and suspended. + + 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. + tags: + - apps + operationId: apps/unsuspend-installation + externalDocs: + description: API method documentation + url: https://developer.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: + "/applications/grants": + get: + summary: List your grants + description: |- + **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://developer.github.com/v3/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://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"]`. + tags: + - oauth-authorizations + operationId: oauth-authorizations/list-grants + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '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: + deprecated: true + "/applications/grants/{grant_id}": + get: + summary: Get a single grant + description: "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations + API](https://developer.github.com/v3/oauth_authorizations/), which is used + by integrations to create personal access tokens and OAuth tokens, and you + must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). + The [OAuth Authorizations API](https://developer.github.com/v3/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://developer.github.com/v3/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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: + deprecated: true + delete: + summary: Delete a grant + description: |- + **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://developer.github.com/v3/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). + tags: + - oauth-authorizations + operationId: oauth-authorizations/delete-grant + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/oauth_authorizations/#delete-a-grant + parameters: + - "$ref": "#/components/parameters/grant_id" + responses: + '204': + description: Empty response + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: + deprecated: true + "/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://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). + operationId: apps/delete-authorization + tags: + - apps + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/oauth_applications/#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 + "/applications/{client_id}/grants/{access_token}": + delete: + summary: Revoke a grant for an application + description: |- + **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, 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://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). + tags: + - apps + operationId: apps/revoke-grant-for-application + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/oauth_applications/#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 + "/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://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`. + tags: + - apps + operationId: apps/check-token + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/oauth_applications/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: apps + subcategory: oauth-applications + 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://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`. + tags: + - apps + operationId: apps/reset-token + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/oauth_applications/#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 + 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://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. + tags: + - apps + operationId: apps/delete-token + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/oauth_applications/#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 + "/applications/{client_id}/tokens/{access_token}": + get: + summary: Check an authorization + description: |- + **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, 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://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`. + tags: + - apps + operationId: apps/check-authorization + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/oauth_applications/#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 + post: + summary: Reset an authorization + description: |- + **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, 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://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`. + tags: + - apps + operationId: apps/reset-authorization + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/oauth_applications/#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 + delete: + summary: Revoke an authorization for an application + description: |- + **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. The OAuth Application API will be removed on May 5, 2021. For more information, including scheduled brownouts, 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://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. + tags: + - apps + operationId: apps/revoke-authorization-for-application + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/oauth_applications/#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 + "/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`). + + 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. + tags: + - apps + operationId: apps/get-by-slug + externalDocs: + description: API method documentation + url: https://developer.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: + "/authorizations": + get: + summary: List your authorizations + description: "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations + API](https://developer.github.com/v3/oauth_authorizations/), which is used + by integrations to create personal access tokens and OAuth tokens, and you + must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). + The [OAuth Authorizations API](https://developer.github.com/v3/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://developer.github.com/v3/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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '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: + deprecated: true + post: + summary: Create a new authorization + description: |- + **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://developer.github.com/v3/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://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 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://developer.github.com/v3/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 + '422': + "$ref": "#/components/responses/validation_failed" + '410': + "$ref": "#/components/responses/gone" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: + deprecated: true + "/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://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). The [OAuth Authorizations API](https://developer.github.com/v3/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://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). The [OAuth Authorizations API](https://developer.github.com/v3/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://developer.github.com/v3/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://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). + The [OAuth Authorizations API](https://developer.github.com/v3/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 + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: + deprecated: true + "/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://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). The [OAuth Authorizations API](https://developer.github.com/v3/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://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)." + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/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: + deprecated: true + "/authorizations/{authorization_id}": + get: + summary: Get a single authorization + description: "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations + API](https://developer.github.com/v3/oauth_authorizations/), which is used + by integrations to create personal access tokens and OAuth tokens, and you + must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). + The [OAuth Authorizations API](https://developer.github.com/v3/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://developer.github.com/v3/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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: + deprecated: true + patch: + summary: Update an existing authorization + description: |- + **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://developer.github.com/v3/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://developer.github.com/v3/auth/#working-with-two-factor-authentication)." + + You 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://developer.github.com/v3/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: + deprecated: true + delete: + summary: Delete an authorization + description: "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations + API](https://developer.github.com/v3/oauth_authorizations/), which is used + by integrations to create personal access tokens and OAuth tokens, and you + must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). + The [OAuth Authorizations API](https://developer.github.com/v3/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://developer.github.com/v3/oauth_authorizations/#delete-an-authorization + parameters: + - "$ref": "#/components/parameters/authorization_id" + responses: + '204': + description: Empty response + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: + deprecated: true + "/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://developer.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. + + To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.scarlet-witch-preview+json + ``` + category: codes-of-conduct + subcategory: + "/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://developer.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" + '404': + "$ref": "#/components/responses/not_found" + '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. + + To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.scarlet-witch-preview+json + ``` + category: codes-of-conduct + subcategory: + "/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://developer.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://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. + tags: + - apps + operationId: apps/create-content-attachment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/installations/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + '415': + "$ref": "#/components/responses/preview_header_missing" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.corsair-preview+json + ``` + category: apps + subcategory: installations + "/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://developer.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: + "/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. + + You 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://developer.github.com/v3/enterprise-admin/actions/#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" + examples: + default: + "$ref": "#/components/examples/runner-groups-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + post: + summary: Create a self-hosted runner group for an enterprise + description: |- + 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. + operationId: enterprise-admin/create-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#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 + "/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. + + You 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://developer.github.com/v3/enterprise-admin/actions/#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 + 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. + + You 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://developer.github.com/v3/enterprise-admin/actions/#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 + delete: + summary: Delete a self-hosted runner group from an enterprise + description: |- + 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. + operationId: enterprise-admin/delete-self-hosted-runner-group-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#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 + "/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. + + You 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://developer.github.com/v3/enterprise-admin/actions/#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" + examples: + default: + "$ref": "#/components/examples/organization-targets" + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + 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. + + You 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://developer.github.com/v3/enterprise-admin/actions/#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 + "/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)." + + You 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://developer.github.com/v3/enterprise-admin/actions/#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 + 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)." + + You 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://developer.github.com/v3/enterprise-admin/actions/#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 + "/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. + + You 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://developer.github.com/v3/enterprise-admin/actions/#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" + 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 + 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. + + You 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://developer.github.com/v3/enterprise-admin/actions/#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 + "/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. + + You must authenticate using an access token with the `admin:enterprise` + scope 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://developer.github.com/v3/enterprise-admin/actions/#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 + 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. + + You 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://developer.github.com/v3/enterprise-admin/actions/#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 + "/enterprises/{enterprise}/actions/runners": + get: + summary: List self-hosted runners for an enterprise + description: |- + 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. + operationId: enterprise-admin/list-self-hosted-runners-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#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 + "/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. + + You 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://developer.github.com/v3/enterprise-admin/actions/#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 + "/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. + + 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/enterpises/octo-enterprise --token TOKEN + ``` + operationId: enterprise-admin/create-registration-token-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#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 + "/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. + + 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 + ``` + operationId: enterprise-admin/create-remove-token-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#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 + "/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. + + You 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://developer.github.com/v3/enterprise-admin/actions/#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 + 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. + + You 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://developer.github.com/v3/enterprise-admin/actions/#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 + "/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. + + 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. + operationId: billing/get-github-actions-billing-ghe + tags: + - billing + externalDocs: + description: API method documentation + url: https://developer.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 + "/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. + + 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. + operationId: billing/get-github-packages-billing-ghe + tags: + - billing + externalDocs: + description: API method documentation + url: https://developer.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 + "/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. + + 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. + operationId: billing/get-shared-storage-billing-ghe + tags: + - billing + externalDocs: + description: API method documentation + url: https://developer.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 + "/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://developer.github.com/v3/activity/events/#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 + "/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: + + * **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. + tags: + - activity + operationId: activity/get-feeds + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/feeds/#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 + "/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://developer.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: + post: + summary: Create a gist + description: |- + 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. + operationId: gists/create + tags: + - gists + externalDocs: + description: API method documentation + url: https://developer.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 + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + "/gists/public": + get: + summary: List public gists + description: |- + List 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. + tags: + - gists + operationId: gists/list-public + externalDocs: + description: API method documentation + url: https://developer.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" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + "/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://developer.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" + '401': + "$ref": "#/components/responses/requires_authentication" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + "/gists/{gist_id}": + get: + summary: Get a gist + description: '' + tags: + - gists + operationId: gists/get + externalDocs: + description: API method documentation + url: https://developer.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" + '403': + "$ref": "#/components/responses/forbidden_gist" + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + 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://developer.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 + 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-3" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + delete: + summary: Delete a gist + description: '' + tags: + - gists + operationId: gists/delete + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/gists/#delete-a-gist + parameters: + - "$ref": "#/components/parameters/gist_id" + responses: + '204': + description: Empty response + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + "/gists/{gist_id}/comments": + get: + summary: List gist comments + description: '' + tags: + - gists + operationId: gists/list-comments + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/gists/comments/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: comments + post: + summary: Create a gist comment + description: '' + tags: + - gists + operationId: gists/create-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/gists/comments/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: comments + "/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://developer.github.com/v3/gists/comments/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden_gist" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: comments + patch: + summary: Update a gist comment + description: '' + tags: + - gists + operationId: gists/update-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/gists/comments/#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 + delete: + summary: Delete a gist comment + description: '' + tags: + - gists + operationId: gists/delete-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/gists/comments/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: comments + "/gists/{gist_id}/commits": + get: + summary: List gist commits + description: '' + tags: + - gists + operationId: gists/list-commits + externalDocs: + description: API method documentation + url: https://developer.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 + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + "/gists/{gist_id}/forks": + get: + summary: List gist forks + description: '' + tags: + - gists + operationId: gists/list-forks + externalDocs: + description: API method documentation + url: https://developer.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" + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + 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://developer.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 + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + "/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://developer.github.com/v3/gists/#check-if-a-gist-is-starred + parameters: + - "$ref": "#/components/parameters/gist_id" + responses: + '204': + description: Response if gist is starred + '404': + description: Response if gist is not starred + content: + application/json: + schema: + type: object + properties: {} + additionalProperties: false + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + 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://developer.github.com/v3/#http-verbs)." + tags: + - gists + operationId: gists/star + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/gists/#star-a-gist + parameters: + - "$ref": "#/components/parameters/gist_id" + responses: + '204': + description: Empty response + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + delete: + summary: Unstar a gist + description: '' + tags: + - gists + operationId: gists/unstar + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/gists/#unstar-a-gist + parameters: + - "$ref": "#/components/parameters/gist_id" + responses: + '204': + description: Empty response + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + "/gists/{gist_id}/{sha}": + get: + summary: Get a gist revision + description: '' + tags: + - gists + operationId: gists/get-revision + externalDocs: + description: API method documentation + url: https://developer.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-2" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: gists + subcategory: + "/gitignore/templates": + get: + summary: Get all gitignore templates + description: List all templates available to pass as an option when [creating + a repository](https://developer.github.com/v3/repos/#create-a-repository-for-the-authenticated-user). + operationId: gitignore/get-all-templates + tags: + - gitignore + externalDocs: + description: API method documentation + url: https://developer.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: + "/gitignore/templates/{name}": + get: + summary: Get a gitignore template + description: |- + 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. + operationId: gitignore/get-template + tags: + - gitignore + externalDocs: + description: API method documentation + url: https://developer.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: + "/installation/repositories": + get: + summary: List repositories accessible to the app installation + description: |- + List repositories that an app 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. + tags: + - apps + operationId: apps/list-repos-accessible-to-installation + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/installations/#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 + 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" + '403': + "$ref": "#/components/responses/forbidden" + '304': + "$ref": "#/components/responses/not_modified" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.mercy-preview+json + ``` + category: apps + subcategory: installations + "/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. + + 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://developer.github.com/v3/apps/#create-an-installation-access-token-for-an-app)" endpoint. + + 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. + tags: + - apps + operationId: apps/revoke-installation-access-token + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/installations/#revoke-an-installation-access-token + parameters: [] + responses: + '204': + description: Empty response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: apps + subcategory: installations + "/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 + repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + necessarily assigned to you. See the [Parameters table](https://developer.github.com/v3/issues/#parameters) for more + information. + + + **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. + tags: + - issues + operationId: issues/list + externalDocs: + description: API method documentation + url: https://developer.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" + '422': + "$ref": "#/components/responses/validation_failed" + '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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: issues + subcategory: + "/licenses": + get: + summary: Get all commonly used licenses + description: '' + tags: + - licenses + operationId: licenses/get-all-commonly-used + externalDocs: + description: API method documentation + url: https://developer.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: + "/licenses/{license}": + get: + summary: Get a license + description: '' + tags: + - licenses + operationId: licenses/get + externalDocs: + description: API method documentation + url: https://developer.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" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: licenses + subcategory: + "/markdown": + post: + summary: Render a Markdown document + description: '' + operationId: markdown/render + tags: + - markdown + externalDocs: + description: API method documentation + url: https://developer.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: + "/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://developer.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: + "/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. + + 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. + tags: + - apps + operationId: apps/get-subscription-plan-for-account + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/marketplace/#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" + '404': + description: Response when the account has not purchased the listing + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: apps + subcategory: marketplace + "/marketplace_listing/plans": + get: + summary: List plans + description: |- + Lists all plans that are part of your GitHub Marketplace listing. + + 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. + tags: + - apps + operationId: apps/list-plans + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/marketplace/#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" + '404': + "$ref": "#/components/responses/not_found" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: apps + subcategory: marketplace + "/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. + + 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. + tags: + - apps + operationId: apps/list-accounts-for-plan + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/marketplace/#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" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: apps + subcategory: marketplace + "/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. + + 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. + tags: + - apps + operationId: apps/get-subscription-plan-for-account-stubbed + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/marketplace/#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" + '404': + description: Response when the account has not purchased the listing + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: apps + subcategory: marketplace + "/marketplace_listing/stubbed/plans": + get: + summary: List plans (stubbed) + description: |- + Lists all plans that are part of your GitHub Marketplace listing. + + 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. + tags: + - apps + operationId: apps/list-plans-stubbed + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/marketplace/#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 + "/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. + + 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. + tags: + - apps + operationId: apps/list-accounts-for-plan-stubbed + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/marketplace/#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 + "/meta": + get: + summary: Get GitHub meta information + description: This endpoint provides a list of GitHub's IP addresses. For more + information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)." + tags: + - meta + operationId: meta/get + externalDocs: + description: API method documentation + url: https://developer.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: + "/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://developer.github.com/v3/activity/events/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '304': + "$ref": "#/components/responses/not_modified" + '301': + "$ref": "#/components/responses/moved_permanently" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: activity + subcategory: events + "/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://developer.github.com/v3/activity/notifications/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: activity + subcategory: notifications + 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://developer.github.com/v3/activity/notifications/#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://developer.github.com/v3/activity/notifications/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: activity + subcategory: notifications + "/notifications/threads/{thread_id}": + get: + summary: Get a thread + description: '' + tags: + - activity + operationId: activity/get-thread + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/notifications/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: activity + subcategory: notifications + patch: + summary: Mark a thread as read + description: '' + tags: + - activity + operationId: activity/mark-thread-as-read + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/notifications/#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 + "/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://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. + tags: + - activity + operationId: activity/get-thread-subscription-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/notifications/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: activity + subcategory: notifications + 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**. + + 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://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription) endpoint. + tags: + - activity + operationId: activity/set-thread-subscription + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/notifications/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: activity + subcategory: notifications + 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://developer.github.com/v3/activity/notifications/#set-a-thread-subscription) + endpoint and set `ignore` to `true`. + tags: + - activity + operationId: activity/delete-thread-subscription + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription + parameters: + - "$ref": "#/components/parameters/thread_id" + responses: + '204': + description: Empty response + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: activity + subcategory: notifications + "/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 + "/organizations": + get: + summary: List organizations + description: |- + 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. + tags: + - orgs + operationId: orgs/list + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/orgs/#list-organizations + parameters: + - "$ref": "#/components/parameters/since" + - "$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: + "/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/). + + 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)." + tags: + - orgs + operationId: orgs/get + externalDocs: + description: API method documentation + url: https://developer.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. + + To access these new parameters during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.surtur-preview+json + ``` + category: orgs + subcategory: + 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). + + Enables 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://developer.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 [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) + 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" + '422': + description: Validation Failed + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/validation-error" + - "$ref": "#/components/schemas/validation-error-simple" + '409': + "$ref": "#/components/responses/conflict" + '415': + "$ref": "#/components/responses/preview_header_missing" + 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. + + To access these new parameters during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.surtur-preview+json + ``` + category: orgs + subcategory: + "/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)." + + 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. + operationId: actions/list-self-hosted-runner-groups-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + 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 + 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)." + + 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. + operationId: actions/create-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + "/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)." + + 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. + operationId: actions/get-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + 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)." + + 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. + operationId: actions/update-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + 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)." + + 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. + operationId: actions/delete-self-hosted-runner-group-from-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + "/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)." + + 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. + operationId: actions/list-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + 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 + 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)." + + 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. + operationId: actions/set-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + "/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)." + + + 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. + operationId: actions/add-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + 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)." + + + 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. + operationId: actions/remove-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + "/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)." + + 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. + operationId: actions/list-self-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + 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 + 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)." + + 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. + operationId: actions/set-self-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + "/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)." + + + 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. + operationId: actions/add-self-hosted-runner-to-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + 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)." + + + 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. + operationId: actions/remove-self-hosted-runner-from-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#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 + "/orgs/{org}/actions/runners": + get: + summary: List self-hosted runners for an organization + description: |- + 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. + tags: + - actions + operationId: actions/list-self-hosted-runners-for-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runners/#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 + 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 + "/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. + + You 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://developer.github.com/v3/actions/self-hosted-runners/#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 + "/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. + + 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 + ``` + tags: + - actions + operationId: actions/create-registration-token-for-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runners/#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 + "/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. + + 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 + ``` + tags: + - actions + operationId: actions/create-remove-token-for-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runners/#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 + "/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. + + You 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://developer.github.com/v3/actions/self-hosted-runners/#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 + 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. + + You 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://developer.github.com/v3/actions/self-hosted-runners/#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 + "/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://developer.github.com/v3/actions/secrets/#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 + 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 + "/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://developer.github.com/v3/actions/secrets/#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 + "/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://developer.github.com/v3/actions/secrets/#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 + put: + summary: Create or update an organization secret + description: |- + 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) + ``` + tags: + - actions + operationId: actions/create-or-update-org-secret + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/secrets/#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://developer.github.com/v3/actions/secrets/#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://developer.github.com/v3/actions/secrets/#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://developer.github.com/v3/actions/secrets/#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://developer.github.com/v3/actions/secrets/#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 + 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://developer.github.com/v3/actions/secrets/#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 + "/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://developer.github.com/v3/actions/secrets/#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 + 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 + 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://developer.github.com/v3/actions/secrets/#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://developer.github.com/v3/actions/secrets/#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://developer.github.com/v3/actions/secrets/#set-selected-repositories-for-an-organization-secret) + and [Remove selected repository from an organization secret](https://developer.github.com/v3/actions/secrets/#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 + "/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://developer.github.com/v3/actions/secrets/#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://developer.github.com/v3/actions/secrets/#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 + 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://developer.github.com/v3/actions/secrets/#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://developer.github.com/v3/actions/secrets/#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 + "/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://developer.github.com/v3/orgs/blocking/#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 + "/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://developer.github.com/v3/orgs/blocking/#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 + put: + summary: Block a user from an organization + description: '' + tags: + - orgs + operationId: orgs/block-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/orgs/blocking/#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 + delete: + summary: Unblock a user from an organization + description: '' + tags: + - orgs + operationId: orgs/unblock-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/orgs/blocking/#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 + "/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). + + 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). + tags: + - orgs + operationId: orgs/list-saml-sso-authorizations + externalDocs: + description: API method documentation + url: https://developer.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: + "/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). + + 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. + tags: + - orgs + operationId: orgs/remove-saml-sso-authorization + externalDocs: + description: API method documentation + url: https://developer.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: + "/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://developer.github.com/v3/activity/events/#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 + "/orgs/{org}/hooks": + get: + summary: List organization webhooks + description: '' + tags: + - orgs + operationId: orgs/list-webhooks + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/orgs/hooks/#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: hooks + 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://developer.github.com/v3/orgs/hooks/#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://developer.github.com/v3/orgs/hooks/#create-hook-config-params). + properties: + url: + type: string + description: The URL to which the payloads will be delivered. + content_type: + type: string + description: The media type used to serialize the payloads. + Supported values include `json` and `form`. The default is + `form`. + secret: + type: string + description: If provided, the `secret` will be used as the `key` + to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/event-payloads/#delivery-headers) + header. + 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.** + username: + type: string + example: '"kdaigle"' + password: + type: string + example: '"password"' + required: + - url + events: + type: array + description: Determines what [events](https://developer.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 + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: hooks + "/orgs/{org}/hooks/{hook_id}": + get: + summary: Get an organization webhook + description: '' + tags: + - orgs + operationId: orgs/get-webhook + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/orgs/hooks/#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: hooks + patch: + summary: Update an organization webhook + description: '' + tags: + - orgs + operationId: orgs/update-webhook + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/orgs/hooks/#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://developer.github.com/v3/orgs/hooks/#update-hook-config-params). + properties: + url: + type: string + description: The URL to which the payloads will be delivered. + content_type: + type: string + description: The media type used to serialize the payloads. + Supported values include `json` and `form`. The default is + `form`. + secret: + type: string + description: If provided, the `secret` will be used as the `key` + to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/event-payloads/#delivery-headers) + header. + 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.** + required: + - url + events: + type: array + description: Determines what [events](https://developer.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" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: hooks + delete: + summary: Delete an organization webhook + description: '' + tags: + - orgs + operationId: orgs/delete-webhook + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/orgs/hooks/#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: hooks + "/orgs/{org}/hooks/{hook_id}/pings": + post: + summary: Ping an organization webhook + description: This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) + to be sent to the hook. + tags: + - orgs + operationId: orgs/ping-webhook + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/orgs/hooks/#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: hooks + "/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. + + 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. + tags: + - apps + operationId: apps/get-org-installation + externalDocs: + description: API method documentation + url: https://developer.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: + "/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://developer.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 + 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: + "/orgs/{org}/interaction-limits": + get: + summary: Get interaction restrictions for an organization + description: Shows which group of GitHub users can interact with this organization + and when the restriction expires. If there are no restrictions, you will see + an empty response. + tags: + - interactions + operationId: interactions/get-restrictions-for-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/interactions/orgs/#get-interaction-restrictions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/interaction-limit" + examples: + default: + "$ref": "#/components/examples/interaction-limit" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: + - required: true + name: sombra + note: |- + The Interactions API is currently in public preview. See the [blog post](https://developer.github.com/changes/2018-12-18-interactions-preview) preview for more details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.sombra-preview + ``` + category: interactions + subcategory: orgs + put: + summary: Set interaction restrictions for an organization + description: Temporarily restricts interactions to certain GitHub users in any + public repository in the given organization. You must be an organization owner + to set these restrictions. + tags: + - interactions + operationId: interactions/set-restrictions-for-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/interactions/orgs/#set-interaction-restrictions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + content: + application/json: + schema: + type: object + properties: + limit: + type: string + description: 'Specifies the group of GitHub users who can comment, + open issues, or create pull requests in public repositories for + the given organization. Must be one of: `existing_users`, `contributors_only`, + or `collaborators_only`.' + enum: + - existing_users + - contributors_only + - collaborators_only + required: + - limit + example: + limit: collaborators_only + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/interaction-limit" + examples: + default: + "$ref": "#/components/examples/interaction-limit" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: + - required: true + name: sombra + note: |- + The Interactions API is currently in public preview. See the [blog post](https://developer.github.com/changes/2018-12-18-interactions-preview) preview for more details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.sombra-preview + ``` + category: interactions + subcategory: orgs + 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://developer.github.com/v3/interactions/orgs/#remove-interaction-restrictions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Empty response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: + - required: true + name: sombra + note: |- + The Interactions API is currently in public preview. See the [blog post](https://developer.github.com/changes/2018-12-18-interactions-preview) preview for more details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.sombra-preview + ``` + category: interactions + subcategory: orgs + "/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://developer.github.com/v3/orgs/members/#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 + 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. + + 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. + tags: + - orgs + operationId: orgs/create-invitation + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/orgs/members/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: members + "/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://developer.github.com/v3/orgs/members/#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 + "/orgs/{org}/issues": + get: + summary: List organization issues assigned to the authenticated user + description: |- + 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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + tags: + - issues + operationId: issues/list-for-org + externalDocs: + description: API method documentation + url: https://developer.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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: issues + subcategory: + "/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://developer.github.com/v3/orgs/members/#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 + "/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://developer.github.com/v3/orgs/members/#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 + 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://developer.github.com/v3/orgs/members/#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 + "/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://developer.github.com/v3/orgs/members/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: members + 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://developer.github.com/v3/orgs/members/#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://developer.github.com/v3/orgs/members/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: members + 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. + + 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. + tags: + - orgs + operationId: orgs/remove-membership-for-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/orgs/members/#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 + "/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://developer.github.com/v3/migrations/orgs/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.wyandotte-preview+json + ``` + category: migrations + subcategory: orgs + 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://developer.github.com/v3/migrations/orgs/#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 + "/orgs/{org}/migrations/{migration_id}": + get: + summary: Get an organization migration status + description: |- + 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. + tags: + - migrations + operationId: migrations/get-status-for-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/migrations/orgs/#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. + * `exporting`, which means the migration is in progress. + * `exported`, which means the migration finished successfully. + * `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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.wyandotte-preview+json + ``` + category: migrations + subcategory: orgs + "/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://developer.github.com/v3/migrations/orgs/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.wyandotte-preview+json + ``` + category: migrations + subcategory: orgs + 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://developer.github.com/v3/migrations/orgs/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.wyandotte-preview+json + ``` + category: migrations + subcategory: orgs + "/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://developer.github.com/v3/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://developer.github.com/v3/migrations/orgs/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.wyandotte-preview+json + ``` + category: migrations + subcategory: orgs + "/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://developer.github.com/v3/migrations/orgs/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.wyandotte-preview+json + ``` + category: migrations + subcategory: orgs + "/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://developer.github.com/v3/orgs/outside_collaborators/#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 + "/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://developer.github.com/v3/orgs/outside_collaborators/#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://developer.github.com/v3/orgs/outside_collaborators/#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://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: outside-collaborators + 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://developer.github.com/v3/orgs/outside_collaborators/#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://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: outside-collaborators + "/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://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: + 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://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: + "/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://developer.github.com/v3/orgs/members/#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 + "/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://developer.github.com/v3/orgs/members/#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 + 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.) + + 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)." + tags: + - orgs + operationId: orgs/set-public-membership-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/orgs/members/#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 + 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://developer.github.com/v3/orgs/members/#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 + "/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://developer.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://developer.github.com/v3/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/). + + To access repository visibility during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.nebula-preview+json + ``` + - 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://developer.github.com/v3/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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.baptiste-preview+json + ``` + category: repos + subcategory: + 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. + + **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 + tags: + - repos + operationId: repos/create-in-org + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/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/). + + To access repository visibility during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.nebula-preview+json + ``` + - 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://developer.github.com/v3/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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.baptiste-preview+json + ``` + category: repos + subcategory: + "/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. + + 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 `read:org` scope. + operationId: billing/get-github-actions-billing-org + tags: + - billing + externalDocs: + description: API method documentation + url: https://developer.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: + "/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. + + 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 `read:org` scope. + operationId: billing/get-github-packages-billing-org + tags: + - billing + externalDocs: + description: API method documentation + url: https://developer.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: + "/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. + + 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 `read:org` scope. + operationId: billing/get-shared-storage-billing-org + tags: + - billing + externalDocs: + description: API method documentation + url: https://developer.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: + "/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. + + 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: + tags: + - teams + operationId: teams/list-idp-groups-for-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/team_sync/#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 + "/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://developer.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: + 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)." + + 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)". + tags: + - teams + operationId: teams/create + externalDocs: + description: API method documentation + url: https://developer.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" + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: teams + subcategory: + "/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`. + + **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://developer.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: + patch: + summary: Update a team + description: |- + 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}`. + tags: + - teams + operationId: teams/update-in-org + externalDocs: + description: API method documentation + url: https://developer.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: + delete: + summary: Delete a team + description: |- + 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}`. + tags: + - teams + operationId: teams/delete-in-org + externalDocs: + description: API method documentation + url: https://developer.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: + "/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://developer.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`. + tags: + - teams + operationId: teams/list-discussions-in-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussions/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: teams + subcategory: discussions + 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://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. + + **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://developer.github.com/v3/teams/discussions/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: teams + subcategory: discussions + "/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://developer.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}`. + tags: + - teams + operationId: teams/get-discussion-in-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussions/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: teams + subcategory: discussions + 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://developer.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}`. + tags: + - teams + operationId: teams/update-discussion-in-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussions/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: teams + subcategory: discussions + delete: + summary: Delete a discussion + description: |- + Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/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}`. + tags: + - teams + operationId: teams/delete-discussion-in-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussions/#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 + "/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://developer.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`. + tags: + - teams + operationId: teams/list-discussion-comments-in-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussion_comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: teams + subcategory: discussion-comments + post: + summary: Create a discussion comment + description: |- + Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + + 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:** 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://developer.github.com/v3/teams/discussion_comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: teams + subcategory: discussion-comments + "/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://developer.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}`. + tags: + - teams + operationId: teams/get-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussion_comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: teams + subcategory: discussion-comments + patch: + summary: Update a discussion comment + description: |- + Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + + **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://developer.github.com/v3/teams/discussion_comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: teams + subcategory: discussion-comments + delete: + summary: Delete a discussion comment + description: |- + Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + + **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://developer.github.com/v3/teams/discussion_comments/#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 + "/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://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/). + + **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://developer.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://developer.github.com/v3/reactions/#reaction-types). + Omit this parameter to list all reactions to a team discussion comment. + in: query + required: false + schema: + type: string + enum: + - "+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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + post: + summary: Create reaction for a team discussion comment + description: |- + Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. + + **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://developer.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://developer.github.com/v3/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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + "/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`. + + Delete 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/). + tags: + - reactions + operationId: reactions/delete-for-team-discussion-comment + externalDocs: + description: API method documentation + url: https://developer.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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + "/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://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/). + + **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://developer.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://developer.github.com/v3/reactions/#reaction-types). + Omit this parameter to list all reactions to a team discussion. + in: query + required: false + schema: + type: string + enum: + - "+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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + post: + summary: Create reaction for a team discussion + description: |- + Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. + + **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://developer.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://developer.github.com/v3/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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + "/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`. + + Delete 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/). + tags: + - reactions + operationId: reactions/delete-for-team-discussion + externalDocs: + description: API method documentation + url: https://developer.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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + "/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`. + + **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://developer.github.com/v3/teams/members/#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 + "/orgs/{org}/teams/{team_slug}/members": + get: + summary: List team members + description: |- + Team members will include the members of child teams. + + To 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://developer.github.com/v3/teams/members/#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 + "/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. + + 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://developer.github.com/v3/teams/#create-a-team). + tags: + - teams + operationId: teams/get-membership-for-user-in-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/members/#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 + 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. + + 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}`. + tags: + - teams + operationId: teams/add-or-update-membership-for-user-in-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/members/#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 + 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. + + 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}`. + tags: + - teams + operationId: teams/remove-membership-for-user-in-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/members/#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 + "/orgs/{org}/teams/{team_slug}/projects": + get: + summary: List team projects + description: |- + 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`. + tags: + - teams + operationId: teams/list-projects-in-org + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: teams + subcategory: + "/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. + + **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://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: teams + subcategory: + 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. + + **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://developer.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://developer.github.com/v3/#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://developer.github.com/v3/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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: teams + subcategory: + 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. + + **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://developer.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: + "/orgs/{org}/teams/{team_slug}/repos": + get: + summary: List team repositories + description: |- + 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`. + tags: + - teams + operationId: teams/list-repos-in-org + externalDocs: + description: API method documentation + url: https://developer.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: + "/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. + + 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 `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}`. + tags: + - teams + operationId: teams/check-permissions-for-repo-in-org + externalDocs: + description: API method documentation + url: https://developer.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: + 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://developer.github.com/v3/#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)". + tags: + - teams + operationId: teams/add-or-update-repo-permissions-in-org + externalDocs: + description: API method documentation + url: https://developer.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: + 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. + + **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://developer.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: + "/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. + + 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`. + tags: + - teams + operationId: teams/list-idp-groups-in-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/team_sync/#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 + 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. + + 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`. + tags: + - teams + operationId: teams/create-or-update-idp-group-connections-in-org + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/team_sync/#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 + "/orgs/{org}/teams/{team_slug}/teams": + get: + summary: List child teams + description: |- + 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`. + tags: + - teams + operationId: teams/list-child-in-org + externalDocs: + description: API method documentation + url: https://developer.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: + "/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://developer.github.com/v3/projects/cards/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: cards + patch: + summary: Update an existing project card + description: '' + tags: + - projects + operationId: projects/update-card + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/projects/cards/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: cards + delete: + summary: Delete a project card + description: '' + tags: + - projects + operationId: projects/delete-card + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/projects/cards/#delete-a-project-card + parameters: + - "$ref": "#/components/parameters/card_id" + responses: + '204': + description: Empty response + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: cards + "/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://developer.github.com/v3/projects/cards/#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" + '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 + '401': + "$ref": "#/components/responses/requires_authentication" + '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 + '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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: cards + "/projects/columns/{column_id}": + get: + summary: Get a project column + description: '' + tags: + - projects + operationId: projects/get-column + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/projects/columns/#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" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: columns + patch: + summary: Update an existing project column + description: '' + tags: + - projects + operationId: projects/update-column + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/projects/columns/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: columns + delete: + summary: Delete a project column + description: '' + tags: + - projects + operationId: projects/delete-column + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/projects/columns/#delete-a-project-column + parameters: + - "$ref": "#/components/parameters/column_id" + responses: + '204': + description: Empty response + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: columns + "/projects/columns/{column_id}/cards": + get: + summary: List project cards + description: '' + tags: + - projects + operationId: projects/list-cards + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/projects/cards/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: cards + 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. + + 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. + tags: + - projects + operationId: projects/create-card + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/projects/cards/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: cards + "/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://developer.github.com/v3/projects/columns/#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" + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: columns + "/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://developer.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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: + 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://developer.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" + '404': + description: Response if the authenticated user does not have access to + the project + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: + 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://developer.github.com/v3/projects/#delete-a-project + parameters: + - "$ref": "#/components/parameters/project-id" + responses: + '204': + description: Delete Success + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '410': + "$ref": "#/components/responses/gone" + '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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: + "/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://developer.github.com/v3/projects/collaborators/#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" + '404': + "$ref": "#/components/responses/not_found" + '415': + "$ref": "#/components/responses/preview_header_missing" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: collaborators + "/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://developer.github.com/v3/projects/collaborators/#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 + '404': + "$ref": "#/components/responses/not_found" + '415': + "$ref": "#/components/responses/preview_header_missing" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: collaborators + 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://developer.github.com/v3/projects/collaborators/#remove-project-collaborator + parameters: + - "$ref": "#/components/parameters/project-id" + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Empty response + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '415': + "$ref": "#/components/responses/preview_header_missing" + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: collaborators + "/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://developer.github.com/v3/projects/collaborators/#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" + '404': + "$ref": "#/components/responses/not_found" + '415': + "$ref": "#/components/responses/preview_header_missing" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: collaborators + "/projects/{project_id}/columns": + get: + summary: List project columns + description: '' + tags: + - projects + operationId: projects/list-columns + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/projects/columns/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: columns + post: + summary: Create a project column + description: '' + tags: + - projects + operationId: projects/create-column + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/projects/columns/#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" + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: columns + "/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. + + **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://developer.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: + "/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/). + + 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/). + tags: + - reactions + operationId: reactions/delete-legacy + externalDocs: + description: API method documentation + url: https://developer.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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: + deprecated: true + "/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. + + 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. + tags: + - repos + operationId: repos/get + externalDocs: + description: API method documentation + url: https://developer.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" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '301': + "$ref": "#/components/responses/moved_permanently" + 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://developer.github.com/v3/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/). + + To access repository visibility during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.nebula-preview+json + ``` + - required: false + name: scarlet-witch + note: |- + The Codes of Conduct API is currently available for developers to preview. + + To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.scarlet-witch-preview+json + ``` + category: repos + subcategory: + patch: + summary: Update a repository + description: "**Note**: To edit a repository's topics, use the [Replace all + repository topics](https://developer.github.com/v3/repos/#replace-all-repository-topics) + endpoint." + tags: + - repos + operationId: repos/update + externalDocs: + description: API method documentation + url: https://developer.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" + '422': + "$ref": "#/components/responses/validation_failed" + '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://developer.github.com/v3/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/). + + To access repository visibility during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.nebula-preview+json + ``` + - 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://developer.github.com/v3/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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.baptiste-preview+json + ``` + category: repos + subcategory: + delete: + summary: Delete a repository + description: |- + 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. + tags: + - repos + operationId: repos/delete + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/repos/#delete-a-repository + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: + "/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://developer.github.com/v3/actions/artifacts/#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 + 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 + "/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://developer.github.com/v3/actions/artifacts/#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 + 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://developer.github.com/v3/actions/artifacts/#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 + "/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 + 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. + tags: + - actions + operationId: actions/download-artifact + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/artifacts/#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 + "/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://developer.github.com/v3/actions/workflow-jobs/#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 + "/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 + 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. + tags: + - actions + operationId: actions/download-job-logs-for-workflow-run + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflow-jobs/#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 + "/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://developer.github.com/v3/actions/self-hosted-runners/#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 + 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 + "/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. + + You 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://developer.github.com/v3/actions/self-hosted-runners/#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 + "/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://developer.github.com/v3/actions/self-hosted-runners/#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 + "/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://developer.github.com/v3/actions/self-hosted-runners/#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 + "/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. + + You must authenticate using an access token with the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/get-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runners/#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 + 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. + + You must authenticate using an access token with the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/delete-self-hosted-runner-from-repo + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runners/#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 + "/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://developer.github.com/v3/#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. + tags: + - actions + operationId: actions/list-workflow-runs-for-repo + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflow-runs/#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 + 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 + "/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://developer.github.com/v3/actions/workflow-runs/#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 + 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 + private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use + this endpoint. + operationId: actions/delete-workflow-run + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflow-runs/#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 + "/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://developer.github.com/v3/actions/artifacts/#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 + 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 + "/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://developer.github.com/v3/actions/workflow-runs/#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 + "/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://developer.github.com/v3/#parameters). + tags: + - actions + operationId: actions/list-jobs-for-workflow-run + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflow-jobs/#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 + 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 + "/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 + `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. + tags: + - actions + operationId: actions/download-workflow-run-logs + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflow-runs/#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 + 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://developer.github.com/v3/actions/workflow-runs/#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 + "/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://developer.github.com/v3/actions/workflow-runs/#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 + "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": + get: + summary: Get workflow run usage + description: |- + **Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see "[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage)." + + 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. + tags: + - actions + operationId: actions/get-workflow-run-usage + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflow-runs/#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 + "/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://developer.github.com/v3/actions/secrets/#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 + 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 + "/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://developer.github.com/v3/actions/secrets/#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 + "/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://developer.github.com/v3/actions/secrets/#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 + put: + summary: Create or update a repository secret + description: |- + 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) + ``` + tags: + - actions + operationId: actions/create-or-update-repo-secret + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/secrets/#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://developer.github.com/v3/actions/secrets/#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 + 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://developer.github.com/v3/actions/secrets/#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 + "/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://developer.github.com/v3/actions/workflows/#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 + 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 + "/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://developer.github.com/v3/actions/workflows/#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 + "/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`. + + 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/disable-workflow + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflows/#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 + "/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`. + + 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)." + operationId: actions/create-workflow-dispatch + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflows/#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 reference of the workflow run. The reference can + be a branch, tag, or a commit SHA. + 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 + "/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`. + + 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/enable-workflow + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflows/#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 + "/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://developer.github.com/v3/#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. + tags: + - actions + operationId: actions/list-workflow-runs + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflow-runs/#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 + 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 + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": + get: + summary: Get workflow usage + description: |- + **Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see "[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage)." + + 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. + tags: + - actions + operationId: actions/get-workflow-usage + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflows/#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 + "/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://developer.github.com/v3/issues/assignees/#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 + "/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. + + 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. + tags: + - issues + operationId: issues/check-user-can-be-assigned + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/assignees/#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 + "/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://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.london-preview+json + ``` + category: repos + subcategory: + 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://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.london-preview+json + ``` + category: repos + subcategory: + "/repos/{owner}/{repo}/branches": + get: + summary: List branches + description: '' + tags: + - repos + operationId: repos/list-branches + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#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 + "/repos/{owner}/{repo}/branches/{branch}": + get: + summary: Get a branch + description: '' + tags: + - repos + operationId: repos/get-branch + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#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" + '415': + "$ref": "#/components/responses/preview_header_missing" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: branches + "/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://developer.github.com/v3/repos/branches/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.luke-cage-preview+json + ``` + category: repos + subcategory: branches + 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. + + 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. + tags: + - repos + operationId: repos/update-branch-protection + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#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" + '415': + "$ref": "#/components/responses/preview_header_missing" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.luke-cage-preview+json + ``` + category: repos + subcategory: branches + 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://developer.github.com/v3/repos/branches/#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 + "/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://developer.github.com/v3/repos/branches/#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 + 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. + + Adding 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://developer.github.com/v3/repos/branches/#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 + 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. + + Removing 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://developer.github.com/v3/repos/branches/#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 + "/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://developer.github.com/v3/repos/branches/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.luke-cage-preview+json + ``` + category: repos + subcategory: branches + 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. + + 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. + tags: + - repos + operationId: repos/update-pull-request-review-protection + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.luke-cage-preview+json + ``` + category: repos + subcategory: branches + 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://developer.github.com/v3/repos/branches/#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 + "/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. + + 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. + tags: + - repos + operationId: repos/get-commit-signature-protection + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.zzzax-preview+json + ``` + category: repos + subcategory: branches + 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. + + 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. + tags: + - repos + operationId: repos/create-commit-signature-protection + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.zzzax-preview+json + ``` + category: repos + subcategory: branches + 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. + + 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. + tags: + - repos + operationId: repos/delete-commit-signature-protection + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.zzzax-preview+json + ``` + category: repos + subcategory: branches + "/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://developer.github.com/v3/repos/branches/#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 + 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. + + Updating 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://developer.github.com/v3/repos/branches/#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 + 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://developer.github.com/v3/repos/branches/#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 + "/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://developer.github.com/v3/repos/branches/#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 + 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://developer.github.com/v3/repos/branches/#add-status-check-contexts + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/branch" + requestBody: + content: + application/json: + schema: + type: array + description: contexts parameter + items: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: array + items: + type: string + example: + - continuous-integration/travis-ci + - continuous-integration/jenkins + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + requestBodyParameterName: contexts + category: repos + subcategory: branches + 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://developer.github.com/v3/repos/branches/#set-status-check-contexts + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/branch" + requestBody: + content: + application/json: + schema: + type: array + description: contexts parameter + items: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: array + items: + type: string + example: + - continuous-integration/travis-ci + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + requestBodyParameterName: contexts + category: repos + subcategory: branches + 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://developer.github.com/v3/repos/branches/#remove-status-check-contexts + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/branch" + requestBody: + content: + application/json: + schema: + type: array + description: contexts parameter + items: + type: string + 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 + "/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. + + Lists who has access to this protected branch. + + **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://developer.github.com/v3/repos/branches/#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 + 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. + + Disables the ability to restrict who can push to this branch. + tags: + - repos + operationId: repos/delete-access-restrictions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#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 + "/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. + + 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. + tags: + - repos + operationId: repos/get-apps-with-access-to-protected-branch + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#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 + 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. + + 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. | + tags: + - repos + operationId: repos/add-app-access-restrictions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#add-app-access-restrictions + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/branch" + requestBody: + content: + application/json: + schema: + type: array + description: apps parameter + items: + type: string + 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 + 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. + + 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. | + tags: + - repos + operationId: repos/set-app-access-restrictions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#set-app-access-restrictions + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/branch" + requestBody: + content: + application/json: + schema: + type: array + description: apps parameter + items: + type: string + 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 + 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. + + 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. | + tags: + - repos + operationId: repos/remove-app-access-restrictions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#remove-app-access-restrictions + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/branch" + requestBody: + content: + application/json: + schema: + type: array + description: apps parameter + items: + type: string + 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 + "/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. + + Lists 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://developer.github.com/v3/repos/branches/#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 + 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. + + 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. | + tags: + - repos + operationId: repos/add-team-access-restrictions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#add-team-access-restrictions + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/branch" + requestBody: + content: + application/json: + schema: + type: array + description: teams parameter + items: + type: string + 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 + 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. + + 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. | + tags: + - repos + operationId: repos/set-team-access-restrictions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#set-team-access-restrictions + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/branch" + requestBody: + content: + application/json: + schema: + type: array + description: teams parameter + items: + type: string + 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 + 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. + + 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. | + tags: + - repos + operationId: repos/remove-team-access-restrictions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#remove-team-access-restrictions + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/branch" + requestBody: + content: + application/json: + schema: + type: array + description: teams parameter + items: + type: string + 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 + "/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. + + Lists 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://developer.github.com/v3/repos/branches/#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 + 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. + + 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. | + tags: + - repos + operationId: repos/add-user-access-restrictions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#add-user-access-restrictions + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/branch" + requestBody: + content: + application/json: + schema: + type: array + description: users parameter + items: + type: string + 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 + 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. + + 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. | + tags: + - repos + operationId: repos/set-user-access-restrictions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#set-user-access-restrictions + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/branch" + requestBody: + content: + application/json: + schema: + type: array + description: users parameter + items: + type: string + 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 + 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. + + 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. | + tags: + - repos + operationId: repos/remove-user-access-restrictions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/branches/#remove-user-access-restrictions + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/branch" + requestBody: + content: + application/json: + schema: + type: array + description: users parameter + items: + type: string + 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 + "/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. + + 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. + tags: + - checks + operationId: checks/create + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/checks/runs/#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://developer.github.com/v3/checks/runs/#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://developer.github.com/v3/checks/runs/#update-a-check-run) + endpoint. Each time you update the check run, annotations + are appended to the list of annotations that already exist + for the check run. For details about how you can view annotations + on GitHub, see "[About status checks](https://help.github.com/articles/about-status-checks#checks)". + See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object) + description for details about how to use this parameter. + items: + type: object + properties: + path: + 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://developer.github.com/v3/checks/runs/#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://developer.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://developer.github.com/v3/checks/runs/#actions-object) + description. To learn more about check runs and requested actions, + see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + To learn more about check runs and requested actions, see "[Check + runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + items: + type: object + properties: + label: + 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 + "/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. + + 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. + tags: + - checks + operationId: checks/get + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/checks/runs/#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 + 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. + + Updates 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://developer.github.com/v3/checks/runs/#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://developer.github.com/v3/checks/runs/#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://developer.github.com/v3/checks/runs/#update-a-check-run) + endpoint. Each time you update the check run, annotations + are appended to the list of annotations that already exist + for the check run. For details about annotations in the UI, + see "[About status checks](https://help.github.com/articles/about-status-checks#checks)". + See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) + description for details. + items: + type: object + properties: + path: + 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://developer.github.com/v3/checks/runs/#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://developer.github.com/v3/checks/runs/#actions-object) + description. To learn more about check runs and requested actions, + see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + items: + type: object + properties: + label: + 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 + "/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://developer.github.com/v3/checks/runs/#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 + "/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`. + + 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 "[Update repository preferences for check suites](https://developer.github.com/v3/checks/suites/#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://developer.github.com/v3/checks/suites/#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 + "/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://developer.github.com/v3/checks/suites/#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://developer.github.com/v3/checks/suites/#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://developer.github.com/v3/checks/suites/#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 + "/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`. + + 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. + tags: + - checks + operationId: checks/get-suite + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/checks/suites/#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 + "/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. + + 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. + tags: + - checks + operationId: checks/list-for-suite + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/checks/runs/#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 + 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 + "/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://developer.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. + tags: + - checks + operationId: checks/rerequest-suite + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/checks/suites/#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 + "/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 + `master`) and protected branches in a repository. For private repos, you must + use an access token with the `repo` scope. For public repos, you must use + an access token with `public_repo` and `repo:security_events` scopes. 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://developer.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" + '404': + description: Response if the ref doesn't match an existing ref + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: + "/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. + + 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`. + tags: + - code-scanning + operationId: code-scanning/get-alert + externalDocs: + description: API method documentation + url: https://developer.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" + '404': + "$ref": "#/components/responses/not_found" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: + patch: + summary: Update a code scanning alert + description: |- + Updates the status of a single code scanning alert. For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. + 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://developer.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" + '503': + description: When code scanning isn't available you can try again at a later + time + x-github: + enabledForApps: true + githubCloudOnly: false + previews: [] + category: code-scanning + "/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. + For private repos, you must use an access token with the `repo` scope. For + public repos, you must use an access token with `public_repo` and `repo:security_events` + scopes. 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://developer.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" + x-github: + enabledForApps: true + githubCloudOnly: false + previews: [] + category: code-scanning + "/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. + For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. 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://developer.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. + 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. + 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 + '404': + description: Response if `commit_sha` or `ref` cannot be found + x-github: + enabledForApps: true + githubCloudOnly: false + previews: [] + category: code-scanning + "/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. + + Team members will include the members of child teams. + tags: + - repos + operationId: repos/list-collaborators + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/collaborators/#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 + "/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. + + Team members will include the members of child teams. + tags: + - repos + operationId: repos/check-collaborator + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/collaborators/#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 + 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://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. + + 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://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. + tags: + - repos + operationId: repos/add-collaborator + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/collaborators/#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 + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: collaborators + delete: + summary: Remove a repository collaborator + description: '' + tags: + - repos + operationId: repos/remove-collaborator + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/collaborators/#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 + "/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://developer.github.com/v3/repos/collaborators/#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 + "/repos/{owner}/{repo}/comments": + get: + summary: List commit comments for a repository + description: |- + Commit Comments use [these custom media types](https://developer.github.com/v3/repos/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/). + + Comments are ordered by ascending ID. + tags: + - repos + operationId: repos/list-commit-comments-for-repo + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: repos + subcategory: comments + "/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://developer.github.com/v3/repos/comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: repos + subcategory: comments + patch: + summary: Update a commit comment + description: '' + tags: + - repos + operationId: repos/update-commit-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/comments/#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 + delete: + summary: Delete a commit comment + description: '' + tags: + - repos + operationId: repos/delete-commit-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/comments/#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 + "/repos/{owner}/{repo}/comments/{comment_id}/reactions": + get: + summary: List reactions for a commit comment + description: List the reactions to a [commit comment](https://developer.github.com/v3/repos/comments/). + tags: + - reactions + operationId: reactions/list-for-commit-comment + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/reactions/#reaction-types). + Omit this parameter to list all reactions to a commit comment. + in: query + required: false + schema: + type: string + enum: + - "+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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + post: + summary: Create reaction for a commit comment + description: 'Create a reaction to a [commit comment](https://developer.github.com/v3/repos/comments/). + A response with a `Status: 200 OK` means that you already added the reaction + type to this commit comment.' + tags: + - reactions + operationId: reactions/create-for-commit-comment + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + "/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`. + + Delete a reaction to a [commit comment](https://developer.github.com/v3/repos/comments/). + tags: + - reactions + operationId: reactions/delete-for-commit-comment + externalDocs: + description: API method documentation + url: https://developer.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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + "/repos/{owner}/{repo}/commits": + get: + summary: List commits + description: |- + **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. | + tags: + - repos + operationId: repos/list-commits + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/commits/#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/simple-commit" + examples: + default: + "$ref": "#/components/examples/simple-commit-items" + headers: + Link: + "$ref": "#/components/headers/link" + '500': + "$ref": "#/components/responses/internal_error" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: commits + "/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. + + Returns 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://developer.github.com/v3/repos/commits/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.groot-preview+json + ``` + category: repos + subcategory: commits + "/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://developer.github.com/v3/repos/comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: repos + subcategory: comments + post: + summary: Create a commit comment + description: |- + 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. + tags: + - repos + operationId: repos/create-commit-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/comments/#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 + "/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://developer.github.com/v3/pulls/#list-pull-requests) + endpoint. + tags: + - repos + operationId: repos/list-pull-requests-associated-with-commit + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/commits/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.groot-preview+json + ``` + category: repos + subcategory: commits + "/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. + **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://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: + | 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. | + tags: + - repos + operationId: repos/get-commit + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/commits/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: commits + "/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. + + 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. + tags: + - checks + operationId: checks/list-for-ref + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/checks/runs/#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 + 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 + "/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`. + + 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. + tags: + - checks + operationId: checks/list-suites-for-ref + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/checks/suites/#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 + 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 + "/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. + + 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` + tags: + - repos + operationId: repos/get-combined-status-for-ref + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/statuses/#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 + "/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. + + This 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://developer.github.com/v3/repos/statuses/#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 + "/repos/{owner}/{repo}/community/code_of_conduct": + get: + summary: Get the code of conduct for a repository + description: This method returns the contents of the repository's code of conduct + file, if one is detected. + tags: + - codes-of-conduct + operationId: codes-of-conduct/get-for-repo + externalDocs: + description: API method documentation + url: https://developer.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. + + To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.scarlet-witch-preview+json + ``` + category: codes-of-conduct + subcategory: + "/repos/{owner}/{repo}/community/profile": + get: + summary: Get community profile metrics + description: This endpoint will return all community profile metrics, including + an overall health score, repository description, the presence of documentation, + detected code of conduct, detected license, and the presence of ISSUE\_TEMPLATE, + PULL\_REQUEST\_TEMPLATE, README, and CONTRIBUTING files. + tags: + - repos + operationId: repos/get-community-profile-metrics + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/community/#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 + previews: + - required: true + name: black-panther + note: 'We''re currently offering a preview of the Community Profile API + (also known as community health). To access the API during the preview + period, you must provide a custom [media type](https://developer.github.com/v3/media) + in the `Accept` header: ```shell application/vnd.github.black-panther-preview+json + ```' + category: repos + subcategory: community + "/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`. + 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 [List commits](https://developer.github.com/v3/repos/commits/#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. | + tags: + - repos + operationId: repos/compare-commits + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/commits/#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" + '500': + "$ref": "#/components/responses/internal_error" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: commits + "/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 all files in the repository.\n\nFiles and symlinks support + [a custom media type](https://developer.github.com/v3/repos/contents/#custom-media-types) + for\nretrieving the raw content or rendered HTML (when supported). All content + types support [a custom media\ntype](https://developer.github.com/v3/repos/contents/#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://developer.github.com/v3/git/trees/).\n* This API has an upper + limit of 1,000 files for a directory. If you need to retrieve more files, + use the [Git Trees\nAPI](https://developer.github.com/v3/git/trees/#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://developer.github.com/v3/repos/contents/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '302': + "$ref": "#/components/responses/found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents + 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://developer.github.com/v3/repos/contents/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents + delete: + summary: Delete a file + description: |- + 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. + tags: + - repos + operationId: repos/delete-file + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/contents/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents + "/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. + + 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. + tags: + - repos + operationId: repos/list-contributors + externalDocs: + description: API method documentation + url: https://developer.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: + "/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://developer.github.com/v3/repos/deployments/#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. + + To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.ant-man-preview+json + ``` + category: repos + subcategory: deployments + post: + summary: Create a deployment + description: |- + 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://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. + + #### 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`. + tags: + - repos + operationId: repos/create-deployment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/deployments/#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://developer.github.com/v3/repos/statuses/) + contexts to verify against commit status checks. If you omit this + parameter, GitHub verifies all unique contexts before creating + a deployment. To bypass checking entirely, pass an empty array. + Defaults to all unique contexts. + items: + type: string + payload: + 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://developer.github.com/v3/previews/#enhanced-deployments) + custom media type. **Note:** This parameter requires you to use + the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) + custom media type." + default: false + production_environment: + type: boolean + description: "Specifies if the given environment is one that end-users + directly interact with. Default: `true` when `environment` is + `production` and `false` otherwise. \n**Note:** This parameter + requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) + custom media type." + 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://developer.github.com/v3/repos/deployments/#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. + + To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.ant-man-preview+json + ``` + category: repos + subcategory: deployments + "/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://developer.github.com/v3/repos/deployments/#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. + + To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.ant-man-preview+json + ``` + category: repos + subcategory: deployments + 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. + + 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://developer.github.com/v3/repos/deployments/#create-a-deployment)" and "[Create a deployment status](https://developer.github.com/v3/repos/deployments/#create-a-deployment-status)." + tags: + - repos + operationId: repos/delete-deployment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/deployments/#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 + "/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://developer.github.com/v3/repos/deployments/#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. + + To 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.flash-preview+json + ``` + - 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. + + To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.ant-man-preview+json + ``` + category: repos + subcategory: deployments + post: + summary: Create a deployment status + description: |- + 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. + tags: + - repos + operationId: repos/create-deployment-status + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/deployments/#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://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. 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://developer.github.com/v3/previews/#enhanced-deployments) + custom media type. **Note:** This parameter requires you to use + the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) + custom media type." + default: '' + description: + 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://developer.github.com/v3/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://developer.github.com/v3/previews/#enhanced-deployments) + custom media type. **Note:** This parameter requires you to use + the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) + custom media type." + default: '' + auto_inactive: + type: boolean + description: "Adds a new `inactive` status to all prior non-transient, + non-production environment deployments with the same repository + and `environment` name as the created status's deployment. An + `inactive` status is only added to deployments that had a `success` + state. Default: `true` \n**Note:** To add an `inactive` status + to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) + custom media type. \n**Note:** This parameter requires you to + use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) + custom media type." + required: + - 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. + + To 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.flash-preview+json + ``` + - 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. + + To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.ant-man-preview+json + ``` + category: repos + subcategory: deployments + "/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://developer.github.com/v3/repos/deployments/#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. + + To 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.flash-preview+json + ``` + - 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. + + To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.ant-man-preview+json + ``` + category: repos + subcategory: deployments + "/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://developer.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. 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. + tags: + - repos + operationId: repos/create-dispatch-event + externalDocs: + description: API method documentation + url: https://developer.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: + "/repos/{owner}/{repo}/events": + get: + summary: List repository events + description: '' + tags: + - activity + operationId: activity/list-repo-events + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/events/#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 + "/repos/{owner}/{repo}/forks": + get: + summary: List forks + description: '' + tags: + - repos + operationId: repos/list-forks + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/forks/#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 + post: + summary: Create a fork + description: |- + 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) or [GitHub Premium Support](https://premium.githubsupport.com). + tags: + - repos + operationId: repos/create-fork + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/forks/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: forks + "/repos/{owner}/{repo}/git/blobs": + post: + summary: Create a blob + description: '' + tags: + - git + operationId: git/create-blob + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/git/blobs/#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 + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: git + subcategory: blobs + "/repos/{owner}/{repo}/git/blobs/{file_sha}": + get: + summary: Get a blob + description: |- + The `content` in the response will always be Base64 encoded. + + _Note_: This API supports blobs up to 100 megabytes in size. + tags: + - git + operationId: git/get-blob + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/git/blobs/#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" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: git + subcategory: blobs + "/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). + **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. | + tags: + - git + operationId: git/create-commit + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/git/commits/#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----- + + iQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv + 7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI + DkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n + 2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA + OQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k + nrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU + +NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB + jHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ + 3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+ + UpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr + X11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp + eSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc= + =5Io4 + -----END PGP SIGNATURE----- + 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 + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: git + subcategory: commits + "/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). + **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. | + tags: + - git + operationId: git/get-commit + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/git/commits/#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 + "/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. + + 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-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`. + tags: + - git + operationId: git/list-matching-refs + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/git/refs/#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 + "/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. + + **Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/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://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)". + tags: + - git + operationId: git/get-ref + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/git/refs/#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 + "/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://developer.github.com/v3/git/refs/#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 + "/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://developer.github.com/v3/git/refs/#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 + delete: + summary: Delete a reference + description: '' + tags: + - git + operationId: git/delete-ref + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/git/refs/#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 + "/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://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: + | 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. | + tags: + - git + operationId: git/create-tag + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/git/tags/#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 + "/repos/{owner}/{repo}/git/tags/{tag_sha}": + get: + summary: Get a tag + description: |- + **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. | + tags: + - git + operationId: git/get-tag + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/git/tags/#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 + "/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. + + 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)." + tags: + - git + operationId: git/create-tree + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/git/trees/#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 the tree you want to update with new data. + If you don't set this, the commit will be created on top of everything; + however, it will only contain your change, the rest of your files + will show up as deleted. + required: + - 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 + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: git + subcategory: trees + "/repos/{owner}/{repo}/git/trees/{tree_sha}": + get: + summary: Get a tree + description: |- + 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. + tags: + - git + operationId: git/get-tree + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/git/trees/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: git + subcategory: trees + "/repos/{owner}/{repo}/hooks": + get: + summary: List repository webhooks + description: '' + tags: + - repos + operationId: repos/list-webhooks + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/hooks/#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: hooks + post: + summary: Create a repository webhook + description: |- + Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can + share the same `config` as long as those webhooks do not have any `events` that overlap. + tags: + - repos + operationId: repos/create-webhook + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/hooks/#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://developer.github.com/v3/repos/hooks/#create-hook-config-params). + properties: + url: + type: string + description: The URL to which the payloads will be delivered. + content_type: + type: string + description: The media type used to serialize the payloads. + Supported values include `json` and `form`. The default is + `form`. + secret: + type: string + description: If provided, the `secret` will be used as the `key` + to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/event-payloads/#delivery-headers) + header. + 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.** + token: + type: string + example: '"abc"' + digest: + type: string + example: '"md5"' + required: + - url + events: + type: array + description: Determines what [events](https://developer.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 + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: hooks + "/repos/{owner}/{repo}/hooks/{hook_id}": + get: + summary: Get a repository webhook + description: '' + tags: + - repos + operationId: repos/get-webhook + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/hooks/#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: hooks + patch: + summary: Update a repository webhook + description: '' + tags: + - repos + operationId: repos/update-webhook + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/hooks/#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://developer.github.com/v3/repos/hooks/#create-hook-config-params). + properties: + url: + type: string + description: The URL to which the payloads will be delivered. + content_type: + type: string + description: The media type used to serialize the payloads. + Supported values include `json` and `form`. The default is + `form`. + secret: + type: string + description: If provided, the `secret` will be used as the `key` + to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/event-payloads/#delivery-headers) + header. + 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.** + address: + type: string + example: '"bar@example.com"' + room: + type: string + example: '"The Serious Room"' + required: + - url + events: + type: array + description: Determines what [events](https://developer.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" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: hooks + delete: + summary: Delete a repository webhook + description: '' + tags: + - repos + operationId: repos/delete-webhook + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/hooks/#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: hooks + "/repos/{owner}/{repo}/hooks/{hook_id}/pings": + post: + summary: Ping a repository webhook + description: This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) + to be sent to the hook. + tags: + - repos + operationId: repos/ping-webhook + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/hooks/#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: hooks + "/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. + + **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + tags: + - repos + operationId: repos/test-push-webhook + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/hooks/#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: hooks + "/repos/{owner}/{repo}/import": + get: + summary: Get an import status + description: |- + 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://developer.github.com/v3/migrations/source_imports/#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://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://developer.github.com/v3/migrations/source_imports/#update-an-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 an import](https://developer.github.com/v3/migrations/source_imports/#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. + tags: + - migrations + operationId: migrations/get-import-status + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/migrations/source_imports/#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 + 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://developer.github.com/v3/migrations/source_imports/#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 + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: migrations + subcategory: source-imports + 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 + request. If no parameters are provided, the import will be restarted. + tags: + - migrations + operationId: migrations/update-import + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/migrations/source_imports/#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 + 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://developer.github.com/v3/migrations/source_imports/#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 + "/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 `. + + This endpoint and the [Map a commit author](https://developer.github.com/v3/migrations/source_imports/#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://developer.github.com/v3/migrations/source_imports/#get-commit-authors + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/since" + 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 + "/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://developer.github.com/v3/migrations/source_imports/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: migrations + subcategory: source-imports + "/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://developer.github.com/v3/migrations/source_imports/#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 + "/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://developer.github.com/v3/migrations/source_imports/#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 + "/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. + + 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. + tags: + - apps + operationId: apps/get-repo-installation + externalDocs: + description: API method documentation + url: https://developer.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: + "/repos/{owner}/{repo}/interaction-limits": + get: + summary: Get interaction restrictions for a repository + description: Shows which group of GitHub users can interact with this repository + and when the restriction expires. If there are no restrictions, you will see + an empty response. + tags: + - interactions + operationId: interactions/get-restrictions-for-repo + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/interactions/repos/#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" + examples: + default: + "$ref": "#/components/examples/interaction-limit-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: + - required: true + name: sombra + note: |- + The Interactions API is currently in public preview. See the [blog post](https://developer.github.com/changes/2018-12-18-interactions-preview) preview for more details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.sombra-preview + ``` + category: interactions + subcategory: repos + put: + summary: Set interaction restrictions for a repository + description: Temporarily restricts interactions to certain GitHub users within + the given repository. You must have owner or admin access to set restrictions. + tags: + - interactions + operationId: interactions/set-restrictions-for-repo + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/interactions/repos/#set-interaction-restrictions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + content: + application/json: + schema: + type: object + properties: + limit: + type: string + description: 'Specifies the group of GitHub users who can comment, + open issues, or create pull requests for the given repository. + Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.' + enum: + - existing_users + - contributors_only + - collaborators_only + required: + - limit + example: + limit: collaborators_only + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/interaction-limit" + examples: + default: + "$ref": "#/components/examples/interaction-limit-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: + - required: true + name: sombra + note: |- + The Interactions API is currently in public preview. See the [blog post](https://developer.github.com/changes/2018-12-18-interactions-preview) preview for more details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.sombra-preview + ``` + category: interactions + subcategory: repos + 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. + tags: + - interactions + operationId: interactions/remove-restrictions-for-repo + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/interactions/repos/#remove-interaction-restrictions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Empty response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: + - required: true + name: sombra + note: |- + The Interactions API is currently in public preview. See the [blog post](https://developer.github.com/changes/2018-12-18-interactions-preview) preview for more details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.sombra-preview + ``` + category: interactions + subcategory: repos + "/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://developer.github.com/v3/repos/invitations/#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 + "/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://developer.github.com/v3/repos/invitations/#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 + delete: + summary: Delete a repository invitation + description: '' + tags: + - repos + operationId: repos/delete-invitation + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/invitations/#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 + "/repos/{owner}/{repo}/issues": + get: + summary: List repository issues + description: |- + 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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + tags: + - issues + operationId: issues/list-for-repo + externalDocs: + description: API method documentation + url: https://developer.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" + '422': + "$ref": "#/components/responses/validation_failed" + '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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: issues + subcategory: + 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. + + 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. + tags: + - issues + operationId: issues/create + externalDocs: + description: API method documentation + url: https://developer.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" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: issues + subcategory: + "/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://developer.github.com/v3/issues/comments/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: issues + subcategory: comments + "/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://developer.github.com/v3/issues/comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: issues + subcategory: comments + patch: + summary: Update an issue comment + description: '' + tags: + - issues + operationId: issues/update-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/comments/#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 + delete: + summary: Delete an issue comment + description: '' + tags: + - issues + operationId: issues/delete-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/comments/#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 + "/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://developer.github.com/v3/issues/comments/). + tags: + - reactions + operationId: reactions/list-for-issue-comment + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/reactions/#reaction-types). + Omit this parameter to list all reactions to an issue comment. + in: query + required: false + schema: + type: string + enum: + - "+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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + post: + summary: Create reaction for an issue comment + description: 'Create a reaction to an [issue comment](https://developer.github.com/v3/issues/comments/). + A response with a `Status: 200 OK` means that you already added the reaction + type to this issue comment.' + tags: + - reactions + operationId: reactions/create-for-issue-comment + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + "/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`. + + Delete a reaction to an [issue comment](https://developer.github.com/v3/issues/comments/). + tags: + - reactions + operationId: reactions/delete-for-issue-comment + externalDocs: + description: API method documentation + url: https://developer.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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + "/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://developer.github.com/v3/issues/events/#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). + + To 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.starfox-preview+json + ``` + category: issues + subcategory: events + "/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://developer.github.com/v3/issues/events/#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" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + '403': + "$ref": "#/components/responses/forbidden" + 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). + + To 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.starfox-preview+json + ``` + category: issues + subcategory: events + "/repos/{owner}/{repo}/issues/{issue_number}": + get: + summary: Get an issue + description: |- + The API returns a [`301 Moved Permanently` status](https://developer.github.com/v3/#http-redirects) if the issue was + [transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If + the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe + to the [`issues`](https://developer.github.com/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://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. + tags: + - issues + operationId: issues/get + externalDocs: + description: API method documentation + url: https://developer.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" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + '304': + "$ref": "#/components/responses/not_modified" + 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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: issues + subcategory: + 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://developer.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" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + "$ref": "#/components/responses/service_unavailable" + '403': + "$ref": "#/components/responses/forbidden" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: issues + subcategory: + "/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://developer.github.com/v3/issues/assignees/#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 + 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://developer.github.com/v3/issues/assignees/#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 + "/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://developer.github.com/v3/issues/comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: issues + subcategory: comments + 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://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. + tags: + - issues + operationId: issues/create-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/comments/#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" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: issues + subcategory: comments + "/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://developer.github.com/v3/issues/events/#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). + + To 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.starfox-preview+json + ``` + category: issues + subcategory: events + "/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://developer.github.com/v3/issues/labels/#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 + post: + summary: Add labels to an issue + description: '' + tags: + - issues + operationId: issues/add-labels + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/labels/#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 + 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://developer.github.com/v3/issues/labels/#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 + delete: + summary: Remove all labels from an issue + description: '' + tags: + - issues + operationId: issues/remove-all-labels + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/labels/#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 + "/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://developer.github.com/v3/issues/labels/#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 + "/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. + + 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)." + tags: + - issues + operationId: issues/lock + externalDocs: + description: API method documentation + url: https://developer.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" + '410': + "$ref": "#/components/responses/gone" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: issues + subcategory: + 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://developer.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: + "/repos/{owner}/{repo}/issues/{issue_number}/reactions": + get: + summary: List reactions for an issue + description: List the reactions to an [issue](https://developer.github.com/v3/issues/). + tags: + - reactions + operationId: reactions/list-for-issue + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/reactions/#reaction-types). + Omit this parameter to list all reactions to an issue. + in: query + required: false + schema: + type: string + enum: + - "+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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + post: + summary: Create reaction for an issue + description: 'Create a reaction to an [issue](https://developer.github.com/v3/issues/). + A response with a `Status: 200 OK` means that you already added the reaction + type to this issue.' + tags: + - reactions + operationId: reactions/create-for-issue + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + "/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`. + + Delete a reaction to an [issue](https://developer.github.com/v3/issues/). + tags: + - reactions + operationId: reactions/delete-for-issue + externalDocs: + description: API method documentation + url: https://developer.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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + "/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://developer.github.com/v3/issues/timeline/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.mockingbird-preview + ``` + - 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). + + To 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.starfox-preview+json + ``` + category: issues + subcategory: timeline + "/repos/{owner}/{repo}/keys": + get: + summary: List deploy keys + description: '' + tags: + - repos + operationId: repos/list-deploy-keys + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/keys/#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 + 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://developer.github.com/v3/repos/keys/#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 + "/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://developer.github.com/v3/repos/keys/#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 + 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://developer.github.com/v3/repos/keys/#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 + "/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://developer.github.com/v3/issues/labels/#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 + post: + summary: Create a label + description: '' + tags: + - issues + operationId: issues/create-label + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/labels/#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 + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: issues + subcategory: labels + "/repos/{owner}/{repo}/labels/{name}": + get: + summary: Get a label + description: '' + tags: + - issues + operationId: issues/get-label + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/labels/#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 + patch: + summary: Update a label + description: '' + tags: + - issues + operationId: issues/update-label + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/labels/#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 + delete: + summary: Delete a label + description: '' + tags: + - issues + operationId: issues/delete-label + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/labels/#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 + "/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://developer.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: + "/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. + + Similar to [Get repository content](https://developer.github.com/v3/repos/contents/#get-repository-content), 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. + tags: + - licenses + operationId: licenses/get-for-repo + externalDocs: + description: API method documentation + url: https://developer.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: + "/repos/{owner}/{repo}/merges": + post: + summary: Merge a branch + description: '' + tags: + - repos + operationId: repos/merge + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/merging/#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" + '404': + description: response + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + example: '"https://developer.github.com/v3/repos/merging/#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://developer.github.com/v3/repos/merging/#perform-a-merge"' + examples: + merge-conflict-response: + value: + message: Merge Conflict + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: merging + "/repos/{owner}/{repo}/milestones": + get: + summary: List milestones + description: '' + tags: + - issues + operationId: issues/list-milestones + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/milestones/#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 + post: + summary: Create a milestone + description: '' + tags: + - issues + operationId: issues/create-milestone + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/milestones/#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 + "/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://developer.github.com/v3/issues/milestones/#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 + patch: + summary: Update a milestone + description: '' + tags: + - issues + operationId: issues/update-milestone + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/milestones/#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 + delete: + summary: Delete a milestone + description: '' + tags: + - issues + operationId: issues/delete-milestone + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/issues/milestones/#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 + "/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://developer.github.com/v3/issues/labels/#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 + "/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://developer.github.com/v3/activity/notifications/#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 + 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://developer.github.com/v3/activity/notifications/#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://developer.github.com/v3/activity/notifications/#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 + "/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://developer.github.com/v3/repos/pages/#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 + 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://developer.github.com/v3/repos/pages/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '415': + "$ref": "#/components/responses/preview_header_missing" + '409': + "$ref": "#/components/responses/conflict" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.switcheroo-preview+json + ``` + category: repos + subcategory: pages + 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://developer.github.com/v3/repos/pages/#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 + '422': + "$ref": "#/components/responses/validation_failed" + '400': + "$ref": "#/components/responses/bad_request" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: pages + delete: + summary: Delete a GitHub Pages site + description: '' + tags: + - repos + operationId: repos/delete-pages-site + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/pages/#delete-a-github-pages-site + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Empty response + '422': + "$ref": "#/components/responses/validation_failed" + '415': + "$ref": "#/components/responses/preview_header_missing" + '404': + "$ref": "#/components/responses/not_found" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.switcheroo-preview+json + ``` + category: repos + subcategory: pages + "/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://developer.github.com/v3/repos/pages/#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 + 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. + + 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. + tags: + - repos + operationId: repos/request-pages-build + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/pages/#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 + "/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://developer.github.com/v3/repos/pages/#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 + "/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://developer.github.com/v3/repos/pages/#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 + "/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://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: + 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://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: + "/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://developer.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: + 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. + + 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. + tags: + - pulls + operationId: pulls/create + externalDocs: + description: API method documentation + url: https://developer.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: + "/repos/{owner}/{repo}/pulls/comments": + get: + summary: List review comments in a repository + description: |- + **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. + tags: + - pulls + operationId: pulls/list-review-comments-for-repo + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/pulls/comments/#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. To access the new response fields during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.comfort-fade-preview+json + ``` + - 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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: pulls + subcategory: comments + "/repos/{owner}/{repo}/pulls/comments/{comment_id}": + get: + summary: Get a review comment for a pull request + description: |- + **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. + tags: + - pulls + operationId: pulls/get-review-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/pulls/comments/#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. To access the new response fields during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.comfort-fade-preview+json + ``` + - 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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: pulls + subcategory: comments + patch: + summary: Update a review comment for a pull request + description: |- + **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. + tags: + - pulls + operationId: pulls/update-review-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/pulls/comments/#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. To access the new response fields during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.comfort-fade-preview+json + ``` + category: pulls + subcategory: comments + 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://developer.github.com/v3/pulls/comments/#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 + "/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://developer.github.com/v3/pulls/comments/). + tags: + - reactions + operationId: reactions/list-for-pull-request-review-comment + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/reactions/#reaction-types). + Omit this parameter to list all reactions to a pull request review comment. + in: query + required: false + schema: + type: string + enum: + - "+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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + post: + summary: Create reaction for a pull request review comment + description: 'Create a reaction to a [pull request review comment](https://developer.github.com/v3/pulls/comments/). + A response with a `Status: 200 OK` means that you already added the reaction + type to this pull request review comment.' + tags: + - reactions + operationId: reactions/create-for-pull-request-review-comment + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + "/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.` + + Delete a reaction to a [pull request review comment](https://developer.github.com/v3/pulls/comments/). + tags: + - reactions + operationId: reactions/delete-for-pull-request-comment + externalDocs: + description: API method documentation + url: https://developer.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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: reactions + subcategory: + "/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. + + 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. + tags: + - pulls + operationId: pulls/get + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/media/#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" + '500': + "$ref": "#/components/responses/internal_error" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: pulls + subcategory: + 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. + + 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. + tags: + - pulls + operationId: pulls/update + externalDocs: + description: API method documentation + url: https://developer.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" + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: pulls + subcategory: + "/repos/{owner}/{repo}/pulls/{pull_number}/comments": + get: + summary: List review comments on a pull request + description: |- + **Note:** Multi-line comments on pull requests are currently in public beta and subject to change. + + Lists all 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. + tags: + - pulls + operationId: pulls/list-review-comments + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/pulls/comments/#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. To access the new response fields during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.comfort-fade-preview+json + ``` + - 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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: pulls + subcategory: comments + post: + summary: Create a review comment for a pull request + description: |- + **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 "[Create an issue comment](https://developer.github.com/v3/issues/comments/#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 [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. + tags: + - pulls + operationId: pulls/create-review-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/pulls/comments/#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 + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + 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. To access the new response fields during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.comfort-fade-preview+json + ``` + category: pulls + subcategory: comments + "/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. + + 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. + tags: + - pulls + operationId: pulls/create-reply-for-review-comment + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/pulls/comments/#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 + "/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://developer.github.com/v3/repos/commits/#list-commits) + endpoint. + tags: + - pulls + operationId: pulls/list-commits + externalDocs: + description: API method documentation + url: https://developer.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/simple-commit" + examples: + default: + "$ref": "#/components/examples/simple-commit-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: pulls + subcategory: + "/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://developer.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: + "/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://developer.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: + put: + summary: Merge a pull request + description: This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). + Creating content too quickly using this endpoint may result in abuse rate + limiting. See "[Abuse rate limits](https://developer.github.com/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. + tags: + - pulls + operationId: pulls/merge + externalDocs: + description: API method documentation + url: https://developer.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" + '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 + documentation_url: https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button + '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. + documentation_url: https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: pulls + subcategory: + "/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://developer.github.com/v3/pulls/review_requests/#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 + post: + summary: Request reviewers 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://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. + tags: + - pulls + operationId: pulls/request-reviewers + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/pulls/review_requests/#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" + '422': + description: Response if user is not a collaborator + '403': + "$ref": "#/components/responses/forbidden" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: pulls + subcategory: review-requests + delete: + summary: Remove requested reviewers from a pull request + description: '' + tags: + - pulls + operationId: pulls/remove-requested-reviewers + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/pulls/review_requests/#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 + "/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://developer.github.com/v3/pulls/reviews/#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 + 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://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. + + 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://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-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. + tags: + - pulls + operationId: pulls/create-review + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/pulls/reviews/#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://developer.github.com/v3/pulls/reviews/#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" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: pulls + subcategory: reviews + "/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://developer.github.com/v3/pulls/reviews/#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 + 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://developer.github.com/v3/pulls/reviews/#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 + 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://developer.github.com/v3/pulls/reviews/#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" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: pulls + subcategory: reviews + "/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://developer.github.com/v3/pulls/reviews/#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 + "/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://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." + tags: + - pulls + operationId: pulls/dismiss-review + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/pulls/reviews/#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 + "/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://developer.github.com/v3/pulls/reviews/#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" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: pulls + subcategory: reviews + "/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://developer.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://developer.github.com/v3/repos/commits/#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 + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + '415': + "$ref": "#/components/responses/preview_header_missing" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.lydian-preview+json + ``` + category: pulls + subcategory: + "/repos/{owner}/{repo}/readme": + get: + summary: Get a repository README + description: |- + 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. + tags: + - repos + operationId: repos/get-readme + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/contents/#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 + "/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://developer.github.com/v3/repos/#list-repository-tags). + + Information 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://developer.github.com/v3/repos/releases/#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 + post: + summary: Create a release + description: |- + 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. + tags: + - repos + operationId: repos/create-release + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/releases/#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 + "/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://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. + tags: + - repos + operationId: repos/get-release-asset + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/releases/#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://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. + content: + application/json: + schema: + "$ref": "#/components/schemas/release-asset" + examples: + default: + "$ref": "#/components/examples/release-asset" + '404': + "$ref": "#/components/responses/not_found" + '415': + "$ref": "#/components/responses/preview_header_missing" + '302': + "$ref": "#/components/responses/found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: releases + 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://developer.github.com/v3/repos/releases/#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 + delete: + summary: Delete a release asset + description: '' + tags: + - repos + operationId: repos/delete-release-asset + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/releases/#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 + "/repos/{owner}/{repo}/releases/latest": + get: + summary: Get the latest release + description: |- + 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. + tags: + - repos + operationId: repos/get-latest-release + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/releases/#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 + "/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://developer.github.com/v3/repos/releases/#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 + "/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://developer.github.com/v3/#hypermedia)." + tags: + - repos + operationId: repos/get-release + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/releases/#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://developer.github.com/v3/#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 + 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://developer.github.com/v3/repos/releases/#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 + 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://developer.github.com/v3/repos/releases/#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 + "/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://developer.github.com/v3/repos/releases/#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 + post: + summary: Upload a release asset + description: "This endpoint makes use of [a Hypermedia relation](https://developer.github.com/v3/#hypermedia) + to determine which URL to access. 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://developer.github.com/v3/repos/releases/#create-a-release) + to upload a release asset.\n\nYou need to use an HTTP client which supports + [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to + this endpoint.\n\nMost libraries will set the required `Content-Length` header + automatically. Use the required `Content-Type` header to provide the media + type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). + For example: \n\n`application/zip`\n\nGitHub expects the asset data in its + raw binary form, rather than JSON. You will send the raw binary content of + the asset as the request body. Everything else about the endpoint is the same + as the rest of the API. For example,\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://developer.github.com/v3/repos/releases/#list-assets-for-a-release)\"\nendpoint + lists the renamed filenames. For more information and help, contact [GitHub + Support](https://github.com/contact).\n* If you upload an asset with the + same filename as another uploaded asset, you'll receive an error and must + delete the old file before you can re-upload the new asset." + tags: + - repos + operationId: repos/upload-release-asset + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/releases/#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 + "/repos/{owner}/{repo}/stargazers": + get: + summary: List stargazers + description: |- + 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://developer.github.com/v3/media/) via the `Accept` header: + tags: + - activity + operationId: activity/list-stargazers-for-repo + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/starring/#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 + "/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://developer.github.com/v3/repos/statistics/#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 + "/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://developer.github.com/v3/repos/statistics/#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 + "/repos/{owner}/{repo}/stats/contributors": + get: + summary: Get all contributor commit activity + description: |2- + + 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 + tags: + - repos + operationId: repos/get-contributors-stats + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/statistics/#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). + * `a` - Number of additions + * `d` - Number of deletions + * `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 + "/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`. + + The 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://developer.github.com/v3/repos/statistics/#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 + "/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: + + * `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. + tags: + - repos + operationId: repos/get-punch-card-stats + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/statistics/#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 + "/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. + + 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. + tags: + - repos + operationId: repos/create-commit-status + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/statuses/#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 + "/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://developer.github.com/v3/activity/watching/#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 + "/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://developer.github.com/v3/activity/watching/#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" + '404': + description: Response if you don't subscribe to the repository + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: activity + subcategory: watching + 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://developer.github.com/v3/activity/watching/#delete-a-repository-subscription) + completely. + tags: + - activity + operationId: activity/set-repo-subscription + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/watching/#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 + 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://developer.github.com/v3/activity/watching/#set-a-repository-subscription). + tags: + - activity + operationId: activity/delete-repo-subscription + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/watching/#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 + "/repos/{owner}/{repo}/tags": + get: + summary: List repository tags + description: '' + tags: + - repos + operationId: repos/list-tags + externalDocs: + description: API method documentation + url: https://developer.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: + "/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 + `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. + tags: + - repos + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/contents/#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 + "/repos/{owner}/{repo}/teams": + get: + summary: List repository teams + description: '' + tags: + - repos + operationId: repos/list-teams + externalDocs: + description: API method documentation + url: https://developer.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: + "/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://developer.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" + '415': + "$ref": "#/components/responses/preview_header_missing" + '404': + "$ref": "#/components/responses/not_found" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.mercy-preview+json + ``` + category: repos + subcategory: + put: + summary: Replace all repository topics + description: '' + tags: + - repos + operationId: repos/replace-all-topics + externalDocs: + description: API method documentation + url: https://developer.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" + '415': + "$ref": "#/components/responses/preview_header_missing" + '404': + "$ref": "#/components/responses/not_found" + '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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.mercy-preview+json + ``` + category: repos + subcategory: + "/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://developer.github.com/v3/repos/traffic/#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 + "/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://developer.github.com/v3/repos/traffic/#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 + "/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://developer.github.com/v3/repos/traffic/#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 + "/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://developer.github.com/v3/repos/traffic/#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 + "/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://developer.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: + "/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://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.dorian-preview+json + ``` + category: repos + subcategory: + 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://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.dorian-preview+json + ``` + category: repos + subcategory: + 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://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.dorian-preview+json + ``` + category: repos + subcategory: + "/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 + `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. + tags: + - repos + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/contents/#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 + "/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://developer.github.com/v3/repos/#get-a-repository) 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 + tags: + - repos + operationId: repos/create-using-template + externalDocs: + description: API method documentation + url: https://developer.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. + 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 + 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: |- + The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://developer.github.com/v3/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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.baptiste-preview+json + ``` + category: repos + subcategory: + "/repositories": + get: + summary: List public repositories + description: |- + 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. + tags: + - repos + operationId: repos/list-public + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/#list-public-repositories + parameters: + - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/since" + - name: visibility + in: query + required: false + schema: + type: string + example: all + 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 + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: + "/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://developer.github.com/v3/enterprise-admin/scim/#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 + 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. + + 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. + operationId: enterprise-admin/provision-and-invite-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#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: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + "/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://developer.github.com/v3/enterprise-admin/scim/#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: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + 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. + + 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. + operationId: enterprise-admin/set-information-for-provisioned-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#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: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + 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. + + 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). + operationId: enterprise-admin/update-attribute-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#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: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + 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://developer.github.com/v3/enterprise-admin/scim/#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: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + "/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. + + 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. + operationId: enterprise-admin/list-provisioned-identities-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#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: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + 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. + + 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. + operationId: enterprise-admin/provision-and-invite-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#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: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + "/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://developer.github.com/v3/enterprise-admin/scim/#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: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + 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. + + 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}`. + operationId: enterprise-admin/set-information-for-provisioned-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#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: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + 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. + + 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 + } + }] + } + ``` + operationId: enterprise-admin/update-attribute-for-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#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: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + 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://developer.github.com/v3/enterprise-admin/scim/#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: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + "/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. + + 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. + tags: + - scim + operationId: scim/list-provisioned-identities + externalDocs: + description: API method documentation + url: https://developer.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: + + `?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\"`. + 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" + '404': + "$ref": "#/components/responses/scim_not_found" + '403': + "$ref": "#/components/responses/scim_forbidden" + '400': + "$ref": "#/components/responses/scim_bad_request" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + previews: [] + category: scim + subcategory: + 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://developer.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" + '404': + "$ref": "#/components/responses/scim_not_found" + '403': + "$ref": "#/components/responses/scim_forbidden" + '500': + "$ref": "#/components/responses/scim_internal_error" + '409': + "$ref": "#/components/responses/scim_conflict" + '400': + "$ref": "#/components/responses/scim_bad_request" + 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: Jane User + emails: + description: user emails + example: + - someone@example.com + - another@example.com + 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: + "/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://developer.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" + '404': + "$ref": "#/components/responses/scim_not_found" + '403': + "$ref": "#/components/responses/scim_forbidden" + '304': + "$ref": "#/components/responses/not_modified" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + previews: [] + category: scim + subcategory: + 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://developer.github.com/v3/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}`. + tags: + - scim + operationId: scim/set-information-for-provisioned-user + externalDocs: + description: API method documentation + url: https://developer.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" + '404': + "$ref": "#/components/responses/scim_not_found" + '403': + "$ref": "#/components/responses/scim_forbidden" + 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: Jane User + emails: + description: user emails + example: + - someone@example.com + - another@example.com + 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: + 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). + + **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 + } + }] + } + ``` + tags: + - scim + operationId: scim/update-attribute-for-user + externalDocs: + description: API method documentation + url: https://developer.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" + '404': + "$ref": "#/components/responses/scim_not_found" + '403': + "$ref": "#/components/responses/scim_forbidden" + '400': + "$ref": "#/components/responses/scim_bad_request" + '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: + 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://developer.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 + '404': + "$ref": "#/components/responses/scim_not_found" + '403': + "$ref": "#/components/responses/scim_forbidden" + '304': + "$ref": "#/components/responses/not_modified" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + previews: [] + category: scim + subcategory: + "/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://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). + + 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. + tags: + - search + operationId: search/code + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/search/#constructing-a-search-query). + See "[Searching code](https://help.github.com/articles/searching-code/)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query. Can only be `indexed`, which + indicates how recently a file has been indexed by the GitHub search infrastructure. + Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - indexed + - "$ref": "#/components/parameters/order" + - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: response + content: + application/json: + schema: + type: object + 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" + '503': + "$ref": "#/components/responses/service_unavailable" + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: search + subcategory: + "/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://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). + + 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` + tags: + - search + operationId: search/commits + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/search/#constructing-a-search-query). + See "[Searching commits](https://help.github.com/articles/searching-commits/)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query by `author-date` or `committer-date`. + Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - author-date + - committer-date + - "$ref": "#/components/parameters/order" + - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: response + content: + application/json: + schema: + type: object + 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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.cloak-preview + ``` + category: search + subcategory: + "/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://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). + + 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, whick means the oldest issues appear first in the search results. + tags: + - search + operationId: search/issues-and-pull-requests + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/search/#constructing-a-search-query). + See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query by the number of `comments`, + `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, + `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort + results by how recently the items were `created` or `updated`, Default: + [best match](https://developer.github.com/v3/search/#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - 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 + 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" + '503': + "$ref": "#/components/responses/service_unavailable" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: search + subcategory: + "/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://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). + + 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. + tags: + - search + operationId: search/labels + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/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://developer.github.com/v3/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 + 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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: search + subcategory: + "/search/repositories": + get: + summary: Search repositories + description: |- + 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). + + 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` + tags: + - search + operationId: search/repos + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/search/#constructing-a-search-query). + See "[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query by number of `stars`, `forks`, + or `help-wanted-issues` or how recently the items were `updated`. Default: + [best match](https://developer.github.com/v3/search/#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - 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 + 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" + '503': + "$ref": "#/components/responses/service_unavailable" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.mercy-preview+json + ``` + category: search + subcategory: + "/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://developer.github.com/v3/#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://developer.github.com/v3/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. + tags: + - search + operationId: search/topics + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/search/#constructing-a-search-query). + in: query + required: true + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: object + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.mercy-preview+json + ``` + category: search + subcategory: + "/search/users": + get: + summary: Search users + description: |- + 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). + + 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. + tags: + - search + operationId: search/users + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/search/#constructing-a-search-query). + See "[Searching users](https://help.github.com/articles/searching-users/)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query by number of `followers` or + `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - 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 + 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" + '503': + "$ref": "#/components/responses/service_unavailable" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: search + subcategory: + "/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://developer.github.com/v3/teams/#get-a-team-by-name) + endpoint." + tags: + - teams + operationId: teams/get-legacy + externalDocs: + description: API method documentation + url: https://developer.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: + deprecated: true + 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://developer.github.com/v3/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`. + tags: + - teams + operationId: teams/update-legacy + externalDocs: + description: API method documentation + url: https://developer.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" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: + deprecated: true + 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://developer.github.com/v3/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. + tags: + - teams + operationId: teams/delete-legacy + externalDocs: + description: API method documentation + url: https://developer.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: + deprecated: true + "/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://developer.github.com/v3/teams/discussions/#list-discussions) endpoint. + + List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + tags: + - teams + operationId: teams/list-discussions-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussions/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + 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://developer.github.com/v3/teams/discussions/#create-a-discussion) endpoint. + + Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + + This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + tags: + - teams + operationId: teams/create-discussion-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussions/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + "/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://developer.github.com/v3/teams/discussions/#get-a-discussion) endpoint. + + Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + tags: + - teams + operationId: teams/get-discussion-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussions/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + 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://developer.github.com/v3/teams/discussions/#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://developer.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://developer.github.com/v3/teams/discussions/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + 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://developer.github.com/v3/teams/discussions/#delete-a-discussion) endpoint. + + Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + tags: + - teams + operationId: teams/delete-discussion-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussions/#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 + "/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://developer.github.com/v3/teams/discussion_comments/#list-discussion-comments) endpoint. + + List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + tags: + - teams + operationId: teams/list-discussion-comments-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussion_comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + 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://developer.github.com/v3/teams/discussion_comments/#create-a-discussion-comment) endpoint. + + Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + + This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. + tags: + - teams + operationId: teams/create-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussion_comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + "/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://developer.github.com/v3/teams/discussion_comments/#get-a-discussion-comment) endpoint. + + Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + tags: + - teams + operationId: teams/get-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussion_comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + 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://developer.github.com/v3/teams/discussion_comments/#update-a-discussion-comment) endpoint. + + Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + tags: + - teams + operationId: teams/update-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussion_comments/#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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + 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://developer.github.com/v3/teams/discussion_comments/#delete-a-discussion-comment) endpoint. + + Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + tags: + - teams + operationId: teams/delete-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/discussion_comments/#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 + "/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://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment) endpoint. + + List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + tags: + - reactions + operationId: reactions/list-for-team-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/reactions/#reaction-types). + Omit this parameter to list all reactions to a team discussion comment. + in: query + required: false + schema: + type: string + enum: + - "+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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: + deprecated: true + 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://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment) endpoint. + + Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. + tags: + - reactions + operationId: reactions/create-for-team-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: + deprecated: true + "/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://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion) endpoint. + + List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + tags: + - reactions + operationId: reactions/list-for-team-discussion-legacy + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/reactions/#reaction-types). + Omit this parameter to list all reactions to a team discussion. + in: query + required: false + schema: + type: string + enum: + - "+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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: + deprecated: true + 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://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion) endpoint. + + Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. + tags: + - reactions + operationId: reactions/create-for-team-discussion-legacy + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: + deprecated: true + "/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://developer.github.com/v3/teams/members/#list-pending-team-invitations) endpoint. + + The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + tags: + - teams + operationId: teams/list-pending-invitations-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/members/#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 + "/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://developer.github.com/v3/teams/members/#list-team-members) endpoint. + + Team members will include the members of child teams. + tags: + - teams + operationId: teams/list-members-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/members/#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 + "/teams/{team_id}/members/{username}": + get: + summary: Get team member (Legacy) + description: |- + The "Get team member" endpoint (described below) is deprecated. + + We recommend using the [Get team membership for a user](https://developer.github.com/v3/teams/members/#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. + tags: + - teams + operationId: teams/get-member-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/members/#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 + put: + summary: Add team member (Legacy) + description: |- + The "Add team member" endpoint (described below) is deprecated. + + We recommend using the [Add or update team membership for a user](https://developer.github.com/v3/teams/members/#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://developer.github.com/v3/#http-verbs)." + tags: + - teams + operationId: teams/add-member-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/members/#add-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 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://developer.github.com/v3"' + 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 + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + delete: + summary: Remove team member (Legacy) + description: |- + The "Remove team member" endpoint (described below) is deprecated. + + We recommend using the [Remove team membership for a user](https://developer.github.com/v3/teams/members/#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/)." + tags: + - teams + operationId: teams/remove-member-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/members/#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 + "/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://developer.github.com/v3/teams/members/#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://developer.github.com/v3/teams/#create-a-team). + tags: + - teams + operationId: teams/get-membership-for-user-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/members/#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 + 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://developer.github.com/v3/teams/members/#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. + tags: + - teams + operationId: teams/add-or-update-membership-for-user-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/members/#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 + '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 + '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 + 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://developer.github.com/v3/teams/members/#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/)." + tags: + - teams + operationId: teams/remove-membership-for-user-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/members/#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 + "/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://developer.github.com/v3/teams/#list-team-projects) endpoint. + + Lists the organization projects for a team. + tags: + - teams + operationId: teams/list-projects-legacy + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: + deprecated: true + "/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://developer.github.com/v3/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. + tags: + - teams + operationId: teams/check-permissions-for-project-legacy + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: + deprecated: true + 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://developer.github.com/v3/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. + tags: + - teams + operationId: teams/add-or-update-project-permissions-legacy + externalDocs: + description: API method documentation + url: https://developer.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://developer.github.com/v3/#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://developer.github.com/v3/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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: + deprecated: true + 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://developer.github.com/v3/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. + tags: + - teams + operationId: teams/remove-project-legacy + externalDocs: + description: API method documentation + url: https://developer.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: + deprecated: true + "/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://developer.github.com/v3/teams/#list-team-repositories) + endpoint." + tags: + - teams + operationId: teams/list-repos-legacy + externalDocs: + description: API method documentation + url: https://developer.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: + deprecated: true + "/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. + + **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://developer.github.com/v3/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://developer.github.com/v3/media/) via the `Accept` header: + tags: + - teams + operationId: teams/check-permissions-for-repo-legacy + externalDocs: + description: API method documentation + url: https://developer.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: + deprecated: true + 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://developer.github.com/v3/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://developer.github.com/v3/#http-verbs)." + tags: + - teams + operationId: teams/add-or-update-repo-permissions-legacy + externalDocs: + description: API method documentation + url: https://developer.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: + deprecated: true + 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://developer.github.com/v3/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. + tags: + - teams + operationId: teams/remove-repo-legacy + externalDocs: + description: API method documentation + url: https://developer.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: + deprecated: true + "/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://developer.github.com/v3/teams/team_sync/#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. + tags: + - teams + operationId: teams/list-idp-groups-for-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/team_sync/#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 + 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://developer.github.com/v3/teams/team_sync/#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. + tags: + - teams + operationId: teams/create-or-update-idp-group-connections-legacy + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/teams/team_sync/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + previews: [] + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: team-sync + deprecated: true + "/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://developer.github.com/v3/teams/#list-child-teams) + endpoint." + tags: + - teams + operationId: teams/list-child-legacy + externalDocs: + description: API method documentation + url: https://developer.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" + '404': + "$ref": "#/components/responses/not_found" + '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: + deprecated: true + "/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. + + If 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://developer.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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: + 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://developer.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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: + "/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://developer.github.com/v3/users/blocking/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '415': + "$ref": "#/components/responses/preview_header_missing" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: blocking + "/user/blocks/{username}": + get: + summary: Check if a user is blocked by the authenticated user + description: |- + If the user is blocked: + + If the user is not blocked: + tags: + - users + operationId: users/check-blocked + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/users/blocking/#check-if-a-user-is-blocked-by-the-authenticated-user + parameters: + - "$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" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: blocking + put: + summary: Block a user + description: '' + tags: + - users + operationId: users/block + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/users/blocking/#block-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Empty response + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: blocking + delete: + summary: Unblock a user + description: '' + tags: + - users + operationId: users/unblock + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/users/blocking/#unblock-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Empty response + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: blocking + "/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://developer.github.com/v3/users/emails/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: emails + "/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://developer.github.com/v3/users/emails/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: emails + 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://developer.github.com/v3/users/emails/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: emails + 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://developer.github.com/v3/users/emails/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: emails + "/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://developer.github.com/v3/users/followers/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: followers + "/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://developer.github.com/v3/users/followers/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: followers + "/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://developer.github.com/v3/users/followers/#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 + '404': + description: Response if the person is not followed by the authenticated + user + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: followers + 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://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. + tags: + - users + operationId: users/follow + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/users/followers/#follow-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Empty response + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: followers + 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://developer.github.com/v3/users/followers/#unfollow-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Empty response + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: followers + "/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://developer.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://developer.github.com/v3/users/gpg_keys/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: gpg-keys + 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://developer.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://developer.github.com/v3/users/gpg_keys/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: gpg-keys + "/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://developer.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://developer.github.com/v3/users/gpg_keys/#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" + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: gpg-keys + 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://developer.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://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key-for-the-authenticated-user + parameters: + - "$ref": "#/components/parameters/gpg_key_id" + responses: + '204': + description: Empty response + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: gpg-keys + "/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. + + 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. + tags: + - apps + operationId: apps/list-installations-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/installations/#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 + 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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '415': + "$ref": "#/components/responses/preview_header_missing" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: apps + subcategory: installations + "/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. + + 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. + tags: + - apps + operationId: apps/list-installation-repos-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/installations/#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 + 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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '304': + "$ref": "#/components/responses/not_modified" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.mercy-preview+json + ``` + category: apps + subcategory: installations + "/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. + + 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. + tags: + - apps + operationId: apps/add-repo-to-installation + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/installations/#add-a-repository-to-an-app-installation + parameters: + - "$ref": "#/components/parameters/installation_id" + - "$ref": "#/components/parameters/repository_id" + responses: + '204': + description: Empty response + '403': + "$ref": "#/components/responses/forbidden" + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: apps + subcategory: installations + 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. + + 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. + tags: + - apps + operationId: apps/remove-repo-from-installation + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/installations/#remove-a-repository-from-an-app-installation + parameters: + - "$ref": "#/components/parameters/installation_id" + - "$ref": "#/components/parameters/repository_id" + responses: + '204': + description: Empty response + '403': + "$ref": "#/components/responses/forbidden" + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: apps + subcategory: installations + "/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. + + **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. + tags: + - issues + operationId: issues/list-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.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" + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + 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. + + To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.squirrel-girl-preview + ``` + 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. + category: issues + subcategory: + "/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://developer.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://developer.github.com/v3/users/keys/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: keys + 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://developer.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://developer.github.com/v3/users/keys/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: keys + "/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://developer.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://developer.github.com/v3/users/keys/#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" + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: keys + 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://developer.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://developer.github.com/v3/users/keys/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: keys + "/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://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/). + tags: + - apps + operationId: apps/list-subscriptions-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/marketplace/#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 + "/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://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/). + tags: + - apps + operationId: apps/list-subscriptions-for-authenticated-user-stubbed + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/apps/marketplace/#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 + "/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://developer.github.com/v3/orgs/members/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: orgs + subcategory: members + "/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://developer.github.com/v3/orgs/members/#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 + 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://developer.github.com/v3/orgs/members/#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 + "/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://developer.github.com/v3/migrations/users/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.wyandotte-preview+json + ``` + category: migrations + subcategory: users + 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://developer.github.com/v3/migrations/users/#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" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: migrations + subcategory: users + "/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: + + * `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). + tags: + - migrations + operationId: migrations/get-status-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/migrations/users/#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" + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.wyandotte-preview+json + ``` + category: migrations + subcategory: users + "/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: + + * 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. + tags: + - migrations + operationId: migrations/get-archive-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/migrations/users/#download-a-user-migration-archive + parameters: + - "$ref": "#/components/parameters/migration_id" + responses: + '302': + description: response + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.wyandotte-preview+json + ``` + category: migrations + subcategory: users + 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://developer.github.com/v3/migrations/users/#list-user-migrations) + and [Get a user migration status](https://developer.github.com/v3/migrations/users/#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://developer.github.com/v3/migrations/users/#delete-a-user-migration-archive + parameters: + - "$ref": "#/components/parameters/migration_id" + responses: + '204': + description: Empty response + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.wyandotte-preview+json + ``` + category: migrations + subcategory: users + "/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://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. + tags: + - migrations + operationId: migrations/unlock-repo-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/migrations/users/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.wyandotte-preview+json + ``` + category: migrations + subcategory: users + "/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://developer.github.com/v3/migrations/users/#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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.wyandotte-preview+json + ``` + category: migrations + subcategory: users + "/user/orgs": + get: + summary: List organizations for the authenticated user + description: |- + 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. + tags: + - orgs + operationId: orgs/list-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: orgs + subcategory: + "/user/projects": + post: + summary: Create a user project + description: '' + tags: + - projects + operationId: projects/create-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: + "/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://developer.github.com/v3/users/emails/#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://developer.github.com/v3/users/emails/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: emails + "/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. + + 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. + tags: + - repos + operationId: repos/list-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.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" + '418': + description: Response definition missing + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: repos + subcategory: + post: + summary: Create a repository for the authenticated user + description: |- + 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 + tags: + - repos + operationId: repos/create-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.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 + '401': + "$ref": "#/components/responses/requires_authentication" + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed" + '400': + "$ref": "#/components/responses/bad_request" + 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://developer.github.com/v3/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/). + + To access repository visibility during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.nebula-preview+json + ``` + - 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://developer.github.com/v3/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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.baptiste-preview+json + ``` + category: repos + subcategory: + "/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://developer.github.com/v3/repos/invitations/#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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: repos + subcategory: invitations + "/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://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation + parameters: + - "$ref": "#/components/parameters/invitation_id" + responses: + '204': + description: Empty response + '403': + "$ref": "#/components/responses/forbidden" + '409': + "$ref": "#/components/responses/conflict" + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: repos + subcategory: invitations + delete: + summary: Decline a repository invitation + description: '' + tags: + - repos + operationId: repos/decline-invitation + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation + parameters: + - "$ref": "#/components/parameters/invitation_id" + responses: + '204': + description: Empty response + '409': + "$ref": "#/components/responses/conflict" + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: repos + subcategory: invitations + "/user/starred": + get: + summary: List repositories starred by the authenticated user + description: |- + Lists repositories the authenticated user has starred. + + 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: + tags: + - activity + operationId: activity/list-repos-starred-by-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/starring/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: activity + subcategory: starring + "/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://developer.github.com/v3/activity/starring/#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 + '404': + description: Response if this repository is not starred by you + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '401': + "$ref": "#/components/responses/requires_authentication" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: activity + subcategory: starring + 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://developer.github.com/v3/#http-verbs)." + tags: + - activity + operationId: activity/star-repo-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/starring/#star-a-repository-for-the-authenticated-user + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Empty response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '401': + "$ref": "#/components/responses/requires_authentication" + '304': + "$ref": "#/components/responses/not_modified" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: activity + subcategory: starring + 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://developer.github.com/v3/activity/starring/#unstar-a-repository-for-the-authenticated-user + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Empty response + '404': + "$ref": "#/components/responses/not_found" + '401': + "$ref": "#/components/responses/requires_authentication" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: activity + subcategory: starring + "/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://developer.github.com/v3/activity/watching/#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" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: activity + subcategory: watching + "/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://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) + when authenticating via [OAuth](https://developer.github.com/apps/building-oauth-apps/). + tags: + - teams + operationId: teams/list-for-authenticated-user + externalDocs: + description: API method documentation + url: https://developer.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" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: teams + subcategory: + "/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. + + 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. + tags: + - users + operationId: users/list + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/users/#list-users + parameters: + - "$ref": "#/components/parameters/since" + - "$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: + "/users/{username}": + get: + summary: Get a user + description: |- + 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/)". + tags: + - users + operationId: users/get-by-username + externalDocs: + description: API method documentation + url: https://developer.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: + "/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://developer.github.com/v3/activity/events/#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 + "/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://developer.github.com/v3/activity/events/#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 + "/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://developer.github.com/v3/activity/events/#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 + "/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://developer.github.com/v3/users/followers/#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 + "/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://developer.github.com/v3/users/followers/#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 + "/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://developer.github.com/v3/users/followers/#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 + "/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://developer.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: + "/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://developer.github.com/v3/users/gpg_keys/#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 + "/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. + + 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 + ``` + tags: + - users + operationId: users/get-context-for-user + externalDocs: + description: API method documentation + url: https://developer.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: + "/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. + + 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. + tags: + - apps + operationId: apps/get-user-installation + externalDocs: + description: API method documentation + url: https://developer.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: + "/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://developer.github.com/v3/users/keys/#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 + "/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. + + 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://developer.github.com/v3/orgs/#list-organizations-for-the-authenticated-user) API instead. + tags: + - orgs + operationId: orgs/list-for-user + externalDocs: + description: API method documentation + url: https://developer.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: + "/users/{username}/projects": + get: + summary: List user projects + description: '' + tags: + - projects + operationId: projects/list-for-user + externalDocs: + description: API method documentation + url: https://developer.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: 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://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.inertia-preview+json + ``` + category: projects + subcategory: + "/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://developer.github.com/v3/activity/events/#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 + "/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://developer.github.com/v3/activity/events/#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 + "/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://developer.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://developer.github.com/v3/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/). + + To access repository visibility during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: + ```shell + application/vnd.github.nebula-preview+json + ``` + category: repos + subcategory: + "/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. + + 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. + operationId: billing/get-github-actions-billing-user + tags: + - billing + externalDocs: + description: API method documentation + url: https://developer.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: + "/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. + + 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. + operationId: billing/get-github-packages-billing-user + tags: + - billing + externalDocs: + description: API method documentation + url: https://developer.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: + "/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. + + 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. + operationId: billing/get-shared-storage-billing-user + tags: + - billing + externalDocs: + description: API method documentation + url: https://developer.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: + "/users/{username}/starred": + get: + summary: List repositories starred by a user + description: |- + Lists repositories a user has starred. + + 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: + tags: + - activity + operationId: activity/list-repos-starred-by-user + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/activity/starring/#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 + "/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://developer.github.com/v3/activity/watching/#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 + "/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 +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: '' + 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: '' + 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 + 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 + 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 + 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: + type: object + nullable: true + 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 + template_repository: + type: string + 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 + 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: + type: object + example: + issues: read + deployments: write + 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 + 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 + example: 1 + url: + type: string + format: uri + example: https://api.github.com/authorizations/1 + scopes: + description: A list of scopes that this authorization is in. + type: array + items: + type: string + example: + - public_repo + - user + nullable: true + token: + type: string + example: '' + token_last_eight: + type: string + example: '12345678' + nullable: true + hashed_token: + type: string + example: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + 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 + example: optional note + nullable: true + note_url: + type: string + format: uri + example: http://optional/note/url + nullable: true + 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' + fingerprint: + type: string + example: jklmnop12345678 + 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 + + ## 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 [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. + + 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/ + 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 + 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 + 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 + 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 + 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 + 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. + 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. + 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. + 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 + 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: + 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 + 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 + 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: '' + 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: '0' + 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 + *.o + + # Libraries + *.lib + *.a + + # Shared objects (inc. Windows DLLs) + *.dll + *.so + *.so.* + *.dylib + + # Executables + *.exe + *.out + *.app + 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: |2 + + + The MIT License (MIT) + + Copyright (c) [year] [fullname] + + 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. + 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: + MD5_RSA: + type: string + MD5_DSA: + type: string + 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 + github_services_sha: + type: string + example: 3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 + installed_version: + type: string + 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: + 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: + type: string + 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 + 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 + 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 + runner-groups-org: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + type: string + runners_url: + type: string + inherited: + type: boolean + 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 + 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-limit: + title: Interaction Limits + description: Interaction limit settings. + type: object + properties: + limit: + description: The interaction limit to enable. + enum: + - existing_users + - contributors_only + - collaborators_only + example: existing_users + type: string + origin: + type: string + example: repository + expires_at: + type: string + format: date-time + example: '2018-08-17T04:18:39Z' + required: + - limit + - origin + - expires_at + 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"' + 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 + type: string + enum: + - read + - write + - admin + - none + private: + description: Whether or not this project can be seen by everyone. + type: boolean + cards_url: + type: string + format: uri + permissions: + type: object + properties: + read: + type: boolean + write: + type: boolean + admin: + type: boolean + required: + - read + - write + - admin + 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: + type: string + private: + type: boolean + permissions: + type: object + properties: + read: + type: boolean + write: + type: boolean + admin: + type: boolean + 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 + 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 + template_repository: + type: string + 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 + 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 + 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 + 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 + 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 + nullable: true + format: date-time + updated_at: + type: string + nullable: true + 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 + properties: + total_ms: + type: integer + jobs: + type: integer + MACOS: + type: object + properties: + total_ms: + type: integer + jobs: + type: integer + WINDOWS: + type: object + properties: + total_ms: + type: integer + jobs: + type: integer + run_duration_ms: + type: integer + 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 + 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 + nullable: true + sha: + type: string + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + nullable: true + 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: '0' + 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: '' + 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 + 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 + nullable: true + conclusion: + type: string + example: neutral + 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 + 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/`. + code-scanning-alert-number: + type: integer + description: The code scanning alert number. + readOnly: true + nullable: false + code-scanning-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 + code-scanning-alert-url: + type: string + description: The REST API URL of the alert resource. + format: uri + readOnly: true + nullable: false + code-scanning-alert-html-url: + type: string + description: The GitHub URL of the alert resource. + format: uri + readOnly: true + nullable: false + code-scanning-alert-dismissed-by: + nullable: true + oneOf: + - "$ref": "#/components/schemas/simple-user" + - enum: + - + 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: + - + 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/code-scanning-alert-number" + created_at: + "$ref": "#/components/schemas/code-scanning-alert-created-at" + url: + "$ref": "#/components/schemas/code-scanning-alert-url" + html_url: + "$ref": "#/components/schemas/code-scanning-alert-html-url" + state: + "$ref": "#/components/schemas/code-scanning-alert-state" + dismissed_by: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-by" + 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" + 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 + 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/code-scanning-alert-number" + created_at: + "$ref": "#/components/schemas/code-scanning-alert-created-at" + url: + "$ref": "#/components/schemas/code-scanning-alert-url" + html_url: + "$ref": "#/components/schemas/code-scanning-alert-html-url" + instances: + "$ref": "#/components/schemas/code-scanning-alert-instances" + state: + "$ref": "#/components/schemas/code-scanning-alert-state" + dismissed_by: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-by" + 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" + 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" + 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: '' + 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' + 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 + protected: + type: boolean + 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" + 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 + 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 + 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 hte 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: '' + 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 + 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 + 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 + 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 + 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 + verification: + type: object + properties: + verified: + type: boolean + reason: + type: string + signature: + type: string + nullable: true + payload: + type: string + nullable: true + html_url: + type: string + format: uri + 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 + 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: Webook + 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: + type: string + example: '"http://bar.com"' + insecure_ssl: + type: string + example: '"0"' + content_type: + type: string + example: '"form"' + digest: + type: string + example: '"md5"' + secret: + type: string + example: '"********"' + 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."' + 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: + - color + - name + - id + - node_id + - default + - url + 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 + 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: '' + _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: + 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 + 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 + example: 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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: Jane User + emails: + description: user emails + example: + - someone@example.com + - another@example.com + 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: '' + 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: '0' + total_private_repos: + type: integer + example: '0' + owned_private_repos: + type: integer + example: '0' + disk_usage: + type: integer + example: '0' + collaborators: + type: integer + example: '0' + 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: + 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 + 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----- + MIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM + 9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP + X0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/ + 6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm + oNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma + szdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ + dBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva + KOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo + gDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP + kYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX + NuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd + NBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE + ZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG + J4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv + eDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3 + FI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk + 77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH + Pza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB + 1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c + 57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8 + M5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic + I9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN + 6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK + fgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG + ZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu + -----END RSA PRIVATE KEY----- + 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 + 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 + 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: + 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: + 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 + 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 + 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 + + ## 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 [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. + + 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/ + 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. + ## DETAILS: + + The (email)=(Octocat@github.com) already exists. + + The error was found in core/models.py in get_or_create_user at line 62. + + self.save() + 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 + - 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 + - id: 3 + name: expensive-hardware + visibility: private + default: false + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners + 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 + 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 + 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 + 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 + 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: + 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-3: + 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: + 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-2: + value: + url: https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks + commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits + id: aa5a315d61ae9438b18d + node_id: MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk + git_pull_url: https://gist.github.com/aa5a315d61ae9438b18d.git + git_push_url: https://gist.github.com/aa5a315d61ae9438b18d.git + html_url: https://gist.github.com/aa5a315d61ae9438b18d + 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/ + gitignore-template: + value: + name: C + source: | + # Object files + *.o + + # Libraries + *.lib + *.a + + # Shared objects (inc. Windows DLLs) + *.dll + *.so + *.so.* + *.dylib + + # Executables + *.exe + *.out + *.app + 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: + 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: + 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: + 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: + 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: + 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: |2 + + + The MIT License (MIT) + + Copyright (c) [year] [fullname] + + 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. + 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: + 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: + bullets: + - Up to 10 private repositories + - 3 concurrent builds + marketplace_purchase: + billing_cycle: monthly + next_billing_date: '2017-11-11T00:00:00Z' + unit_count: + 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: + 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: + 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: + 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: + bullets: + - Up to 10 private repositories + - 3 concurrent builds + marketplace_purchase: + billing_cycle: monthly + next_billing_date: '2017-11-11T00:00:00Z' + unit_count: + 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: + state: published + bullets: + - Up to 25 private repositories + - 11 concurrent builds + api-overview: + value: + verifiable_password_authentication: true + ssh_key_fingerprints: + MD5_RSA: 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48 + MD5_DSA: ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c + SHA256_RSA: nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8 + SHA256_DSA: br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ + hooks: + - 192.30.252.0/22 + web: + - 192.30.252.0/22 + - 185.199.108.0/22 + api: + - 192.30.252.0/22 + - 185.199.108.0/22 + git: + - 192.30.252.0/22 + pages: + - 192.30.252.153/32 + - 192.30.252.154/32 + importer: + - 54.158.161.132 + - 54.226.70.38 + 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 + 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 + thread-subscription: + value: + subscribed: true + ignored: false + reason: + 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' + 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 + - 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 + - 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 + 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 + 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 + 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: + 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: + 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 + 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: + 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: + app_slug: github-actions + interaction-limit: + value: + limit: collaborators_only + origin: organization + expires_at: '2018-08-17T04:18:39Z' + organization-invitation-items: + value: + - id: 1 + login: monalisa + email: octocat@github.com + role: direct_member + created_at: '2016-11-30T06:46:10-08:00' + inviter: + login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + team_count: 2 + invitation_team_url: https://api.github.com/organizations/2/invitations/1/teams + organization-invitation: + value: + id: 1 + login: monalisa + email: octocat@github.com + role: direct_member + created_at: '2016-11-30T06:46:10-08:00' + inviter: + login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + team_count: 2 + invitation_team_url: https://api.github.com/organizations/2/invitations/1/teams + team-items: + value: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://api.github.com/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: octocat/template + 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== + 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: + 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: + 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://api.github.com/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + 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: + 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: + 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: + 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: + 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: + 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: + 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://api.github.com/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + 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: + 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: 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: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + 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: + 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: + 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: + 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: + 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: + 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: + size: 1 + stargazers_count: 0 + watchers_count: 0 + language: + has_issues: true + has_projects: true + has_downloads: true + has_wiki: true + has_pages: false + forks_count: 0 + mirror_url: + 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: + 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: 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: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + 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: + 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: + 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: + 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: + 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 + workflow-run-paginated: + value: + total_count: 1 + workflow_runs: + - id: 30433642 + node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== + head_branch: master + head_sha: acb5820ced9479c074f688cc328bf03f341a511d + run_number: 562 + event: push + status: queued + conclusion: + 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: + 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 + node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== + head_branch: master + head_sha: acb5820ced9479c074f688cc328bf03f341a511d + run_number: 562 + event: push + status: queued + conclusion: + 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: + 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 + + New 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: + payload: + 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://api.github.com/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + dismiss_stale_reviews: true + require_code_owner_reviews: true + required_approving_review_count: 2 + restrictions: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions + users_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users + teams_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams + apps_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams + users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://api.github.com/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + 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://api.github.com/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + 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://api.github.com/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + 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: + started_at: '2018-05-04T01:14:52Z' + completed_at: + 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: octocat/template-repo + 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: + 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 + head_commit: + id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + tree_id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + message: |- + Merge pull request #6 from Spaceghost/patch-1 + + New 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: + 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: + 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: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: 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: + - 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/dsp-testing/github/hello-world/code-scanning/3 + state: open + 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: + code-scanning-alert-code-scanning-alert: + value: + number: 22 + created_at: '2020-06-19T11:21:34Z' + url: https://api.github.com/repos/github/hello-world/code-scanning/alerts/22 + html_url: https://github.com/github/hello-world/code-scanning/22 + instances: + - ref: refs/heads/codeql-analysis-yml + 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: fixed + state: fixed + 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: + code-scanning-alert-code-scanning-alert-dismissed: + value: + number: 22 + created_at: '2020-08-25T21:28:36Z' + url: https://api.github.com/repos/github/hello-world/code-scanning/alerts/22 + html_url: https://github.com/github/hello-world/code-scanning/22 + 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: + 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' + simple-commit-items: + value: + - id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + tree_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + message: Fix all the bugs + timestamp: '2016-10-10T00:00:00Z' + author: + name: Monalisa Octocat + email: mona@github.com + committer: + name: Monalisa Octocat + email: mona@github.com + - id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + tree_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + message: Fix all the bugs + timestamp: '2016-10-10T00:00:00Z' + author: + name: Monalisa Octocat + email: mona@github.com + committer: + name: Monalisa Octocat + email: mona@github.com + 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://api.github.com/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + 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: + 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: + 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: + 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: + 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: + payload: + 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 @@ + ..... + 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: + 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 + + New 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 + + ## 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 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. + + 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/ + 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: + 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' + 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: + payload: + 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: + payload: + 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: + payload: + 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: + _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: + _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: + payload: + 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: + payload: + file-commit: + value: + content: + 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: + payload: + 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: + 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 + verification: + verified: false + reason: unsigned + signature: + payload: + git-commit-2: + value: + sha: 7638417db6d59f3c431d3e1f261cc637155684cd + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + url: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd + author: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + committer: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + message: added readme, because im a good github citizen + tree: + url: https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb + sha: 691272480426f78a0138979dd3ce63b77f706feb + parents: + - url: https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5 + sha: 1acc419d4d6a9ce985db7be48c6349a0475975b5 + verification: + verified: false + reason: unsigned + signature: + payload: + 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: + payload: + 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: + status: unused + message: + 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: + status: unused + message: + 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' + 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: + 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: + 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: + 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: + 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: + 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 + IEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv + ZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0 + aGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls + ZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg + d2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh + dGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg + cHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg + Y29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z + IHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK + c3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv + dmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj + ZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50 + aWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ + UyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL + SU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ + TUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG + SVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO + R0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ + UklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF + UyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G + IENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP + VVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU + SEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K + 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: + 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: + 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://api.github.com/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + 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: + 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: + 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://api.github.com/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + 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://api.github.com/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + 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: + 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: + 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: + 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: + 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 + 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: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + - email: mona@github.com + primary: false + verified: false + visibility: + 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 + 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 + 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 + 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: + 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 + url: https://api.github.com/orgs/github + email: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + 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://api.github.com/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + 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 + 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: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + runner_group_id: + name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + org_id: + name: org_id + description: Unique identifier of an organization. + 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 + 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 + 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://developer.github.com/v3/checks/runs/#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 code scanning alert number. + required: true + schema: + "$ref": "#/components/schemas/code-scanning-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 + 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 + 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 \ No newline at end of file