openapi-directory/api/github.com/api.github.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.3","servers":[{"url":"https://api.github.com"}],"info":{"contact":{"name":"Support","url":"https://support.github.com/contact?tags=dotcom-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","title":"GitHub v3 REST API","version":"1.1.4","x-apisguru-categories":["collaboration","developer_tools"],"x-github-plan":"api.github.com","x-logo":{"url":"https://twitter.com/github/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json","version":"3.0"}],"x-providerName":"github.com","x-serviceName":"api.github.com"},"externalDocs":{"description":"GitHub v3 REST API","url":"https://docs.github.com/rest/"},"tags":[{"description":"Endpoints to manage GitHub Actions using the REST API.","name":"actions"},{"description":"Activity APIs provide access to notifications, subscriptions, and timelines.","name":"activity"},{"description":"Information for integrations and installations.","name":"apps"},{"description":"Monitor charges and usage from Actions and Packages.","name":"billing"},{"description":"Rich interactions with checks run by your integrations.","name":"checks"},{"description":"Retrieve code scanning alerts from a repository.","name":"code-scanning"},{"description":"Insight into codes of conduct for your communities.","name":"codes-of-conduct"},{"description":"Endpoints to manage Codespaces using the REST API.","name":"codespaces"},{"description":"List emojis available to use on GitHub.","name":"emojis"},{"description":"Endpoints to manage Dependabot.","name":"dependabot"},{"description":"Endpoints to access Dependency Graph features.","name":"dependency-graph"},{"description":"View, modify your gists.","name":"gists"},{"description":"Raw Git functionality.","name":"git"},{"description":"View gitignore templates","name":"gitignore"},{"description":"Owner or admin management of users interactions.","name":"interactions"},{"description":"Interact with GitHub Issues.","name":"issues"},{"description":"View various OSS licenses.","name":"licenses"},{"description":"Render GitHub flavored markdown","name":"markdown"},{"description":"Interact with GitHub Merge Queues.","name":"merge-queue"},{"description":"Endpoints that give information about the API.","name":"meta"},{"description":"Move projects to or from GitHub.","name":"migrations"},{"description":"Endpoints to manage GitHub OIDC configuration using the REST API.","name":"oidc"},{"description":"Interact with GitHub Orgs.","name":"orgs"},{"description":"Manage packages for authenticated users and organizations.","name":"packages"},{"description":"Interact with GitHub Projects.","name":"projects"},{"description":"Interact with GitHub Pull Requests.","name":"pulls"},{"description":"Check your current rate limit status","name":"rate-limit"},{"description":"Interact with reactions to various GitHub entities.","name":"reactions"},{"description":"Interact with GitHub Repos.","name":"repos"},{"description":"Look for stuff on GitHub.","name":"search"},{"description":"Retrieve secret scanning alerts from a repository.","name":"secret-scanning"},{"description":"Interact with GitHub Teams.","name":"teams"},{"description":"Interact with and view information about users and also current user.","name":"users"}],"paths":{"/":{"get":{"description":"Get Hypermedia links to resources accessible in GitHub's REST API","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/overview/resources-in-the-rest-api#root-endpoint"},"operationId":"meta/root","responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/root"}},"schema":{"$ref":"#/components/schemas/root"}}},"description":"Response"}},"summary":"GitHub API Root","tags":["meta"],"x-github":{"category":"meta","enabledForGitHubApps":true,"githubCloudOnly":false}}},"/app":{"get":{"description":"Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#get-the-authenticated-app"},"operationId":"apps/get-authenticated","parameters":[],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/integration"}},"schema":{"$ref":"#/components/schemas/integration"}}},"description":"Response"}},"summary":"Get the authenticated app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":null}}},"/app-manifests/{code}/conversions":{"post":{"description":"Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#create-a-github-app-from-a-manifest"},"operationId":"apps/create-from-manifest","parameters":[{"in":"path","name":"code","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/integration-from-manifest"}},"schema":{"allOf":[{"$ref":"#/components/schemas/integration"},{"additionalProperties":true,"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"pem":{"type":"string"},"webhook_secret":{"nullable":true,"type":"string"}},"required":["client_id","client_secret","webhook_secret","pem"],"type":"object"}]}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}},"summary":"Create a GitHub App from a manifest","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}}},"/app/hook/config":{"get":{"description":"Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#get-a-webhook-configuration-for-an-app"},"operationId":"apps/get-webhook-config-for-app","responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/webhook-config"}},"schema":{"$ref":"#/components/schemas/webhook-config"}}},"description":"Response"}},"summary":"Get a webhook configuration for an app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"webhooks"}},"patch":{"description":"Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#update-a-webhook-configuration-for-an-app"},"operationId":"apps/update-webhook-config-for-app","requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"content_type":"json","insecure_ssl":"0","secret":"********","url":"https://example.com/webhook"}}},"schema":{"properties":{"content_type":{"$ref":"#/components/schemas/webhook-config-content-type"},"insecure_ssl":{"$ref":"#/components/schemas/webhook-config-insecure-ssl"},"secret":{"$ref":"#/components/schemas/webhook-config-secret"},"url":{"$ref":"#/components/schemas/webhook-config-url"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/webhook-config"}},"schema":{"$ref":"#/components/schemas/webhook-config"}}},"description":"Response"}},"summary":"Update a webhook configuration for an app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"webhooks"}}},"/app/hook/deliveries":{"get":{"description":"Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#list-deliveries-for-an-app-webhook"},"operationId":"apps/list-webhook-deliveries","parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/cursor"},{"in":"query","name":"redelivery","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/hook-delivery-items"}},"schema":{"items":{"$ref":"#/components/schemas/hook-delivery-item"},"type":"array"}}},"description":"Response"},"400":{"$ref":"#/components/responses/bad_request"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"List deliveries for an app webhook","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"webhooks"}}},"/app/hook/deliveries/{delivery_id}":{"get":{"description":"Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#get-a-delivery-for-an-app-webhook"},"operationId":"apps/get-webhook-delivery","parameters":[{"$ref":"#/components/parameters/delivery-id"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/hook-delivery"}},"schema":{"$ref":"#/components/schemas/hook-delivery"}}},"description":"Response"},"400":{"$ref":"#/components/responses/bad_request"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Get a delivery for an app webhook","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"webhooks"}}},"/app/hook/deliveries/{delivery_id}/attempts":{"post":{"description":"Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook"},"operationId":"apps/redeliver-webhook-delivery","parameters":[{"$ref":"#/components/parameters/delivery-id"}],"responses":{"202":{"$ref":"#/components/responses/accepted"},"400":{"$ref":"#/components/responses/bad_request"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Redeliver a delivery for an app webhook","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"webhooks"}}},"/app/installations":{"get":{"description":"You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app"},"operationId":"apps/list-installations","parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/since"},{"in":"query","name":"outdated","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-installation-items"}},"schema":{"items":{"$ref":"#/components/schemas/installation"},"type":"array"}}},"description":"The permissions the installation has are included under the `permissions` key.","headers":{"Link":{"$ref":"#/components/headers/link"}}}},"summary":"List installations for the authenticated app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":null}}},"/app/installations/{installation_id}":{"delete":{"description":"Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#delete-an-installation-for-the-authenticated-app"},"operationId":"apps/delete-installation","parameters":[{"$ref":"#/components/parameters/installation-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Delete an installation for the authenticated app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}},"get":{"description":"Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#get-an-installation-for-the-authenticated-app"},"operationId":"apps/get-installation","parameters":[{"$ref":"#/components/parameters/installation-id"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-installation"}},"schema":{"$ref":"#/components/schemas/installation"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Get an installation for the authenticated app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":null}}},"/app/installations/{installation_id}/access_tokens":{"post":{"description":"Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps/#create-an-installation-access-token-for-an-app"},"operationId":"apps/create-installation-access-token","parameters":[{"$ref":"#/components/parameters/installation-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"permissions":{"contents":"read","issues":"write"},"repository":"Hello-World"}}},"schema":{"properties":{"permissions":{"$ref":"#/components/schemas/app-permissions"},"repositories":{"description":"List of repository names that the token should have access to","items":{"example":"rails","type":"string"},"type":"array"},"repository_ids":{"description":"List of repository IDs that the token should have access to","example":[1],"items":{"type":"integer"},"type":"array"}},"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/installation-token"}},"schema":{"$ref":"#/components/schemas/installation-token"}}},"description":"Response"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Create an installation access token for an app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":null}}},"/app/installations/{installation_id}/suspended":{"delete":{"description":"Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#unsuspend-an-app-installation"},"operationId":"apps/unsuspend-installation","parameters":[{"$ref":"#/components/parameters/installation-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Unsuspend an app installation","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}},"put":{"description":"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.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#suspend-an-app-installation"},"operationId":"apps/suspend-installation","parameters":[{"$ref":"#/components/parameters/installation-id"}],"responses":{"204":{"description":"Response"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Suspend an app installation","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}}},"/applications/{client_id}/grant":{"delete":{"description":"OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#delete-an-app-authorization"},"operationId":"apps/delete-authorization","parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a"}}},"schema":{"properties":{"access_token":{"description":"The OAuth access token used to authenticate to the GitHub API.","type":"string"}},"required":["access_token"],"type":"object"}}},"required":true},"responses":{"204":{"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Delete an app authorization","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"oauth-applications"}}},"/applications/{client_id}/token":{"delete":{"description":"OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#delete-an-app-token"},"operationId":"apps/delete-token","parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a"}}},"schema":{"properties":{"access_token":{"description":"The OAuth access token used to authenticate to the GitHub API.","type":"string"}},"required":["access_token"],"type":"object"}}},"required":true},"responses":{"204":{"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Delete an app token","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"oauth-applications"}},"patch":{"description":"OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#reset-a-token"},"operationId":"apps/reset-token","parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a"}}},"schema":{"properties":{"access_token":{"description":"The access_token of the OAuth application.","type":"string"}},"required":["access_token"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization-with-user"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Reset a token","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"oauth-applications"}},"post":{"description":"OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps#check-a-token"},"operationId":"apps/check-token","parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a"}}},"schema":{"properties":{"access_token":{"description":"The access_token of the OAuth application.","type":"string"}},"required":["access_token"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/authorization-with-user"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Check a token","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"oauth-applications"}}},"/applications/{client_id}/token/scoped":{"post":{"description":"Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/apps/apps#create-a-scoped-access-token"},"operationId":"apps/scope-token","parameters":[{"$ref":"#/components/parameters/client-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a","permissions":{"contents":"read","issues":"write","metadata":"read"},"target":"octocat"}}},"schema":{"properties":{"access_token":{"description":"The access token used to authenticate to the GitHub API.","example":"e72e16c7e42f292c6912e7710c838347ae178b4a","type":"string"},"permissions":{"$ref":"#/components/schemas/app-permissions"},"repositories":{"description":"The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.","items":{"example":"rails","type":"string"},"type":"array"},"repository_ids":{"description":"The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.","example":[1],"items":{"type":"integer"},"type":"array"},"target":{"description":"The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.","example":"octocat","type":"string"},"target_id":{"description":"The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.","example":1,"type":"integer"}},"required":["access_token"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/scope-token"}},"schema":{"$ref":"#/components/schemas/authorization"}}},"description":"Response"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Create a scoped access token","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"apps"}}},"/apps/{app_slug}":{"get":{"description":"**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/apps/#get-an-app"},"operationId":"apps/get-by-slug","parameters":[{"$ref":"#/components/parameters/app-slug"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/integration"}},"schema":{"$ref":"#/components/schemas/integration"}}},"description":"Response"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Get an app","tags":["apps"],"x-github":{"category":"apps","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":null}}},"/codes_of_conduct":{"get":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/codes-of-conduct#get-all-codes-of-conduct"},"operationId":"codes-of-conduct/get-all-codes-of-conduct","parameters":[],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/code-of-conduct-simple-items"}},"schema":{"items":{"$ref":"#/components/schemas/code-of-conduct"},"type":"array"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"}},"summary":"Get all codes of conduct","tags":["codes-of-conduct"],"x-github":{"category":"codes-of-conduct","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":null}}},"/codes_of_conduct/{key}":{"get":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/codes-of-conduct#get-a-code-of-conduct"},"operationId":"codes-of-conduct/get-conduct-code","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/code-of-conduct"}},"schema":{"$ref":"#/components/schemas/code-of-conduct"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Get a code of conduct","tags":["codes-of-conduct"],"x-github":{"category":"codes-of-conduct","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":null}}},"/emojis":{"get":{"description":"Lists all the emojis available to use on GitHub.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/emojis#get-emojis"},"operationId":"emojis/get","parameters":[],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/emojis-get"}},"schema":{"additionalProperties":{"type":"string"},"type":"object"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"}},"summary":"Get emojis","tags":["emojis"],"x-github":{"category":"emojis","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":null}}},"/enterprises/{enterprise}/dependabot/alerts":{"get":{"description":"Lists Dependabot alerts for repositories that are owned by the specified enterprise.\nTo use this endpoint, you must be a member of the enterprise, and you must use an\naccess token with the `repo` scope or `security_events` scope.\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise"},"operationId":"dependabot/list-alerts-for-enterprise","parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-states"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-severities"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-ecosystems"},{"$ref":"#/components/parameters/dependabot-alert-comma-separated-packages"},{"$ref":"#/components/parameters/dependabot-alert-scope"},{"$ref":"#/components/parameters/dependabot-alert-sort"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/pagination-before"},{"$ref":"#/components/parameters/pagination-after"},{"$ref":"#/components/parameters/pagination-first"},{"$ref":"#/components/parameters/pagination-last"},{"$ref":"#/components/parameters/per-page"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/dependabot-alerts-for-organization"}},"schema":{"items":{"$ref":"#/components/schemas/dependabot-alert-with-repository"},"type":"array"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed_simple"}},"summary":"List Dependabot alerts for an enterprise","tags":["dependabot"],"x-github":{"category":"dependabot","enabledForGitHubApps":false,"githubCloudOnly":false,"previews":[],"subcategory":"alerts"}}},"/enterprises/{enterprise}/secret-scanning/alerts":{"get":{"description":"Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-enterprise"},"operationId":"secret-scanning/list-alerts-for-enterprise","parameters":[{"$ref":"#/components/parameters/enterprise"},{"$ref":"#/components/parameters/secret-scanning-alert-state"},{"$ref":"#/components/parameters/secret-scanning-alert-secret-type"},{"$ref":"#/components/parameters/secret-scanning-alert-resolution"},{"$ref":"#/components/parameters/secret-scanning-alert-sort"},{"$ref":"#/components/parameters/direction"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/pagination-before"},{"$ref":"#/components/parameters/pagination-after"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/organization-secret-scanning-alert-list"}},"schema":{"items":{"$ref":"#/components/schemas/organization-secret-scanning-alert"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"404":{"$ref":"#/components/responses/not_found"},"503":{"$ref":"#/components/responses/service_unavailable"}},"summary":"List secret scanning alerts for an enterprise","tags":["secret-scanning"],"x-github":{"category":"secret-scanning","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}}},"/events":{"get":{"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.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/activity#list-public-events"},"operationId":"activity/list-public-events","parameters":[{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/public-events-items"}},"schema":{"items":{"$ref":"#/components/schemas/event"},"type":"array"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"503":{"$ref":"#/components/responses/service_unavailable"}},"summary":"List public events","tags":["activity"],"x-github":{"category":"activity","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":"events"}}},"/feeds":{"get":{"description":"GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n*   **Timeline**: The GitHub global public timeline\n*   **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)\n*   **Current user public**: The public timeline for the authenticated user\n*   **Current user**: The private timeline for the authenticated user\n*   **Current user actor**: The private timeline for activity created by the authenticated user\n*   **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n*   **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/activity#get-feeds"},"operationId":"activity/get-feeds","parameters":[],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/feed"}},"schema":{"$ref":"#/components/schemas/feed"}}},"description":"Response"}},"summary":"Get feeds","tags":["activity"],"x-github":{"category":"activity","enabledForGitHubApps":true,"githubCloudOnly":false,"subcategory":"feeds"}}},"/gists":{"get":{"description":"Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/gists#list-gists-for-the-authenticated-user"},"operationId":"gists/list","parameters":[{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-gist-items"}},"schema":{"items":{"$ref":"#/components/schemas/base-gist"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"}},"summary":"List gists for the authenticated user","tags":["gists"],"x-github":{"category":"gists","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}},"post":{"description":"Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/gists#create-a-gist"},"operationId":"gists/create","parameters":[],"requestBody":{"content":{"application/json":{"examples":{"default":{"summary":"Creating a gist","value":{"description":"Example of a gist","files":{"README.md":{"content":"Hello World"}},"public":false}}},"schema":{"properties":{"description":{"description":"Description of the gist","example":"Example Ruby script","type":"string"},"files":{"additionalProperties":{"properties":{"content":{"description":"Content of the file","readOnly":false,"type":"string"}},"required":["content"],"type":"object"},"description":"Names and content for the files that make up the gist","example":{"hello.rb":{"content":"puts \"Hello, World!\""}},"type":"object"},"public":{"oneOf":[{"default":false,"description":"Flag indicating whether the gist is public","example":true,"type":"boolean"},{"default":"false","enum":["true","false"],"example":"true","type":"string"}]}},"required":["files"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist"}},"schema":{"$ref":"#/components/schemas/gist-simple"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/gists/aa5a315d61ae9438b18d","schema":{"type":"string"}}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Create a gist","tags":["gists"],"x-github":{"category":"gists","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}}},"/gists/public":{"get":{"description":"List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/gists#list-public-gists"},"operationId":"gists/list-public","parameters":[{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-gist-items"}},"schema":{"items":{"$ref":"#/components/schemas/base-gist"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"List public gists","tags":["gists"],"x-github":{"category":"gists","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}}},"/gists/starred":{"get":{"description":"List the authenticated user's starred gists:","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/gists#list-starred-gists"},"operationId":"gists/list-starred","parameters":[{"$ref":"#/components/parameters/since"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/base-gist-items"}},"schema":{"items":{"$ref":"#/components/schemas/base-gist"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"401":{"$ref":"#/components/responses/requires_authentication"},"403":{"$ref":"#/components/responses/forbidden"}},"summary":"List starred gists","tags":["gists"],"x-github":{"category":"gists","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}}},"/gists/{gist_id}":{"delete":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/gists#delete-a-gist"},"operationId":"gists/delete","parameters":[{"$ref":"#/components/parameters/gist-id"}],"responses":{"204":{"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Delete a gist","tags":["gists"],"x-github":{"category":"gists","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}},"get":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/gists#get-a-gist"},"operationId":"gists/get","parameters":[{"$ref":"#/components/parameters/gist-id"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist"}},"schema":{"$ref":"#/components/schemas/gist-simple"}}},"description":"Response"},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden_gist"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"Get a gist","tags":["gists"],"x-github":{"category":"gists","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}},"patch":{"description":"Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/gists/#update-a-gist"},"operationId":"gists/update","parameters":[{"$ref":"#/components/parameters/gist-id"}],"requestBody":{"content":{"application/json":{"examples":{"deleteFile":{"summary":"Deleting a gist file","value":{"files":{"hello.py":null}}},"renameFile":{"summary":"Renaming a gist file","value":{"files":{"hello.py":{"filename":"goodbye.py"}}}},"updateGist":{"summary":"Updating a gist","value":{"description":"An updated gist description","files":{"README.md":{"content":"Hello World from GitHub"}}}}},"schema":{"anyOf":[{"required":["description"]},{"required":["files"]}],"nullable":true,"properties":{"description":{"description":"The description of the gist.","example":"Example Ruby script","type":"string"},"files":{"additionalProperties":{"anyOf":[{"required":["content"]},{"required":["filename"]},{"maxProperties":0,"type":"object"}],"nullable":true,"properties":{"content":{"description":"The new content of the file.","type":"string"},"filename":{"description":"The new filename for the file.","nullable":true,"type":"string"}},"type":"object"},"description":"The gist files to be updated, renamed, or deleted. Each `key` must match the current filename\n(including extension) of the targeted gist file. For example: `hello.py`.\n\nTo delete a file, set the whole file to null. For example: `hello.py : null`.","example":{"hello.rb":{"content":"blah","filename":"goodbye.rb"}},"type":"object"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"deleteFile":{"$ref":"#/components/examples/delete-gist-file"},"renameFile":{"$ref":"#/components/examples/rename-gist-file"},"updateGist":{"$ref":"#/components/examples/gist"}},"schema":{"$ref":"#/components/schemas/gist-simple"}}},"description":"Response"},"404":{"$ref":"#/components/responses/not_found"},"422":{"$ref":"#/components/responses/validation_failed"}},"summary":"Update a gist","tags":["gists"],"x-github":{"category":"gists","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":null}}},"/gists/{gist_id}/comments":{"get":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/gists#list-gist-comments"},"operationId":"gists/list-comments","parameters":[{"$ref":"#/components/parameters/gist-id"},{"$ref":"#/components/parameters/per-page"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist-comment-items"}},"schema":{"items":{"$ref":"#/components/schemas/gist-comment"},"type":"array"}}},"description":"Response","headers":{"Link":{"$ref":"#/components/headers/link"}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/not_found"}},"summary":"List gist comments","tags":["gists"],"x-github":{"category":"gists","enabledForGitHubApps":false,"githubCloudOnly":false,"subcategory":"comments"}},"post":{"description":"","externalDocs":{"description":"API method documentation","url":"https://docs.github.com/rest/reference/gists#create-a-gist-comment"},"operationId":"gists/create-comment","parameters":[{"$ref":"#/components/parameters/gist-id"}],"requestBody":{"content":{"application/json":{"examples":{"default":{"summary":"Creating a comment in a gist","value":{"body":"This is a comment to a gist"}}},"schema":{"properties":{"body":{"description":"The comment text.","example":"Body of the attachment","maxLength":65535,"type":"string"}},"required":["body"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"default":{"$ref":"#/components/examples/gist-comment"}},"schema":{"$ref":"#/components/schemas/gist-comment"}}},"description":"Response","headers":{"Location":{"example":"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1","schema":{"type":"string"}}}},"304":{"$ref":"#/components/responses/not_modified"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/component